2 gourlay-breaking.cc -- implement Gourlay_breaking
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
8 #include <math.h> // rint
10 #include "gourlay-breaking.hh"
11 #include "column-x-positions.hh"
13 #include "paper-column.hh"
14 #include "paper-score.hh"
15 #include "paper-def.hh"
16 #include "simple-spacer.hh"
17 #include "line-of-score.hh"
19 /// How often to print operator pacification marks?
20 const int HAPPY_DOTS_I = 3;
23 Helper to trace back an optimal path
26 /** this was the previous. If negative, this break should not be
27 considered: this path has infinite energy
32 Which system number so far?
37 Column_x_positions line_config_;
48 This algorithms is adapted from the OSU Tech report on breaking lines.
50 this function is longish, but not very complicated.
53 Array<Column_x_positions>
54 Gourlay_breaking::do_solve () const
56 Array<Break_node> optimal_paths;
57 Link_array<Grob> all =
58 pscore_l_->line_l_->column_l_arr ();
60 Array<int> breaks = find_break_indices ();
62 optimal_paths.set_size (breaks.size ());
64 Break_node first_node ;
66 optimal_paths[0] = first_node;
69 Real worst_force = 0.0;
71 for (; break_idx< breaks.size (); break_idx++)
74 start with a short line, add measures. At some point
75 the line becomes infeasible. Then we don't try to add more
77 int minimal_start_idx = -1;
78 Column_x_positions minimal_sol;
79 Column_x_positions backup_sol;
81 Real minimal_demerits = infinity_f;
83 for (int start_idx = break_idx; start_idx--;)
85 Link_array<Grob> line = all.slice (breaks[start_idx], breaks[break_idx]+1);
87 line[0] = dynamic_cast<Item*> (line[0]) ->find_prebroken_piece (RIGHT);
88 line.top () = dynamic_cast<Item*> (line.top ())->find_prebroken_piece (LEFT);
90 Column_x_positions cp;
94 = pscore_l_->paper_l_->line_dimensions_int (optimal_paths[start_idx].line_i_);
95 Simple_spacer * sp = generate_spacing_problem (line, line_dims);
99 if (cp.force_f_ > worst_force)
100 worst_force = cp.force_f_;
103 We remember this solution as a "should always work
104 solution", in case everything fucks up. */
105 if (start_idx == break_idx - 1)
107 if (!cp.satisfies_constraints_b_)
110 If it doesn't satisfy constraints, we make this one
113 cp.force_f_ += worst_force;
119 if (optimal_paths[start_idx].demerits_f_ >= infinity_f)
120 this_demerits = infinity_f;
122 this_demerits = combine_demerits (optimal_paths[start_idx].line_config_, cp)
123 + optimal_paths[start_idx].demerits_f_;
125 if (this_demerits < minimal_demerits)
127 minimal_start_idx = start_idx;
129 minimal_demerits = this_demerits;
133 we couldn't satisfy the constraints, this won't get better
134 if we add more columns, so we get on with the next one
136 if (!cp.satisfies_constraints_b_)
140 int prev =break_idx - 1;
141 if (minimal_start_idx < 0)
143 optimal_paths[break_idx].demerits_f_ = infinity_f;
144 optimal_paths[break_idx].line_config_ = backup_sol;
148 prev = minimal_start_idx;
149 optimal_paths[break_idx].line_config_ = minimal_sol;
150 optimal_paths[break_idx].demerits_f_ = minimal_demerits;
152 optimal_paths[break_idx].prev_break_i_ = prev;
153 optimal_paths[break_idx].line_i_ = optimal_paths[prev].line_i_ + 1;
155 if (! (break_idx % HAPPY_DOTS_I))
156 progress_indication (String ("[") + to_str (break_idx) + "]");
159 /* do the last one */
160 if (break_idx % HAPPY_DOTS_I)
161 progress_indication (String ("[") + to_str (break_idx) + "]");
164 progress_indication ("\n");
166 Array<int> final_breaks;
167 Array<Column_x_positions> lines;
169 /* skip 0-th element, since it is a "dummy" elt*/
170 for (int i = optimal_paths.size ()-1; i> 0;)
172 final_breaks.push (i);
173 int prev = optimal_paths[i].prev_break_i_;
178 if (optimal_paths.top ().demerits_f_ >= infinity_f)
179 warning (_ ("No feasible line breaking found"));
181 for (int i= final_breaks.size (); i--;)
183 Column_x_positions cp (optimal_paths[final_breaks[i]].line_config_);
186 if(!cp.satisfies_constraints_b_)
187 warning ("Could not find line breaking that satisfies constraints.");
193 Gourlay_breaking::Gourlay_breaking ()
200 TODO: uniformity parameter to control rel. importance of spacing differences.
203 Gourlay_breaking::combine_demerits (Column_x_positions const &prev,
204 Column_x_positions const &this_one) const
206 Real break_penalties = 0.0;
207 Grob * pc = this_one.cols_.top ();
210 SCM pen = pc->get_grob_property ("penalty");
211 if (gh_number_p (pen))
213 break_penalties += gh_scm2double (pen);
217 return abs (this_one.force_f_) + abs (prev.force_f_ - this_one.force_f_)