X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fconstrained-breaking.cc;h=1e172fd492639c8565f81aebf1acf0b00bf0712c;hb=0387f04497978e37b335a8b99eec905499d6ad0f;hp=1f3171803bc025efd34f41a4eef067423f4e069b;hpb=7056ec0726ed866fcf12f6f0fcdbdd00a00733fc;p=lilypond.git diff --git a/lily/constrained-breaking.cc b/lily/constrained-breaking.cc index 1f3171803b..1e172fd492 100644 --- a/lily/constrained-breaking.cc +++ b/lily/constrained-breaking.cc @@ -4,39 +4,9 @@ source file of the GNU LilyPond music typesetter - (c) 2006 Han-Wen Nienhuys + (c) 2006--2008 Joe Neeman */ -/* - TODO: - - * vsize vs. int: casts should not be necessary. Use VPOS iso -1 as - magic signaling value? - - * The specification uses A j, k, n and m as variables. - - Functions use start,end,sys_count,calc_subproblem as variables. Use the same naming - for the specification as for the code. - - - FURTHER REMARKS: - - * - - int a; - int b; - - iso. - - int a, b; - - - * no spurious * in comments. - - - */ - - #include "constrained-breaking.hh" #include "international.hh" @@ -48,339 +18,397 @@ #include "system.hh" #include "warn.hh" -void -print_constrained_break_nodes (vector const &arr) -{ - for (vsize i = 0; i < arr.size (); i++) - { - printf ("node %d: ", (int)i); - arr[i].print (); - } -} - -/** - We use the following optimal substructure. Let W(A) be our weight function. - - Let A_{k,n} = (a_{k,n,1}, ... a_{k,n,k}) be the optimal set of line breaks - for k systems and n potential breakpoints. a_{k,n,k} = n (it is the end of - the piece) - - Then A_{k+1, m} is contructed from - min_ {k < j < m} ( W(A_{k,j} :: m) ) - where by A::m we denote appending m to the list A - +/* + We use the following optimal substructure. Let W (A) be our weight function. + + Let A_{k, n} = (a_{k, n,1}, ... a_{k, n, k}) be the optimal set of line breaks + for k systems and n potential breakpoints. a_{k, n, k} = n (it is the end of + the piece) + + Then A_{k+1, m} is contructed from + min_ {k < j < m} ( W (A_{k, j} :: m) ) + where by A::m we denote appending m to the list A + + Indices in the code: + + The above algorithm makes it easy to end at a point before the end of the + score (just find A_{k, m} for some m < breaks_.size () - 1). However, we must + add information for starting at a point after the beginning. One constructor + allows the specification of a list of starting columns, start_. We then have + start_.size () different solution arrays. state_[i] is the array for the + solution starting at column number start_[i]. + + The indices "start" and "end" refer to the index in the start_ array of the + desired starting and ending columns. + + each solution array looks like + a_{1,1,1} a_{2,1,2} a_{3,1,3} . . . + X a_{2,2,2} a_{3,2,3} . . . + X X a_{3,3,3} . . . + . . . . + . . . . + where the X's mark invalid solutions (can't have more systems than + breakpoints). Note that each value is of the form a_{x, n, x}. This is because + a breakpoint of the form a_{x, n, x-1} will also be called a_{x-1, m, x-1} for + some m < n. Each cell in the array stores the value of its m (ie. the + ending breakpoint of the previous line) as "prev_". + + For finding A_{sys, brk}, let "me" be the (sys_count, brk) cell in our + solution array (state_[start][sys * rank + brk]). + + Then A_{sys, brk} = A_{sys - 1, me.prev_} :: me */ -/* start and sys here are indexed from 0. - -max_break is indexed from starting_breakpoints_[start] (for - max_break, starting_breakpoints_[start] is the beginning of the - piece; the smallest value we should ever see here is - starting_breakpoints_[start] + 1) */ +/* + start and sys here are indexed from 0. + brk is indexed from starting_breakpoints_[start] + (for brk, starting_breakpoints_[start] is the beginning + of the piece; the smallest value we should ever see here is + starting_breakpoints_[start] + 1) */ bool -Constrained_breaking::calc_subproblem (int start, int sys, int max_break) +Constrained_breaking::calc_subproblem (vsize start, vsize sys, vsize brk) { assert (sys < systems_); - assert (start < (int)start_.size ()); - assert (max_break < (int)breaks_.size ()); + assert (start < start_.size ()); + assert (brk < breaks_.size ()); bool found_something = false; - int start_col = starting_breakpoints_[start]; - vector &st = state_[start]; - int rank = breaks_.size () - start_col; - int max_index = max_break - start_col; - for (int j = sys; j < max_index; j++) + vsize start_col = starting_breakpoints_[start]; + Matrix &st = state_[start]; + vsize max_index = brk - start_col; + for (vsize j=max_index; j-- > sys;) { if (0 == sys && j > 0) - break; /* the first line cannot have its first break after the beginning */ + continue; /* the first line cannot have its first break after the beginning */ - Column_x_positions const &cur = cols_[(j + start_col)*cols_rank_ + max_break]; - Column_x_positions prev; + Line_details const &cur = lines_.at (brk, j + start_col); + if (isinf (cur.force_)) + break; + + Real prev_f = 0; Real prev_dem = 0; if (sys > 0) { - prev = st[(sys-1) * rank + j].line_config_; - prev_dem = st[(sys-1) * rank + j].demerits_; + prev_f = st.at (j, sys-1).details_.force_; + prev_dem = st.at (j, sys-1).demerits_; } if (isinf (prev_dem)) - break; - - Real dem, force, pen; - combine_demerits(prev, cur, &force, &pen, &dem); - dem += prev_dem; - if (isinf (dem)) continue; - int k = sys*rank + max_index; - if (isinf (st[k].demerits_) - || dem < st[k].demerits_) + Real dem = combine_demerits (cur.force_, prev_f) + prev_dem + cur.break_penalty_; + Constrained_break_node &n = st.at (max_index, sys); + if (dem < n.demerits_) { found_something = true; - - /* - TODO: maybe just copy a Constrained_break_node ? - */ - st[k].demerits_ = dem; - st[k].force_ = force; - st[k].penalty_ = pen; - st[k].prev_ = j; - st[k].line_config_ = cur; + n.demerits_ = dem; + n.details_ = cur; + n.prev_ = j; } } return found_something; } -vector -Constrained_breaking::solve () -{ - if (!systems_) - { - programming_error (_f ("no system number set in constrained-breaking")); - systems_ = start_.size () / 2; - } - resize (); - return get_solution (0, systems_, -1); +Column_x_positions +Constrained_breaking::space_line (vsize i, vsize j) +{ + bool ragged_right = to_boolean (pscore_->layout ()->c_variable ("ragged-right")); + bool ragged_last = to_boolean (pscore_->layout ()->c_variable ("ragged-last")); + Column_x_positions col; + + vector line (all_.begin () + breaks_[i], + all_.begin () + breaks_[j] + 1); + Interval line_dims = line_dimensions_int (pscore_->layout (), i); + bool last = j == breaks_.size () - 1; + bool ragged = ragged_right || (last && ragged_last); + + /* As a special case, if there is only one line in the score and ragged-right + hasn't been specifically forbidden and the line is stretched, use + ragged spacing. */ + if (last && i == 0 + && lines_.at (i, j).force_ >= 0 + && !scm_is_bool (pscore_->layout ()->c_variable ("ragged-right")) + && !scm_is_bool (pscore_->layout ()->c_variable ("ragged-last"))) + ragged = true; + + return get_line_configuration (line, line_dims[RIGHT] - line_dims[LEFT], line_dims[LEFT], ragged); } void -Constrained_breaking::resize () +Constrained_breaking::resize (vsize systems) { - if (!breaks_.size ()) + systems_ = systems; + + if (pscore_ && systems_ > valid_systems_) { - bool ragged_right = to_boolean (pscore_->layout ()->c_variable ("ragged-right")); - bool ragged_last = to_boolean (pscore_->layout ()->c_variable ("ragged-last")); - - /* do all the rod/spring problems */ - breaks_ = pscore_->find_break_indices (); - cols_rank_ = breaks_.size (); - all_ = pscore_->root_system ()->columns (); - cols_.resize (breaks_.size () * breaks_.size ()); - for (vsize i = 0; i < breaks_.size () - 1; i++) - for (vsize j = i + 1; j < breaks_.size (); j++) - { - vector line (all_.begin () + breaks_[i], - all_.begin() + breaks_[j] + 1); - - line[0] = dynamic_cast (line[0])->find_prebroken_piece (RIGHT); - line.back () = dynamic_cast (line.back ())->find_prebroken_piece (LEFT); - - cols_[i*cols_rank_ + j].cols_ = line; - - /* we have no idea what line this will be -- only whether it is the first */ - Interval line_dims = line_dimensions_int (pscore_->layout (), i); - Simple_spacer_wrapper *sp = generate_spacing_problem (line, line_dims); - - bool last = j == breaks_.size () - 1; - bool ragged = ragged_right || (last && ragged_last); - sp->solve (&cols_[i*cols_rank_ + j], ragged); - - if (!cols_[i*cols_rank_ + j].satisfies_constraints_) - break; - delete sp; - } - - /* work out all the starting indices */ - for (vsize i = 0; i < start_.size (); i++) - { - vsize j; - for (j = 0; j < breaks_.size () - 1 && breaks_[j] < start_[i]; j++) - ; - starting_breakpoints_.push_back (j); - start_[i] = breaks_[j]; - } - state_.resize (start_.size ()); + for (vsize i = 0; i < state_.size (); i++) + state_[i].resize (breaks_.size () - starting_breakpoints_[i], systems_, Constrained_break_node ()); + + /* fill out the matrices */ + for (vsize i = 0; i < state_.size (); i++) + for (vsize j = valid_systems_; j < systems_; j++) + for (vsize k = starting_breakpoints_[i] + j + 1; k < breaks_.size (); k++) + if (!calc_subproblem (i, j, k)) + break; /* if we couldn't break this, it is too cramped already */ + valid_systems_ = systems_; } - - for (vsize i = 0; i < state_.size (); i++) - state_[i].resize((breaks_.size () - starting_breakpoints_[i]) * systems_); - - /* fill out the matrices */ - for (vsize i = 0; i < state_.size (); i++) - for (int j = valid_systems_; j < systems_; j++) - for (vsize k = starting_breakpoints_[i] + j + 1; k < breaks_.size (); k++) - if (!calc_subproblem (i, j, k)) - break; /* if we couldn't break this, it is too cramped already */ - - valid_systems_ = systems_; } vector -Constrained_breaking::get_solution (int start, int end, int sys_count) +Constrained_breaking::solve (vsize start, vsize end, vsize sys_count) { - int rank; - int brk; - prepare_solution (start, end, sys_count, &rank, &brk); + vsize start_brk = starting_breakpoints_[start]; + vsize end_brk = prepare_solution (start, end, sys_count); - vector const &st = state_[start]; + Matrix const &st = state_[start]; vector ret; - for (int sys = sys_count-1; sys >= 0; sys--) + /* find the first solution that satisfies constraints */ + for (vsize sys = sys_count-1; sys != VPOS; sys--) { - assert (brk > 0); - ret.push_back (st[sys*rank + brk].line_config_); - brk = st[sys*rank + brk].prev_; + for (vsize brk = end_brk; brk != VPOS; brk--) + { + if (!isinf (st.at (brk, sys).details_.force_)) + { + if (brk != end_brk) + { + warning (_ ("cannot find line breaking that satisfies constraints" )); + ret.push_back (space_line (brk, end_brk)); + } + /* build up the good solution */ + for (vsize cur_sys = sys; cur_sys != VPOS; cur_sys--) + { + vsize prev_brk = st.at (brk, cur_sys).prev_; + assert (brk != VPOS); + ret.push_back (space_line (prev_brk + start_brk, brk + start_brk)); + brk = prev_brk; + } + reverse (ret); + return ret; + } + } } - assert (brk == 0); - - reverse (ret); + /* if we get to here, just put everything on one line */ + warning (_ ("cannot find line breaking that satisfies constraints")); + ret.push_back (space_line (0, end_brk)); return ret; } -Real -Constrained_breaking::get_demerits (int start, int end, int sys_count) -{ - int rank; - int brk; - prepare_solution (start, end, sys_count, &rank, &brk); - - return state_[start][(sys_count-1)*rank + brk].demerits_; -} - -Real -Constrained_breaking::get_force (int start, int end, int sys_count) +vector +Constrained_breaking::best_solution (vsize start, vsize end) { - int rank; - int brk; - prepare_solution (start, end, sys_count, &rank, &brk); - vector const &st = state_[start]; - Real f = 0; + vsize min_systems = min_system_count (start, end); + vsize max_systems = max_system_count (start, end); + Real best_demerits = infinity_f; + vector best_so_far; - for (int sys = sys_count-1; sys >= 0 && brk >= 0; sys--) + for (vsize i = min_systems; i <= max_systems; i++) { - f += fabs (st[sys*rank + brk].force_); - brk = st[sys*rank + brk].prev_; + vsize brk = prepare_solution (start, end, i); + Real dem = state_[start].at (brk, i-1).demerits_; + + if (dem < best_demerits) + { + best_demerits = dem; + best_so_far = solve (start, end, i); + } + else + { + vector cur = solve (start, end, i); + bool too_many_lines = true; + + for (vsize j = 0; j < cur.size (); j++) + if (cur[j].force_ < 0) + { + too_many_lines = false; + break; + } + if (too_many_lines) + return best_so_far; + } } - if (brk < 0) - f = infinity_f; - - return f; + if (best_so_far.size ()) + return best_so_far; + return solve (start, end, max_systems); } -Real -Constrained_breaking::get_penalty (int start, int end, int sys_count) +std::vector +Constrained_breaking::line_details (vsize start, vsize end, vsize sys_count) { - int rank; - int brk; - prepare_solution (start, end, sys_count, &rank, &brk); - - return state_[start][(sys_count-1)*rank + brk].penalty_; -} + vsize brk = prepare_solution (start, end, sys_count); + Matrix const &st = state_[start]; + vector ret; -Real -Constrained_breaking::get_page_penalty (int start, int end, int sys_count, int sys_num) -{ - int rank; - int brk; - prepare_solution (start, end, sys_count, &rank, &brk); - - int sys; - for (sys = sys_count-1; sys > sys_num; sys--) - brk = state_[start][sys*rank + brk].prev_; - - if (brk < 0) /* we didn't satisfy constraints */ - return 0; - vector &cols = state_[start][sys*rank + brk].line_config_.cols_; - if (cols.empty ()) - return 0; - - Grob *pc = cols.back (); - if (pc->original ()) + for (int sys = sys_count-1; sys >= 0 && brk != VPOS; sys--) { - SCM pen = pc->get_property ("page-penalty"); - if (scm_is_number (pen) && fabs (scm_to_double (pen)) < 10000) - return scm_to_double (pen); + ret.push_back (st.at (brk, sys).details_); + brk = st.at (brk, sys).prev_; } - return 0; + reverse (ret); + return ret; } int -Constrained_breaking::get_min_systems (int start, int end) +Constrained_breaking::min_system_count (vsize start, vsize end) { - int rank; - int brk; - prepare_solution (start, end, 1, &rank, &brk); - int sys_count; - vector const &st = state_[start]; + vsize sys_count; + vsize brk = prepare_solution (start, end, 1); + vsize rank = breaks_.size () - starting_breakpoints_[start]; + Matrix const &st = state_[start]; /* sys_count < rank : rank is the # of breakpoints, we can't have more systems */ for (sys_count = 0; sys_count < rank; sys_count++) { if (sys_count >= valid_systems_) { - systems_ = sys_count + 3; - resize (); + resize (sys_count + 3); } - if (!isinf (st[sys_count*rank + brk].force_)) + if (!isinf (st.at (brk, sys_count).details_.force_)) return sys_count + 1; } /* no possible breaks satisfy constraints */ - return 0; + return 1; } int -Constrained_breaking::get_max_systems (int start, int end) +Constrained_breaking::max_system_count (vsize start, vsize end) { - int brk = (end < 0 || end >= (int)start_.size ()) ? breaks_.size () - 1 : start_[end]; + vsize brk = (end >= start_.size ()) ? breaks_.size () - 1 : starting_breakpoints_[end]; return brk - starting_breakpoints_[start]; } -void -Constrained_breaking::prepare_solution (vsize start, int end, int sys_count, int *rank, int *brk) +vsize +Constrained_breaking::prepare_solution (vsize start, vsize end, vsize sys_count) { - assert (start < start_.size () && end <= int (start_.size ())); - assert (end < 0 || int (start) < end); - assert (sys_count > 0); + assert (start < start_.size () && (end == VPOS || end <= start_.size ())); + assert (start < end); - if (sys_count >= valid_systems_) - { - systems_ = sys_count; - resize (); - } - if (end == (int)start_.size ()) - end = -1; + resize (sys_count); + if (end == start_.size ()) + end = VPOS; - *rank = breaks_.size () - starting_breakpoints_[start]; - *brk = end < 0 ? breaks_.size () - 1 : starting_breakpoints_[end]; - *brk -= starting_breakpoints_[start]; + vsize brk; + brk = end == VPOS ? breaks_.size () - 1 : starting_breakpoints_[end]; + brk -= starting_breakpoints_[start]; + return brk; } -Constrained_breaking::Constrained_breaking () +Constrained_breaking::Constrained_breaking (Paper_score *ps) { valid_systems_ = systems_ = 0; start_.push_back (0); + pscore_ = ps; + initialize (); } -Constrained_breaking::Constrained_breaking (vector const &start) +Constrained_breaking::Constrained_breaking (Paper_score *ps, vector const &start) : start_ (start) { valid_systems_ = systems_ = 0; + pscore_ = ps; + initialize (); +} + +static SCM +min_permission (SCM perm1, SCM perm2) +{ + if (perm1 == ly_symbol2scm ("force")) + return perm2; + if (perm1 == ly_symbol2scm ("allow") + && perm2 != ly_symbol2scm ("force")) + return perm2; + return SCM_EOL; } +/* find the forces for all possible lines and cache ragged_ and ragged_right_ */ void -Constrained_breaking::combine_demerits (Column_x_positions const &prev, - Column_x_positions const &col, - Real *force, - Real *penalty, - Real *demerits) const +Constrained_breaking::initialize () { - *penalty = 0; - if (col.cols_.empty () || !col.satisfies_constraints_) - *force = infinity_f; - else + if (!pscore_) + return; + + ragged_right_ = to_boolean (pscore_->layout ()->c_variable ("ragged-right")); + ragged_last_ = to_boolean (pscore_->layout ()->c_variable ("ragged-last")); + + Output_def *l = pscore_->layout (); + System *sys = pscore_->root_system (); + Real space = robust_scm2double (l->c_variable ("ideal-system-space"), 0); + SCM padding_scm = l->c_variable ("page-breaking-between-system-padding"); + if (!scm_is_number (padding_scm)) + padding_scm = l->c_variable ("between-system-padding"); + Real padding = robust_scm2double (padding_scm, 0.0); + + Interval first_line = line_dimensions_int (pscore_->layout (), 0); + Interval other_lines = line_dimensions_int (pscore_->layout (), 1); + /* do all the rod/spring problems */ + breaks_ = pscore_->find_break_indices (); + all_ = pscore_->root_system ()->used_columns (); + lines_.resize (breaks_.size (), breaks_.size (), Line_details ()); + vector forces = get_line_forces (all_, + other_lines.length (), + other_lines.length () - first_line.length (), + ragged_right_); + for (vsize i = 0; i + 1 < breaks_.size (); i++) { - *force = col.force_; + for (vsize j = i + 1; j < breaks_.size (); j++) + { + int start = Paper_column::get_rank (all_[breaks_[i]]); + int end = Paper_column::get_rank (all_[breaks_[j]]); + Interval extent = sys->pure_height (sys, start, end); + bool last = j == breaks_.size () - 1; + bool ragged = ragged_right_ || (last && ragged_last_); + Line_details &line = lines_.at (j, i); + + line.force_ = forces[i*breaks_.size () + j]; + if (ragged && last && !isinf (line.force_)) + line.force_ = (line.force_ < 0 && j > i + 1) ? infinity_f : 0; + if (isinf (line.force_)) + break; + + Grob *c = all_[breaks_[j]]; + line.break_penalty_ = robust_scm2double (c->get_property ("line-break-penalty"), 0); + line.page_penalty_ = robust_scm2double (c->get_property ("page-break-penalty"), 0); + line.turn_penalty_ = robust_scm2double (c->get_property ("page-turn-penalty"), 0); + line.break_permission_ = c->get_property ("line-break-permission"); + line.page_permission_ = c->get_property ("page-break-permission"); + line.turn_permission_ = c->get_property ("page-turn-permission"); + + /* turn permission should always be stricter than page permission + and page permission should always be stricter than line permission */ + line.page_permission_ = min_permission (line.break_permission_, + line.page_permission_); + line.turn_permission_ = min_permission (line.page_permission_, + line.turn_permission_); + + line.extent_ = (extent.is_empty () + || isnan (extent[LEFT]) + || isnan (extent[RIGHT])) + ? Interval (0, 0) : extent; + line.padding_ = padding; + line.space_ = space; + line.inverse_hooke_ = extent.length () + space; + } + } - Grob *pc = col.cols_.back (); - if (pc->original ()) - { - SCM pen = pc->get_property ("penalty"); - if (scm_is_number (pen) && fabs (scm_to_double (pen)) < 10000) - *penalty += scm_to_double (pen); - } + /* work out all the starting indices */ + for (vsize i = 0; i < start_.size (); i++) + { + vsize j; + for (j = 0; j + 1 < breaks_.size () && breaks_[j] < start_[i]; j++) + ; + starting_breakpoints_.push_back (j); + start_[i] = breaks_[j]; } + state_.resize (start_.size ()); +} + +Real +Constrained_breaking::combine_demerits (Real force, Real prev_force) +{ + if (ragged_right_) + return force * force; - *demerits = (*force) * (*force) + abs (prev.force_ - *force) + *penalty; + return force * force + (prev_force - force) * (prev_force - force); }