X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Foptimal-page-breaking.cc;h=4bcf05f8e49e71604b3f4d62229dac5470b98a2c;hb=97a0169312a260933246ab224e4f8b0969871dd5;hp=6e5d20dfd6781e471accb7286133b76827bd58dd;hpb=7b032d0e90b828bee401bc27febd3cc1a736c0c2;p=lilypond.git diff --git a/lily/optimal-page-breaking.cc b/lily/optimal-page-breaking.cc index 6e5d20dfd6..4bcf05f8e4 100644 --- a/lily/optimal-page-breaking.cc +++ b/lily/optimal-page-breaking.cc @@ -1,11 +1,20 @@ /* - optimal-page-breaking.cc -- 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--2015 Joe Neeman - (c) 2006--2009 Joe Neeman + 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 . */ #include "international.hh" @@ -17,14 +26,8 @@ #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, is_break) + : Page_breaking (pb, 0, 0) { } @@ -32,157 +35,187 @@ Optimal_page_breaking::~Optimal_page_breaking () { } -// 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 -Optimal_page_breaking::solve_chunk (vsize end) +extern bool debug_page_breaking_scoring; + +SCM +Optimal_page_breaking::solve () { - vsize max_sys_count = max_system_count (end-1, end); + vsize end = last_break_position (); + vsize max_sys_count = max_system_count (0, end); vsize first_page_num = robust_scm2int (book_->paper_->c_variable ("first-page-number"), 1); - SCM forced_page_count = book_->paper_->c_variable ("page-count"); - set_to_ideal_line_configuration (end-1, end); + set_to_ideal_line_configuration (0, end); Page_spacing_result best; + SCM forced_page_count = book_->paper_->c_variable ("page-count"); 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; + + // Note that system_count () only counts non-title systems. 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); + /* find out the ideal number of pages */ + message (_ ("Finding the ideal number of pages...")); + + best = space_systems_on_best_pages (0, first_page_num); 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]; + if (page_count == 0) + { + min_sys_count = 0; + } + else + { + min_sys_count = ideal_sys_count - best.systems_per_page_.back (); - min_sys_count = max (min_sys_count, (vsize)1); + if (page_count > 1 && best.systems_per_page_[page_count - 2] > 1) + min_sys_count -= best.systems_per_page_[page_count - 2]; + + if (min_sys_count > ideal_sys_count // subtraction wrapped around + || min_sys_count <= 0) + min_sys_count = 1; + } } else { + /* If systems-per-page and page-count are both specified, we know exactly + how many systems should be present. */ + if (systems_per_page () > 0) + { + ideal_sys_count = systems_per_page () * page_count; + + if (ideal_sys_count > max_system_count (0, end) + || ideal_sys_count < min_system_count (0, end)) + { + warning (_ ("could not satisfy systems-per-page and page-count at the same time, ignoring systems-per-page")); + ideal_sys_count = system_count (); + min_sys_count = page_count; + } + else + { + set_current_breakpoints (0, end, ideal_sys_count); + min_sys_count = max_sys_count = ideal_sys_count; + ideal_line_division = best_division = current_configuration (0); + } + } + else + min_sys_count = page_count; + /* 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. */ + ideal line spacing doesn't fit on PAGE_COUNT pages */ best = space_systems_on_n_pages (0, page_count, first_page_num); - min_sys_count = page_count; } - if (page_count == 1 || scm_is_integer (forced_page_count)) - progress_indication (_f ("[%d: %d pages]", (int) end, (int) page_count)); + if (page_count == 1) + message (_ ("Fitting music on 1 page...")); + else if (scm_is_integer (forced_page_count) || page_count == 0) + message (_f ("Fitting music on %d pages...", (int)page_count)); else - progress_indication (_f ("[%d: %d or %d pages]", (int) end, (int) page_count-1, (int)page_count)); + message (_f ("Fitting music on %d or %d pages...", (int)page_count - 1, (int)page_count)); /* 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;) + for (vsize sys_count = ideal_sys_count + 1; --sys_count >= min_sys_count;) { Page_spacing_result best_for_this_sys_count; - set_current_breakpoints (end-1, end, sys_count, Line_division (), bound); + set_current_breakpoints (0, end, sys_count, Line_division (), bound); + + 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 || 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); - - if (cur.demerits_ < best_for_this_sys_count.demerits_) - { - best_for_this_sys_count = cur; - bound = current_configuration (i); - } - } + { + Page_spacing_result cur; + + if (scm_is_integer (forced_page_count)) + cur = space_systems_on_n_pages (i, page_count, first_page_num); + else + cur = space_systems_on_best_pages (i, first_page_num); + + if (cur.demerits_ < best_for_this_sys_count.demerits_) + { + best_for_this_sys_count = cur; + bound = current_configuration (i); + } + } + + 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 = best_for_this_sys_count; - best_division = bound; - } + { + best = best_for_this_sys_count; + best_division = bound; + } /* 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. */ + 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; - } + { + 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; + } } /* 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). */ + is more or less C&P. */ bound = ideal_line_division; - for (vsize sys_count = ideal_sys_count+1; sys_count <= max_sys_count; sys_count++) + 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); + set_current_breakpoints (0, end, sys_count, bound); - 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 (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); + if (debug_page_breaking_scoring) + message (_f ("trying %d systems", (int)sys_count)); - return best.systems_per_page_; -} - -SCM -Optimal_page_breaking::solve () -{ - vector systems_per_page; + 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 if (scm_is_integer (forced_page_count)) + cur = space_systems_on_n_pages (i, page_count, first_page_num); + else + cur = space_systems_on_best_pages (i, 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)); - message (_f ("Solving %d page-breaking chunks...", last_break_position ())); - for (vsize end = 1; end <= last_break_position (); ++end) - { - vector chunk_systems = solve_chunk (end); - systems_per_page.insert (systems_per_page.end (), chunk_systems.begin (), chunk_systems.end ()); + if (best_demerits_for_this_sys_count >= BAD_SPACING_PENALTY + && !(best.system_count_status_ & SYSTEM_COUNT_TOO_FEW)) + break; } message (_ ("Drawing systems...")); + break_into_pieces (0, end, best_division); SCM lines = systems (); - return make_pages (systems_per_page, lines); + return make_pages (best.systems_per_page_, lines); }