]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/gourlay-breaking.cc
release: 1.3.0
[lilypond.git] / lily / gourlay-breaking.cc
index 05c2a722b3236495373bca231ad29ff409aec07f..0e0ea46f4be98c6b524783f5ed5fdbb91e5e7259 100644 (file)
@@ -3,18 +3,21 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
+  (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 #include "gourlay-breaking.hh"
-#include "colhpos.hh"
-#include "spring-spacer.hh"
+#include "column-x-positions.hh"
 #include "debug.hh"
-#include "p-col.hh"
-#include "p-score.hh"
+#include "paper-column.hh"
+#include "paper-score.hh"
 #include "paper-def.hh"
+#include "simple-spacer.hh"
 
-const HAPPY_DOTS_I = 3;
+#include "killing-cons.tcc"
+
+/// How often to print operator pacification marks?
+const int HAPPY_DOTS_I = 3;
 
 /**
   Helper to trace back an optimal path 
@@ -25,154 +28,129 @@ struct Break_node {
     
     */
   int prev_break_i_;
+  /**
+     Which system number so far?
+   */
   int line_i_;
-  Real energy_f_;
-  Col_hpositions line_config_;
+
+  Real demerits_f_;
+  Column_x_positions line_config_;
+  
   Break_node () 
   {
     prev_break_i_ = -1;
     line_i_ = 0;
+    demerits_f_ = 0;
   }
 };
 
 /**
-  This algorithms is adapted from 
+  This algorithms is adapted from the OSU Tech report on breaking lines.
  */
-
-Array<Col_hpositions>
+Array<Column_x_positions>
 Gourlay_breaking::do_solve () const
 {
   Array<Break_node> optimal_paths;
-  Line_of_cols all = all_cols ();
+  Line_of_cols all = pscore_l_->col_l_arr_ ;
   Array<int> breaks = find_break_indices ();
   
   optimal_paths.set_size (breaks.size ());
 
   Break_node first_node ;
-  first_node.prev_break_i_ = -1;
-  first_node.line_config_.energy_f_ = 0;
-  first_node.line_i_ = 0;
+  first_node.line_config_.energy_f_ = 0;  
   
   optimal_paths[0] = first_node; 
   int break_idx=1;
 
-  
   for (; break_idx< breaks.size (); break_idx++) 
     {
-      Array<int> candidates;
-      Array<Col_hpositions> candidate_lines;
-      Pointer_list<Line_spacer*> spacer_p_list;
-       
       /*
        start with a short line, add measures. At some point 
        the line becomes infeasible. Then we don't try to add more 
        */
+      int minimal_start_idx = -1;
+      Column_x_positions minimal_sol;
+      Column_x_positions backup_sol;
+      
+      Real minimal_demerits = infinity_f;
+
       for (int start_idx = break_idx; start_idx--;)
        {
-         if  (break_idx - start_idx > max_measures_i_) 
-           break;
-
-         if (optimal_paths[start_idx].prev_break_i_ < 0
-             && optimal_paths[start_idx].line_config_.energy_f_)
-               
-           continue;
-           
          Line_of_cols line = all.slice (breaks[start_idx], breaks[break_idx]+1);
-
-         line[0] = line[0]->postbreak_l ();
-         line.top () = line.top ()->prebreak_l ();
+  
+         line[0] = dynamic_cast<Paper_column*>(line[0]->find_broken_piece (RIGHT));
+         line.top () =  dynamic_cast<Paper_column*>(line.top ()->find_broken_piece (LEFT));
            
-         if (!feasible (line))
+         Column_x_positions cp;
+         cp.cols_ = line;
+
+         Interval line_dims
+           = pscore_l_->paper_l_->line_dimensions_int (optimal_paths[start_idx].line_i_);
+         Simple_spacer * sp = generate_spacing_problem (line, line_dims);
+         sp->solve (&cp);
+         delete sp;
+
+         if (start_idx == break_idx - 1)
+           backup_sol = cp;    // in case everything fucks up
+         if (!cp.satisfies_constraints_b_)
            break;
-           
-         Col_hpositions approx;
-         approx.cols = line;
-           
-         approx.spacer_l_ = generate_spacing_problem (line, 
-           pscore_l_->paper_l_->line_dimensions_int (optimal_paths[start_idx].line_i_));
-         spacer_p_list.bottom ().add (approx.spacer_l_);
-
-         ( (Break_algorithm*)this)->approx_stats_.add (approx.cols);
-         approx.approximate_solve_line ();
-           
-         if  (approx.energy_f_  > energy_bound_f_)
-           {
-             continue;
-           }
-
-           
-         // this is a likely candidate. Store it.
-         candidate_lines.push (approx);
-         candidates.push (start_idx);
-       }
 
-           
-      int minimal_j = -1;
-      Real minimal_energy = infinity_f;
-      for (int j=0; j < candidates.size (); j++) 
-       {
-         int start = candidates[j];
-         if (optimal_paths[start].line_config_.energy_f_
-              + candidate_lines[j].energy_f_  > minimal_energy)
-               
-           continue;
+         
+         Real this_demerits;
+         if (optimal_paths[start_idx].demerits_f_ >= infinity_f)
+           this_demerits = infinity_f;
+         else
+           this_demerits = combine_demerits (optimal_paths[start_idx].line_config_, cp)
+             + optimal_paths[start_idx].demerits_f_;
 
-         if (!candidate_lines[j].satisfies_constraints_b_) 
-           {
-             candidate_lines[j].solve_line ();
-             ( (Break_algorithm*)this)->exact_stats_.add (candidate_lines[j].cols);
-           }
-           
-         Real this_energy 
-           = optimal_paths[start].line_config_.energy_f_ 
-           + candidate_lines[j].energy_f_ ;
-           
-         if (this_energy < minimal_energy) 
+         if (this_demerits < minimal_demerits) 
            {
-             minimal_j = j;
-             minimal_energy = this_energy;
+             minimal_start_idx = start_idx;
+             minimal_sol = cp;
+             minimal_demerits = this_demerits;
            }
        }
 
-      if (minimal_j < 0) 
+      int prev =break_idx - 1;
+      if (minimal_start_idx < 0) 
        {
-         optimal_paths[break_idx].prev_break_i_ = -1;
-         optimal_paths[break_idx].line_config_.energy_f_ = infinity_f;
+         optimal_paths[break_idx].demerits_f_ = infinity_f;
+         optimal_paths[break_idx].line_config_ = backup_sol;     
        }
       else 
        {
-         optimal_paths[break_idx].prev_break_i_ = candidates[minimal_j];
-         optimal_paths[break_idx].line_config_ = candidate_lines[minimal_j];
-         optimal_paths[break_idx].line_i_ = 
-           optimal_paths[optimal_paths[break_idx].prev_break_i_].line_i_ + 1;
+         prev = minimal_start_idx;
+         optimal_paths[break_idx].line_config_ = minimal_sol;
+         optimal_paths[break_idx].demerits_f_ = minimal_demerits;
        }
+      optimal_paths[break_idx].prev_break_i_ = prev;
+      optimal_paths[break_idx].line_i_ = optimal_paths[prev].line_i_ + 1;
 
       if (! (break_idx % HAPPY_DOTS_I))
-       *mlog << "[" << break_idx << "]"<<flush;
+       *mlog << "[" << break_idx << "]" << flush;
     }
 
+  /* do the last one */
   if  (break_idx % HAPPY_DOTS_I) 
-    *mlog << "[" << break_idx << "]"<<flush;
+    *mlog << "[" << break_idx << "]";
 
-  Array<int> final_breaks;
+  *mlog << endl;
 
-  Array<Col_hpositions> lines;
+  Array<int> final_breaks;
+  Array<Column_x_positions> lines;
 
   /* skip 0-th element, since it is a "dummy" elt*/
   for (int i = optimal_paths.size ()-1; i> 0;) 
     {
       final_breaks.push (i);
-      assert (i > optimal_paths[i].prev_break_i_);
-
-      // there was no "feasible path"
-      if (!optimal_paths[i].line_config_.config.size ()) {
-       final_breaks.set_size (0);
-       break;
-      }
-      i = optimal_paths[i].prev_break_i_;
+      int prev = optimal_paths[i].prev_break_i_;
+      assert (i > prev);
+      i = prev;
     }
 
-
+  if (optimal_paths.top ().demerits_f_ >= infinity_f)
+    warning (_ ("No feasible line breaking found"));
+  
   for (int i= final_breaks.size (); i--;) 
     lines.push (optimal_paths[final_breaks[i]].line_config_);
   
@@ -182,7 +160,6 @@ Gourlay_breaking::do_solve () const
 
 Gourlay_breaking::Gourlay_breaking ()
 {
-  get_line_spacer = Spring_spacer::constructor;
   energy_bound_f_ = infinity_f;
   max_measures_i_ = INT_MAX;
 }
@@ -190,7 +167,28 @@ Gourlay_breaking::Gourlay_breaking ()
 void
 Gourlay_breaking::do_set_pscore ()
 {
-  energy_bound_f_ = pscore_l_->paper_l_->get_var ("gourlay_energybound");
   max_measures_i_ =int (rint (pscore_l_->paper_l_->get_var ("gourlay_maxmeasures")));
 }
 
+
+/*
+  TODO: uniformity parameter to control rel. importance of spacing differences.
+ */
+Real
+Gourlay_breaking::combine_demerits (Column_x_positions const &prev,
+                                   Column_x_positions const &this_one) const
+{
+  Real break_penalties = 0.0;
+  Paper_column * pc = this_one.cols_.top ();
+  if (pc->original_l_)
+    {
+      SCM pen = pc->get_elt_property (penalty_scm_sym);
+      if (pen != SCM_BOOL_F)
+       {
+         break_penalties += gh_scm2double (SCM_CDR(pen));
+       }
+    }
+
+  return abs (this_one.force_f_) + abs (prev.force_f_ - this_one.force_f_)
+    + break_penalties;
+}