/*
- optimal-page-breaking.hh -- implement a page-breaker that
- will break pages in such a way that both horizontal and
- vertical spacing will be acceptable
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 2006--2010 Joe Neeman <joeneeman@gmail.com>
- (c) 2006 Joe Neeman <joeneeman@gmail.com>
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
+#include "international.hh"
#include "optimal-page-breaking.hh"
#include "output-def.hh"
#include "page-spacing.hh"
#include "prob.hh"
#include "system.hh"
+static bool
+is_break (Grob *g)
+{
+ return g->get_property ("page-break-permission") == ly_symbol2scm ("force");
+}
+
Optimal_page_breaking::Optimal_page_breaking (Paper_book *pb)
- : Page_breaking (pb, false)
+ : Page_breaking (pb, is_break)
{
}
{
}
-Spacing_result
-Optimal_page_breaking::try_page_spacing (vector<vsize> line_count)
-{
- vector<Line_details> lines = get_line_details (0, breaks_.size () - 1, line_count);
- Real page_h = page_height (1, false); // FIXME
- SCM force_sym = ly_symbol2scm ("blank-last-page-force");
- Real blank_force = robust_scm2double (book_->paper_->lookup_variable (force_sym), 0);
- Spacing_result ret = space_systems_on_best_pages (lines, page_h, blank_force);
+extern bool debug_page_breaking_scoring;
- bool ragged_all = to_boolean (book_->paper_->c_variable ("ragged-bottom"));
- bool ragged_last = to_boolean (book_->paper_->c_variable ("ragged-last-bottom"));
+// Solves the subproblem betwen the (END-1)th \pageBreak and the
+// ENDth \pageBreak.
+// Returns a vector of systems per page for the pages within this chunk.
+vector<vsize>
+Optimal_page_breaking::solve_chunk (vsize end, SCM forced_page_count)
+{
+ vsize max_sys_count = max_system_count (end-1, end);
+ vsize first_page_num = robust_scm2int (book_->paper_->c_variable ("first-page-number"), 1);
+
+ set_to_ideal_line_configuration (end-1, end);
+
+ Page_spacing_result best;
+ vsize page_count = robust_scm2int (forced_page_count, 1);
+ Line_division ideal_line_division = current_configuration (0);
+ Line_division best_division = ideal_line_division;
+ vsize min_sys_count = 1;
+ vsize ideal_sys_count = system_count ();
+
+ if (!scm_is_integer (forced_page_count))
+ {
+ if (systems_per_page () > 0)
+ best = space_systems_with_fixed_number_per_page (0, first_page_num);
+ else
+ best = space_systems_on_best_pages (0, first_page_num);
- /* add in the line penalties */
- Real line_force = 0;
- Real line_penalty = 0;
- Real page_weighting = robust_scm2double (book_->paper_->c_variable ("page-spacing-weight"), 1);
+ page_count = best.systems_per_page_.size ();
+ ideal_sys_count = best.system_count ();
+ min_sys_count = ideal_sys_count - best.systems_per_page_.back ();
+
+ if (page_count > 1 && best.systems_per_page_[page_count - 2] > 1)
+ min_sys_count -= best.systems_per_page_[page_count - 2];
- for (vsize i = 0; i < lines.size (); i++)
+ min_sys_count = max (min_sys_count, (vsize)1);
+ }
+ else
{
- line_force += fabs (lines[i].force_);
- line_penalty += lines[i].break_penalty_;
+ /* TODO: the following line will spit out programming errors if the
+ ideal line spacing doesn't fit on PAGE_COUNT pages */
+ /* TODO: the interaction between systems_per_page and page_count needs to
+ be considered. */
+ best = space_systems_on_n_pages (0, page_count, first_page_num);
+ min_sys_count = page_count;
}
- if (ragged_all)
- for (vsize i = 0; i < ret.force_.size () - 1; i++)
- ret.force_[i] = min (0.0, ret.force_[i]);
- if (ragged_all || ragged_last)
- ret.force_.back () = min (0.0, ret.force_.back ());
+ if (page_count == 1 || scm_is_integer (forced_page_count))
+ progress_indication (_f ("[%d: %d pages]", (int) end, (int) page_count));
+ else
+ progress_indication (_f ("[%d: %d or %d pages]", (int) end, (int) page_count-1, (int)page_count));
- ret.demerits_ = ret.force_[0] * ret.force_[0] * page_weighting;
- for (vsize i = 1; i < ret.force_.size (); i++)
+ /* try a smaller number of systems than the ideal number for line breaking */
+ Line_division bound = ideal_line_division;
+ for (vsize sys_count = ideal_sys_count; --sys_count >= min_sys_count;)
{
- Real uniformity = fabs (ret.force_[i] - ret.force_[i-1]);
- ret.demerits_ += (ret.force_[i] * ret.force_[i]
- + uniformity * uniformity) * page_weighting;
- }
- ret.demerits_ += line_force + line_penalty;
- return ret;
-}
+ Page_spacing_result best_for_this_sys_count;
+ set_current_breakpoints (end-1, end, sys_count, Line_division (), bound);
-/* The algorithm is as follows:
- 1) break everything into its preferred number of lines
- 2) decrease the number of lines until we've decreased
- the number of pages
- 3) increase the number of lines until we've increased
- the number of pages
- Take the best score we've found
-*/
-SCM
-Optimal_page_breaking::solve ()
-{
- vector<vsize> ideal_line_count;
- vector<vsize> max_line_count;
- vector<vsize> min_line_count;
- vector<vsize> last_best_line_count;
- vector<vsize> best_line_count;
- vsize last_line_total = 0;
-
- calc_system_count_bounds (0, breaks_.size () - 1, &min_line_count, &max_line_count);
- ideal_line_count.resize (all_.size (), 1);
- for (vsize i = 0; i < all_.size (); i++)
- {
- if (all_[i].pscore_)
- ideal_line_count[i] = line_breaking_[i].get_best_solution (0, VPOS).size ();
- last_line_total += ideal_line_count[i];
- }
+ if (debug_page_breaking_scoring)
+ message (_f ("trying %d systems", (int)sys_count));
- Spacing_result best_result = try_page_spacing (ideal_line_count);
- vsize original_page_count = best_result.systems_per_page_.size ();
- best_line_count = ideal_line_count;
- last_best_line_count = ideal_line_count;
-
- Direction d = original_page_count > 1 ? DOWN : UP;
- vector<vector<vsize> > div;
- Spacing_result this_best_result;
- do {
- do {
- vector<vsize> blank;
-
- vector<vsize> this_best_line_count;
- this_best_result.demerits_ = infinity_f;
-
- last_line_total += d;
- div.clear ();
- divide_systems (last_line_total,
- d == DOWN ? min_line_count : last_best_line_count,
- d == DOWN ? last_best_line_count : max_line_count,
- &div, &blank);
-
- for (vsize i = 0; i < div.size (); i++)
+ for (vsize i = 0; i < current_configuration_count (); i++)
{
- Spacing_result cur = try_page_spacing (div[i]);
- if (cur.demerits_ < this_best_result.demerits_)
+ vsize min_p_count = min_page_count (i, first_page_num);
+ Page_spacing_result cur;
+
+ if (min_p_count == page_count || scm_is_integer (forced_page_count))
+ cur = space_systems_on_n_pages (i, page_count, first_page_num);
+ else
+ cur = space_systems_on_n_or_one_more_pages (i, page_count-1, first_page_num, 0);
+
+ if (cur.demerits_ < best_for_this_sys_count.demerits_)
{
- this_best_result = cur;
- this_best_line_count = div[i];
+ best_for_this_sys_count = cur;
+ bound = current_configuration (i);
}
}
- last_best_line_count = this_best_line_count;
- if (this_best_result.demerits_ < best_result.demerits_)
+ if (debug_page_breaking_scoring)
+ message (_f ("best score for this sys-count: %f", best_for_this_sys_count.demerits_));
+
+ if (best_for_this_sys_count.demerits_ < best.demerits_)
{
- best_line_count = this_best_line_count;
- best_result = this_best_result;
+ best = best_for_this_sys_count;
+ best_division = bound;
}
- } while (div.size () && this_best_result.systems_per_page_.size () == original_page_count);
- /* we're finished decreasing system count, let's try raising it */
- last_best_line_count = ideal_line_count;
- last_line_total = 0;
- for (vsize i = 0; i < ideal_line_count.size (); i++)
- last_line_total += ideal_line_count[i];
+ /* Check to see if we already have too few systems. There are two ways
+ we check this: if we are trying one less than the ideal number of pages
+ and the pages are stretched on average then we have too
+ few systems. If the spacing is worse than BAD_SPACING_PENALTY, then we
+ have too few systems. In either case, though, we need to continue reducing
+ the number of systems if max-systems-per-page requires it. */
+ if (!(best.system_count_status_ & SYSTEM_COUNT_TOO_MANY))
+ {
+ if (best_for_this_sys_count.page_count () < page_count
+ && best_for_this_sys_count.average_force () > 0)
+ break;
+
+ if (best_for_this_sys_count.demerits_ >= BAD_SPACING_PENALTY)
+ break;
+ }
+ }
- } while (flip (&d) != DOWN);
+ /* try a larger number of systems than the ideal line breaking number. This
+ is more or less C&P, but the loop bounds make it difficult to try something
+ like do {...} while (flip(&d) != UP). */
+ bound = ideal_line_division;
+ for (vsize sys_count = ideal_sys_count+1; sys_count <= max_sys_count; sys_count++)
+ {
+ Real best_demerits_for_this_sys_count = infinity_f;
+ set_current_breakpoints (end-1, end, sys_count, bound);
- SCM lines = make_lines (best_line_count);
- SCM pages = make_pages (best_result.systems_per_page_, lines);
- return pages;
+ if (debug_page_breaking_scoring)
+ message (_f ("trying %d systems", (int)sys_count));
+
+ for (vsize i = 0; i < current_configuration_count (); i++)
+ {
+ vsize min_p_count = min_page_count (i, first_page_num);
+ Page_spacing_result cur;
+
+ if (min_p_count > page_count)
+ continue;
+ else
+ cur = space_systems_on_n_pages (i, page_count, first_page_num);
+
+ if (cur.demerits_ < best.demerits_)
+ {
+ best = cur;
+ best_division = current_configuration (i);
+ }
+
+ if (cur.demerits_ < best_demerits_for_this_sys_count)
+ {
+ best_demerits_for_this_sys_count = cur.demerits_;
+ bound = current_configuration (i);
+ }
+ }
+
+ if (debug_page_breaking_scoring)
+ message (_f ("best score for this sys-count: %f", best_demerits_for_this_sys_count));
+
+ if (best_demerits_for_this_sys_count >= BAD_SPACING_PENALTY
+ && !(best.system_count_status_ & SYSTEM_COUNT_TOO_FEW))
+ break;
+ }
+ break_into_pieces (end-1, end, best_division);
+
+ return best.systems_per_page_;
}
SCM
-Optimal_page_breaking::make_lines (vector<vsize> line_count)
+Optimal_page_breaking::solve ()
{
- assert (line_count.size () == all_.size ());
+ vector<vsize> systems_per_page;
+
+ SCM forced_page_counts = book_->paper_->c_variable ("page-count");
+ if (scm_is_integer (forced_page_counts))
+ forced_page_counts = scm_list_1 (forced_page_counts);
- SCM ret = SCM_EOL;
- for (vsize i = 0; i < all_.size (); i++)
+ bool is_forced_page_counts = false;
+ if (scm_to_bool (scm_list_p (forced_page_counts)))
{
- if (all_[i].pscore_)
+ int len = scm_to_int (scm_length (forced_page_counts));
+ if (len != (int)last_break_position ())
{
- vector<Column_x_positions> line_brk = line_breaking_[i].get_solution (0, VPOS, line_count[i]);
- System *sys = all_[i].pscore_->root_system ();
-
- sys->break_into_pieces (line_brk);
- ret = scm_append (scm_list_2 (ret, scm_vector_to_list (sys->get_paper_systems ())));
- }
+ warning (_f ("page-count has length %d, but it should have length %d "
+ "(one more than the number of forced page breaks)",
+ len, (int)last_break_position ()));
+ }
else
+ is_forced_page_counts = true;
+ }
+
+
+ message (_f ("Solving %d page-breaking chunks...", last_break_position ()));
+ for (vsize end = 1; end <= last_break_position (); ++end)
+ {
+ SCM page_count = SCM_EOL;
+ if (is_forced_page_counts)
{
- SCM l = scm_cons (all_[i].prob_->self_scm (), SCM_EOL);
- ret = scm_append (scm_list_2 (ret, l));
- all_[i].prob_->unprotect ();
+ page_count = scm_car (forced_page_counts);
+ forced_page_counts = scm_cdr (forced_page_counts);
}
+
+ vector<vsize> chunk_systems = solve_chunk (end, page_count);
+ systems_per_page.insert (systems_per_page.end (), chunk_systems.begin (), chunk_systems.end ());
}
- return ret;
+
+ message (_ ("Drawing systems..."));
+ SCM lines = systems ();
+ return make_pages (systems_per_page, lines);
}
+
projects / lilypond.git / blobdiff