lily/include/constrained-breaking.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2006--2010 Joe Neeman <joeneeman@gmail.com>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef CONSTRAINED_BREAKING_HH
  21 #define CONSTRAINED_BREAKING_HH
  22
  23 #include "lily-guile.hh"
  24 #include "matrix.hh"
  25 #include "prob.hh"
  26
  27 struct Line_details {
  28   Grob *last_column_;
  29   Real force_;
  30   Interval extent_;   /* Y-extent of the system */
  31
  32   Real padding_;  /* compulsory space after this system (if we're not
  33                      last on a page) */
  34   Real title_padding_;
  35   Real bottom_padding_;
  36   Real space_;    /* spring length */
  37   Real inverse_hooke_;
  38
  39   SCM break_permission_;
  40   SCM page_permission_;
  41   SCM turn_permission_;
  42   Real break_penalty_;
  43   Real page_penalty_;
  44   Real turn_penalty_;
  45
  46   bool title_;
  47
  48   /* The page-breaker deals with forbidden page breaks by "compressing"
  49      two Line_detailses into one. The following fields are used by the
  50      page-breaker to keep track of this. If the number of fields needed
  51      by the page-breaker grows, it might be a good idea to create a separate
  52      class. */
  53   int compressed_lines_count_;
  54   int compressed_nontitle_lines_count_;
  55   bool last_markup_line_;
  56   bool first_markup_line_;
  57
  58   Line_details ()
  59   {
  60     last_column_ = 0;
  61     force_ = infinity_f;
  62     padding_ = 0;
  63     title_padding_ = 0;
  64     bottom_padding_ = 0;
  65     space_ = 0;
  66     inverse_hooke_ = 1;
  67     break_permission_ = ly_symbol2scm ("allow");
  68     page_permission_ = ly_symbol2scm ("allow");
  69     turn_permission_ = ly_symbol2scm ("allow");
  70     break_penalty_ = 0;
  71     page_penalty_ = 0;
  72     turn_penalty_ = 0;
  73     title_ = false;
  74     compressed_lines_count_ = 1;
  75     compressed_nontitle_lines_count_ = 1;
  76     last_markup_line_ = false;
  77     first_markup_line_ = false;
  78   }
  79
  80   Line_details (Prob *pb, Output_def *paper);
  81 };
  82
  83 /*
  84    Helper to trace back an optimal path
  85 */
  86 struct Constrained_break_node
  87 {
  88   /* the number of bars in all the systems before this one
  89   */
  90   int prev_;
  91
  92   /* unlike the Gourlay breaker, this is the sum of all demerits up to,
  93    * and including, this line */
  94   Real demerits_;
  95   struct Line_details details_;
  96
  97   Constrained_break_node ()
  98   {
  99     prev_ = -1;
 100     demerits_ = infinity_f;
 101   }
 102
 103   void print () const
 104   {
 105     printf ("prev break %d, demerits %f\n", prev_, demerits_);
 106   }
 107 };
 108
 109 /*
 110    A dynamic programming solution to breaking scores into lines
 111 */
 112 class Constrained_breaking
 113 {
 114 public:
 115   vector<Column_x_positions> solve (vsize start, vsize end, vsize sys_count);
 116   vector<Column_x_positions> best_solution (vsize start, vsize end);
 117   vector<Line_details> line_details (vsize start, vsize end, vsize sys_count);
 118
 119   Constrained_breaking (Paper_score *ps);
 120   Constrained_breaking (Paper_score *ps, vector<vsize> const &start_col_posns);
 121
 122   int max_system_count (vsize start, vsize end);
 123   int min_system_count (vsize start, vsize end);
 124
 125 private:
 126   Paper_score *pscore_;
 127   vsize valid_systems_;
 128   vsize systems_;
 129   bool ragged_right_;
 130   bool ragged_last_;
 131   Real between_system_space_;
 132   Real before_title_padding_;
 133   Real between_system_padding_;
 134
 135   /* the (i,j)th entry is the configuration for breaking between
 136     columns i and j */
 137   Matrix<Line_details> lines_;
 138
 139   /* the [i](j,k)th entry is the score for fitting the first k bars onto the
 140     first j systems, starting at the i'th allowed starting column */
 141   vector<Matrix<Constrained_break_node> > state_;
 142
 143   vector<vsize> start_;         /* the columns at which we might be asked to start breaking */
 144   vector<vsize> starting_breakpoints_; /* the corresponding index in breaks_ */
 145
 146   vector<Grob*> all_;
 147   vector<vsize> breaks_;
 148
 149   void initialize ();
 150   void resize (vsize systems);
 151
 152   Column_x_positions space_line (vsize start_col, vsize end_col);
 153   vsize prepare_solution (vsize start, vsize end, vsize sys_count);
 154
 155   Real combine_demerits (Real force, Real prev_force);
 156
 157   bool calc_subproblem (vsize start, vsize systems, vsize max_break_index);
 158   void fill_line_details (Line_details *const, vsize, vsize);
 159 };
 160 #endif /* CONSTRAINED_BREAKING_HH */