source file of the GNU LilyPond music typesetter
- (c) 2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ (c) 2006--2009 Joe Neeman <joeneeman@gmail.com>
*/
#include "constrained-breaking.hh"
#include "warn.hh"
/*
- We use the following optimal substructure. Let W(A) be our weight function.
+ 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
+ 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) )
+ 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
+ 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 indicies "start" and "end" refer to the index in the start_ array of the
+ 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
. . . .
. . . .
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
+ 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
+ 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
bool found_something = false;
vsize start_col = starting_breakpoints_[start];
- vector<Constrained_break_node> &st = state_[start];
- vsize rank = breaks_.size () - start_col;
+ Matrix<Constrained_break_node> &st = state_[start];
vsize max_index = brk - start_col;
- for (vsize j=sys; j < max_index; j++)
+ 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 */
+
+ Line_details const &cur = lines_.at (brk, j + start_col);
+ if (isinf (cur.force_))
+ break;
- Line_details const &cur = lines_[(j + start_col)*lines_rank_ + brk];
Real prev_f = 0;
Real prev_dem = 0;
if (sys > 0)
{
- prev_f = st[(sys-1) * rank + j].details_.force_;
- 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 = combine_demerits (cur.force_, prev_f) + prev_dem + cur.break_penalty_;
- 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;
- st[k].demerits_ = dem;
- st[k].details_ = cur;
- st[k].prev_ = j;
+ n.demerits_ = dem;
+ n.details_ = cur;
+ n.prev_ = j;
}
}
return found_something;
}
-vector<Column_x_positions>
-Constrained_breaking::solve ()
-{
- if (!systems_)
- {
- programming_error (_f ("no system number set in constrained-breaking"));
- systems_ = breaks_.size () / 4;
- }
-
- resize (systems_);
- return get_solution(0, VPOS, systems_);
-}
Column_x_positions
Constrained_breaking::space_line (vsize i, vsize j)
Column_x_positions col;
vector<Grob*> line (all_.begin () + breaks_[i],
- all_.begin() + breaks_[j] + 1);
+ 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);
}
{
systems_ = systems;
- if (!breaks_.size () && pscore_)
- {
- Output_def *l = pscore_->layout ();
- Real extent = scm_to_double (l->c_variable ("system-height"));
- Real padding = scm_to_double (l->c_variable ("between-system-padding"));
- Real space = scm_to_double (l->c_variable ("between-system-space"));
- bool ragged_right = to_boolean (pscore_->layout ()->c_variable ("ragged-right"));
- bool ragged_last = to_boolean (pscore_->layout ()->c_variable ("ragged-last"));
-
- 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 ();
- lines_rank_ = breaks_.size ();
- all_ = pscore_->root_system ()->columns ();
- lines_.resize (breaks_.size () * breaks_.size ());
- vector<Real> forces = get_line_forces (all_,
- breaks_,
- other_lines.length (),
- other_lines.length () - first_line.length (),
- ragged_right);
- for (vsize i = 0; i < breaks_.size () - 1; i++)
- {
- for (vsize j = i + 1; j < breaks_.size (); j++)
- {
- bool last = j == breaks_.size () - 1;
- bool ragged = ragged_right || (last && ragged_last);
- int k = i*lines_rank_ + j;
- SCM pen = all_[breaks_[j]]->get_property ("line-break-penalty");
- if (scm_is_number (pen))
- lines_[k].break_penalty_ = scm_to_double (pen);
-
- lines_[k].force_ = forces[k];
- lines_[k].extent_ = extent;
- lines_[k].padding_ = padding;
- lines_[k].space_ = space;
- lines_[k].inverse_hooke_ = 3; // FIXME: somewhat arbitrary
- if (ragged && lines_[k].force_ < 0)
- lines_[k].force_ = infinity_f;
- if (isinf (lines_[k].force_))
- break;
- }
- }
-
- /* 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 ());
- }
-
if (pscore_ && systems_ > valid_systems_)
{
for (vsize i = 0; i < state_.size (); i++)
- state_[i].resize((breaks_.size () - starting_breakpoints_[i]) * systems_);
+ state_[i].resize (breaks_.size () - starting_breakpoints_[i], systems_, Constrained_break_node ());
/* fill out the matrices */
for (vsize i = 0; i < state_.size (); i++)
}
vector<Column_x_positions>
-Constrained_breaking::get_solution (vsize start, vsize end, vsize sys_count)
+Constrained_breaking::solve (vsize start, vsize end, vsize sys_count)
{
- vsize rank;
- vsize end_brk;
vsize start_brk = starting_breakpoints_[start];
- prepare_solution (start, end, sys_count, &rank, &end_brk);
+ vsize end_brk = prepare_solution (start, end, sys_count);
- vector<Constrained_break_node> const &st = state_[start];
+ Matrix<Constrained_break_node> const &st = state_[start];
vector<Column_x_positions> ret;
/* find the first solution that satisfies constraints */
{
for (vsize brk = end_brk; brk != VPOS; brk--)
{
- if (!isinf (st[sys*rank + brk].details_.force_))
+ if (!isinf (st.at (brk, sys).details_.force_))
{
if (brk != end_brk)
{
- warning ( _("couldn't find line breaking that satisfies constraints" ));
+ 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[cur_sys*rank + brk].prev_;
+ 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;
}
}
/* if we get to here, just put everything on one line */
- warning ( _("couldn't find line breaking that satisfies constraints" ));
+ warning (_ ("cannot find line breaking that satisfies constraints"));
ret.push_back (space_line (0, end_brk));
return ret;
}
+vector<Column_x_positions>
+Constrained_breaking::best_solution (vsize start, vsize end)
+{
+ vsize min_systems = min_system_count (start, end);
+ vsize max_systems = max_system_count (start, end);
+ Real best_demerits = infinity_f;
+ vector<Column_x_positions> best_so_far;
+
+ for (vsize i = min_systems; i <= max_systems; i++)
+ {
+ 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<Column_x_positions> 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 (best_so_far.size ())
+ return best_so_far;
+ return solve (start, end, max_systems);
+}
+
std::vector<Line_details>
-Constrained_breaking::get_details (vsize start, vsize end, vsize sys_count)
+Constrained_breaking::line_details (vsize start, vsize end, vsize sys_count)
{
- vsize rank;
- vsize brk;
- prepare_solution (start, end, sys_count, &rank, &brk);
- vector<Constrained_break_node> const &st = state_[start];
+ vsize brk = prepare_solution (start, end, sys_count);
+ Matrix<Constrained_break_node> const &st = state_[start];
vector<Line_details> ret;
for (int sys = sys_count-1; sys >= 0 && brk != VPOS; sys--)
{
- ret.push_back (st[sys*rank + brk].details_);
- brk = st[sys*rank + brk].prev_;
+ ret.push_back (st.at (brk, sys).details_);
+ brk = st.at (brk, sys).prev_;
}
+ reverse (ret);
return ret;
}
int
-Constrained_breaking::get_min_systems (vsize start, vsize end)
+Constrained_breaking::min_system_count (vsize start, vsize end)
{
- vsize rank;
- vsize brk;
vsize sys_count;
-
- prepare_solution (start, end, 1, &rank, &brk);
- vector<Constrained_break_node> const &st = state_[start];
+ vsize brk = prepare_solution (start, end, 1);
+ vsize rank = breaks_.size () - starting_breakpoints_[start];
+ Matrix<Constrained_break_node> 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++)
{
resize (sys_count + 3);
}
- if (!isinf (st[sys_count*rank + brk].details_.force_))
+ if (!isinf (st.at (brk, sys_count).details_.force_))
return sys_count + 1;
}
/* no possible breaks satisfy constraints */
}
int
-Constrained_breaking::get_max_systems (vsize start, vsize end)
+Constrained_breaking::max_system_count (vsize start, vsize end)
{
vsize brk = (end >= start_.size ()) ? breaks_.size () - 1 : starting_breakpoints_[end];
return brk - starting_breakpoints_[start];
}
-void
-Constrained_breaking::prepare_solution (vsize start, vsize end, vsize sys_count, vsize *rank, vsize *brk)
+vsize
+Constrained_breaking::prepare_solution (vsize start, vsize end, vsize sys_count)
{
assert (start < start_.size () && (end == VPOS || end <= start_.size ()));
assert (start < end);
if (end == start_.size ())
end = VPOS;
- *rank = breaks_.size () - starting_breakpoints_[start];
- *brk = end == VPOS ? 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<vsize> const &start)
+Constrained_breaking::Constrained_breaking (Paper_score *ps, vector<vsize> 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::initialize ()
+{
+ 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<Real> 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++)
+ {
+ 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;
+ }
+ }
+
+ /* 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)
{
- return force * force + fabs (prev_force - force);
+ if (ragged_right_)
+ return force * force;
+
+ return force * force + (prev_force - force) * (prev_force - force);
}
projects / lilypond.git / blobdiff