]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/constrained-breaking.hh
Run `make grand-replace'.
[lilypond.git] / lily / include / constrained-breaking.hh
index 11965e8b649a54ec1023df08ee2cd9ac608c8395..ff60adf34cadea06f2726be8a1750d778268a153 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 2006--2008 Joe Neeman <joeneeman@gmail.com>
 */
 
 #ifndef CONSTRAINED_BREAKING_HH
 #define CONSTRAINED_BREAKING_HH
 
-#include "break-algorithm.hh"
+#include "lily-guile.hh"
+#include "matrix.hh"
+#include "prob.hh"
 
-/**
+struct Line_details {
+  Real force_;
+  Interval extent_;   /* Y-extent of the system */
+
+  Real padding_;  /* compulsory space after this system (if we're not
+                    last on a page) */
+  Real bottom_padding_;
+  Real space_;    /* spring length */
+  Real inverse_hooke_;
+
+  SCM break_permission_;
+  SCM page_permission_;
+  SCM turn_permission_;
+  Real break_penalty_;
+  Real page_penalty_;
+  Real turn_penalty_;
+
+  bool title_;
+
+  Line_details ()
+  {
+    force_ = infinity_f;
+    padding_ = 0;
+    bottom_padding_ = 0;
+    space_ = 0;
+    inverse_hooke_ = 1;
+    break_permission_ = ly_symbol2scm ("allow");
+    page_permission_ = ly_symbol2scm ("allow");
+    turn_permission_ = ly_symbol2scm ("allow");
+    break_penalty_ = 0;
+    page_penalty_ = 0;
+    turn_penalty_ = 0;
+    title_ = false;
+  }
+
+  Line_details (Prob *pb)
+  {
+    force_ = 0;
+    extent_ = unsmob_stencil (pb->get_property ("stencil")) ->extent (Y_AXIS);
+    padding_ = robust_scm2double (pb->get_property ("next-padding"), 0);
+    bottom_padding_ = 0;
+    space_ = robust_scm2double (pb->get_property ("next-space"), 1.0);
+    inverse_hooke_ = 1.0;
+    break_permission_ = ly_symbol2scm ("allow");
+    page_permission_ = pb->get_property ("page-break-permission");
+    turn_permission_ = pb->get_property ("page-turn-permission");
+    break_penalty_ = 0;
+    page_penalty_ = robust_scm2double (pb->get_property ("page-break-penalty"), 0);
+    turn_penalty_ = robust_scm2double (pb->get_property ("page-turn-penalty"), 0);
+    title_ = to_boolean (pb->get_property ("is-title"));
+  }
+};
+
+/*
    Helper to trace back an optimal path
 */
 struct Constrained_break_node
 {
-  /** the number of bars in all the systems before this one
+  /* the number of bars in all the systems before this one
   */
   int prev_;
 
-  /** unlike the Gourlay breaker, this is the sum of all demerits up to,
+  /* unlike the Gourlay breaker, this is the sum of all demerits up to,
    * and including, this line */
   Real demerits_;
-  Real force_;
-  Real penalty_;
-  Column_x_positions line_config_;
+  struct Line_details details_;
 
   Constrained_break_node ()
   {
     prev_ = -1;
     demerits_ = infinity_f;
-    force_ = infinity_f;
-    penalty_ = 0;
-    line_config_.satisfies_constraints_ = false;
   }
 
   void print () const
   {
-    printf ("prev break %d, demerits %f\n",
-           prev_, demerits_);
+    printf ("prev break %d, demerits %f\n", prev_, demerits_);
   }
 };
 
-/**
+/*
    A dynamic programming solution to breaking scores into lines
 */
-class Constrained_breaking : public Break_algorithm
+class Constrained_breaking
 {
-  public:
-    std::vector<Column_x_positions> do_solve ();
-    Constrained_breaking ();
-    Constrained_breaking (std::vector<int> const &start_col_posns);
+public:
+  vector<Column_x_positions> solve (vsize start, vsize end, vsize sys_count);
+  vector<Column_x_positions> best_solution (vsize start, vsize end);
+  vector<Line_details> line_details (vsize start, vsize end, vsize sys_count);
+
+  Constrained_breaking (Paper_score *ps);
+  Constrained_breaking (Paper_score *ps, vector<vsize> const &start_col_posns);
 
-    std::vector<Column_x_positions> get_solution(int start, int end, int sys_count);
-    Real get_demerits (int start, int end, int sys_count);
-    Real get_force (int start, int end, int sys_count);
-    Real get_penalty (int start, int end, int sys_count);
-    int get_max_systems (int start, int end);
-    int get_min_systems (int start, int end);
+  int max_system_count (vsize start, vsize end);
+  int min_system_count (vsize start, vsize end);
 
-    /* get the page penalty of system number sys with the given breaking */
-    Real get_page_penalty (int start, int end, int sys_count, int sys);
+private:
+  Paper_score *pscore_;
+  vsize valid_systems_;
+  vsize systems_;
+  bool ragged_right_;
+  bool ragged_last_;
 
-  private:
-    int valid_systems_;
-    int systems_;
+  /* the (i,j)th entry is the configuration for breaking between
+    columns i and j */
+  Matrix<Line_details> lines_;
 
-    /* the (i,j)th entry is the column configuration for breaking between
-     * columns i and j */
-    std::vector<Column_x_positions> cols_;
-    int cols_rank_;
+  /* the [i](j,k)th entry is the score for fitting the first k bars onto the
+    first j systems, starting at the i'th allowed starting column */
+  vector<Matrix<Constrained_break_node> > state_;
 
-    /* the [i](j,k)th entry is the score for fitting the first k bars onto the
-     * first j systems, starting at the i'th allowed starting column */
-    std::vector<std::vector<Constrained_break_node> > state_;
+  vector<vsize> start_;         /* the columns at which we might be asked to start breaking */
+  vector<vsize> starting_breakpoints_; /* the corresponding index in breaks_ */
 
-    vector<int> start_;         /* the columns at which we might be asked to start breaking */
-    vector<int> starting_breakpoints_; /* the corresponding index in breaks_ */
+  vector<Grob*> all_;
+  vector<vsize> breaks_;
 
-    vector<Grob*> all_;
-    std::vector<int> breaks_;
+  void initialize ();
+  void resize (vsize systems);
 
-    void prepare_solution (int start, int end, int sys_count, int *rank, int *brk);
+  Column_x_positions space_line (vsize start_col, vsize end_col);
+  vsize prepare_solution (vsize start, vsize end, vsize sys_count);
 
-    void combine_demerits (Column_x_positions const &, Column_x_positions const &,
-                           Real *force, Real *pen, Real *dem) const;
+  Real combine_demerits (Real force, Real prev_force);
 
-    bool calc_subproblem(int start, int systems, int max_break_index);
-    void resize ();
+  bool calc_subproblem(vsize start, vsize systems, vsize max_break_index);
 };
 #endif /* CONSTRAINED_BREAKING_HH */