lily/constrained-breaking.cc

   1 /*
   2   constrained-breaking.cc -- implement a line breaker that
   3   support limits on the number of systems
   4
   5   source file of the GNU LilyPond music typesetter
   6
   7   (c) 2006 Joe Neeman <joeneeman@gmail.com>
   8 */
   9
  10 #include "constrained-breaking.hh"
  11
  12 #include "international.hh"
  13 #include "main.hh"
  14 #include "output-def.hh"
  15 #include "paper-column.hh"
  16 #include "paper-score.hh"
  17 #include "simple-spacer.hh"
  18 #include "system.hh"
  19 #include "warn.hh"
  20
  21 /*
  22   We use the following optimal substructure. Let W(A) be our weight function.
  23
  24   Let A_{k,n} = (a_{k,n,1}, ... a_{k,n,k}) be the optimal set of line breaks
  25   for k systems and n potential breakpoints. a_{k,n,k} = n (it is the end of
  26   the piece)
  27
  28   Then A_{k+1, m} is contructed from
  29   min_ {k < j < m} ( W(A_{k,j} :: m) )
  30   where by A::m we denote appending m to the list A
  31
  32   Indices in the code:
  33
  34   The above algorithm makes it easy to end at a point before the end of the
  35   score (just find A_{k,m} for some m < breaks_.size () - 1). However, we must
  36   add information for starting at a point after the beginning. One constructor
  37   allows the specification of a list of starting columns, start_. We then have
  38   start_.size () different solution arrays. state_[i] is the array for the
  39   solution starting at column number start_[i].
  40
  41   The indices "start" and "end" refer to the index in the start_ array of the
  42   desired starting and ending columns.
  43
  44   each solution array looks like
  45    a_{1,1,1} a_{2,1,2} a_{3,1,3} . . .
  46        X     a_{2,2,2} a_{3,2,3} . . .
  47        X         X     a_{3,3,3} . . .
  48        .         .         .     .
  49        .         .         .       .
  50   where the X's mark invalid solutions (can't have more systems than
  51   breakpoints). Note that each value is of the form a_{x,n,x}. This is because
  52   a breakpoint of the form a_{x,n,x-1} will also be called a_{x-1,m,x-1} for
  53   some m < n. Each cell in the array stores the value of its m (ie. the
  54   ending breakpoint of the previous line) as "prev_".
  55
  56   For finding A_{sys, brk}, let "me" be the (sys_count,brk) cell in our
  57   solution array (state_[start][sys * rank + brk]).
  58
  59   Then A_{sys, brk} = A_{sys - 1, me.prev_} :: me
  60 */
  61
  62 /*
  63   start and sys here are indexed from 0.
  64   brk is indexed from starting_breakpoints_[start]
  65   (for brk, starting_breakpoints_[start] is the beginning
  66   of the piece; the smallest value we should ever see here is
  67   starting_breakpoints_[start] + 1) */
  68 bool
  69 Constrained_breaking::calc_subproblem (vsize start, vsize sys, vsize brk)
  70 {
  71   assert (sys < systems_);
  72   assert (start < start_.size ());
  73   assert (brk < breaks_.size ());
  74
  75   bool found_something = false;
  76   vsize start_col = starting_breakpoints_[start];
  77   Matrix<Constrained_break_node> &st = state_[start];
  78   vsize max_index = brk - start_col;
  79   for (vsize j=sys; j < max_index; j++)
  80     {
  81       if (0 == sys && j > 0)
  82         break; /* the first line cannot have its first break after the beginning */
  83
  84       Line_details const &cur = lines_.at (brk, j + start_col);
  85       Real prev_f = 0;
  86       Real prev_dem = 0;
  87
  88       if (sys > 0)
  89         {
  90           prev_f = st.at (j, sys-1).details_.force_;
  91           prev_dem = st.at (j, sys-1).demerits_;
  92         }
  93       if (isinf (prev_dem))
  94         break;
  95
  96       Real dem = combine_demerits (cur.force_, prev_f) + prev_dem + cur.break_penalty_;
  97       if (isinf (dem))
  98         continue;
  99
 100       Constrained_break_node &n = st.at (max_index, sys);
 101       if (isinf (n.demerits_) || dem < n.demerits_)
 102         {
 103           found_something = true;
 104           n.demerits_ = dem;
 105           n.details_ = cur;
 106           n.prev_ = j;
 107         }
 108     }
 109   return found_something;
 110 }
 111
 112 vector<Column_x_positions>
 113 Constrained_breaking::solve ()
 114 {
 115   if (!systems_)
 116     return get_best_solution (0, VPOS);
 117
 118   resize (systems_);
 119   return get_solution(0, VPOS, systems_);
 120 }
 121
 122 Column_x_positions
 123 Constrained_breaking::space_line (vsize i, vsize j)
 124 {
 125   bool ragged_right = to_boolean (pscore_->layout ()->c_variable ("ragged-right"));
 126   bool ragged_last = to_boolean (pscore_->layout ()->c_variable ("ragged-last"));
 127   Column_x_positions col;
 128
 129   vector<Grob*> line (all_.begin () + breaks_[i],
 130                       all_.begin() + breaks_[j] + 1);
 131   Interval line_dims = line_dimensions_int (pscore_->layout (), i);
 132   bool last = j == breaks_.size () - 1;
 133   bool ragged = ragged_right || (last && ragged_last);
 134
 135   return get_line_configuration (line, line_dims[RIGHT] - line_dims[LEFT], line_dims[LEFT], ragged);
 136 }
 137
 138 void
 139 Constrained_breaking::resize (vsize systems)
 140 {
 141   systems_ = systems;
 142
 143   if (!breaks_.size () && pscore_)
 144     {
 145       Output_def *l = pscore_->layout ();
 146       System *sys = pscore_->root_system ();
 147       Real padding = robust_scm2double (l->c_variable ("between-system-padding"), 0);
 148       Real space = robust_scm2double (l->c_variable ("ideal-system-space"), 0);
 149       bool ragged_right = to_boolean (pscore_->layout ()->c_variable ("ragged-right"));
 150       bool ragged_last = to_boolean (pscore_->layout ()->c_variable ("ragged-last"));
 151
 152       Interval first_line = line_dimensions_int (pscore_->layout (), 0);
 153       Interval other_lines = line_dimensions_int (pscore_->layout (), 1);
 154       /* do all the rod/spring problems */
 155       breaks_ = pscore_->find_break_indices ();
 156       all_ = pscore_->root_system ()->columns ();
 157       lines_.resize (breaks_.size (), breaks_.size (), Line_details ());
 158       vector<Real> forces = get_line_forces (all_,
 159                                              other_lines.length (),
 160                                              other_lines.length () - first_line.length (),
 161                                              ragged_right);
 162       for (vsize i = 0; i < breaks_.size () - 1; i++)
 163         {
 164           Real max_ext = 0;
 165           for (vsize j = i + 1; j < breaks_.size (); j++)
 166             {
 167               int start = Paper_column::get_rank (all_[breaks_[i]]);
 168               int end = Paper_column::get_rank (all_[breaks_[j]]);
 169               Interval extent = sys->pure_height (sys, start, end);
 170               bool last = j == breaks_.size () - 1;
 171               bool ragged = ragged_right || (last && ragged_last);
 172               Line_details &line = lines_.at (j, i);
 173
 174               line.force_ = forces[i*breaks_.size () + j];
 175               if (ragged && last && !isinf (line.force_))
 176                 line.force_ = 0;
 177               if (isinf (line.force_))
 178                 break;
 179
 180               Grob *c = all_[breaks_[j]];
 181               line.break_penalty_ = robust_scm2double (c->get_property ("line-break-penalty"), 0);
 182               line.page_penalty_ = robust_scm2double (c->get_property ("page-break-penalty"), 0);
 183               line.turn_penalty_ = robust_scm2double (c->get_property ("page-turn-penalty"), 0);
 184               line.break_permission_ = c->get_property ("line-break-permission");
 185               line.page_permission_ = c->get_property ("page-break-permission");
 186               line.turn_permission_ = c->get_property ("page-turn-permission");
 187
 188               max_ext = max (max_ext, extent.length ());
 189               line.extent_ = extent;
 190               line.padding_ = padding;
 191               line.space_ = space;
 192               line.inverse_hooke_ = 1;
 193             }
 194         }
 195
 196       /* work out all the starting indices */
 197       for (vsize i = 0; i < start_.size (); i++)
 198         {
 199           vsize j;
 200           for (j = 0; j < breaks_.size () - 1 && breaks_[j] < start_[i]; j++)
 201             ;
 202           starting_breakpoints_.push_back (j);
 203           start_[i] = breaks_[j];
 204         }
 205       state_.resize (start_.size ());
 206     }
 207
 208   if (pscore_ && systems_ > valid_systems_)
 209     {
 210       for (vsize i = 0; i < state_.size (); i++)
 211         state_[i].resize (breaks_.size () - starting_breakpoints_[i], systems_, Constrained_break_node ());
 212
 213       /* fill out the matrices */
 214       for (vsize i = 0; i < state_.size (); i++)
 215         for (vsize j = valid_systems_; j < systems_; j++)
 216           for (vsize k = starting_breakpoints_[i] + j + 1; k < breaks_.size (); k++)
 217             if (!calc_subproblem (i, j, k))
 218               break; /* if we couldn't break this, it is too cramped already */
 219       valid_systems_ = systems_;
 220     }
 221 }
 222
 223 vector<Column_x_positions>
 224 Constrained_breaking::get_solution (vsize start, vsize end, vsize sys_count)
 225 {
 226   vsize start_brk = starting_breakpoints_[start];
 227   vsize end_brk = prepare_solution (start, end, sys_count);
 228
 229   Matrix<Constrained_break_node> const &st = state_[start];
 230   vector<Column_x_positions> ret;
 231
 232   /* find the first solution that satisfies constraints */
 233   for (vsize sys = sys_count-1; sys != VPOS; sys--)
 234     {
 235       for (vsize brk = end_brk; brk != VPOS; brk--)
 236         {
 237           if (!isinf (st.at (brk, sys).details_.force_))
 238             {
 239               if (brk != end_brk)
 240                 {
 241                   warning ( _("couldn't find line breaking that satisfies constraints" ));
 242                   ret.push_back (space_line (brk, end_brk));
 243                 }
 244               /* build up the good solution */
 245               for (vsize cur_sys = sys; cur_sys != VPOS; cur_sys--)
 246                 {
 247                   vsize prev_brk = st.at (brk, cur_sys).prev_;
 248                   assert (brk != VPOS);
 249                   ret.push_back (space_line (prev_brk + start_brk, brk + start_brk));
 250                   brk = prev_brk;
 251                 }
 252               reverse (ret);
 253               return ret;
 254             }
 255         }
 256     }
 257   /* if we get to here, just put everything on one line */
 258   warning ( _("couldn't find line breaking that satisfies constraints" ));
 259   ret.push_back (space_line (0, end_brk));
 260   return ret;
 261 }
 262
 263 vector<Column_x_positions>
 264 Constrained_breaking::get_best_solution (vsize start, vsize end)
 265 {
 266   vsize min_systems =  get_min_systems (start, end);
 267   vsize max_systems = get_max_systems (start, end);
 268   Real best_demerits = infinity_f;
 269   vector<Column_x_positions> best_so_far;
 270
 271   for (vsize i = min_systems; i <= max_systems; i++)
 272     {
 273       vsize brk = prepare_solution (start, end, i);
 274       Real dem = state_[start].at (brk, i-1).demerits_;
 275
 276       if (dem < best_demerits)
 277         {
 278           best_demerits = dem;
 279           best_so_far = get_solution (start, end, i);
 280         }
 281       else
 282         {
 283           vector<Column_x_positions> cur = get_solution (start, end, i);
 284           bool too_many_lines = true;
 285
 286           for (vsize j = 0; j < cur.size (); j++)
 287             if (cur[j].force_ < 0)
 288               {
 289                 too_many_lines = false;
 290                 break;
 291               }
 292           if (too_many_lines)
 293             return best_so_far;
 294         }
 295     }
 296   if (best_so_far.size ())
 297     return best_so_far;
 298   return get_solution (start, end, max_systems);
 299 }
 300
 301 std::vector<Line_details>
 302 Constrained_breaking::get_details (vsize start, vsize end, vsize sys_count)
 303 {
 304   vsize brk = prepare_solution (start, end, sys_count);
 305   Matrix<Constrained_break_node> const &st = state_[start];
 306   vector<Line_details> ret;
 307
 308   for (int sys = sys_count-1; sys >= 0 && brk != VPOS; sys--)
 309     {
 310       ret.push_back (st.at (brk, sys).details_);
 311       brk = st.at (brk, sys).prev_;
 312     }
 313   reverse (ret);
 314   return ret;
 315 }
 316
 317 int
 318 Constrained_breaking::get_min_systems (vsize start, vsize end)
 319 {
 320   vsize sys_count;
 321   vsize brk = prepare_solution (start, end, 1);
 322   vsize rank = breaks_.size () - starting_breakpoints_[start];
 323   Matrix<Constrained_break_node> const &st = state_[start];
 324
 325   /* sys_count < rank : rank is the # of breakpoints, we can't have more systems */
 326   for (sys_count = 0; sys_count < rank; sys_count++)
 327     {
 328       if (sys_count >= valid_systems_)
 329         {
 330           resize (sys_count + 3);
 331         }
 332       if (!isinf (st.at (brk, sys_count).details_.force_))
 333         return sys_count + 1;
 334     }
 335   /* no possible breaks satisfy constraints */
 336   return 1;
 337 }
 338
 339 int
 340 Constrained_breaking::get_max_systems (vsize start, vsize end)
 341 {
 342   vsize brk = (end >= start_.size ()) ? breaks_.size () - 1 : starting_breakpoints_[end];
 343   return brk - starting_breakpoints_[start];
 344 }
 345
 346 vsize
 347 Constrained_breaking::prepare_solution (vsize start, vsize end, vsize sys_count)
 348 {
 349   assert (start < start_.size () && (end == VPOS || end <= start_.size ()));
 350   assert (start < end);
 351
 352   resize (sys_count);
 353   if (end == start_.size ())
 354     end = VPOS;
 355
 356   vsize brk;
 357   brk = end == VPOS ? breaks_.size () - 1 : starting_breakpoints_[end];
 358   brk -= starting_breakpoints_[start];
 359   return brk;
 360 }
 361
 362 Constrained_breaking::Constrained_breaking ()
 363 {
 364   valid_systems_ = systems_ = 0;
 365   start_.push_back (0);
 366 }
 367
 368 Constrained_breaking::Constrained_breaking (vector<vsize> const &start)
 369   : start_ (start)
 370 {
 371   valid_systems_ = systems_ = 0;
 372 }
 373
 374 Real
 375 Constrained_breaking::combine_demerits (Real force, Real prev_force)
 376 {
 377   if (to_boolean (pscore_->layout ()->c_variable ("ragged-right")))
 378     return force * force;
 379
 380   return force * force + (prev_force - force) * (prev_force - force);
 381 }
 382