]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/simple-spacer.cc
* VERSION (MY_PATCH_LEVEL): make 1.7.0
[lilypond.git] / lily / simple-spacer.cc
index f6052dd08c78cff71dd7b4908a84cd5a595387a3..aa6269be08087d869d625dd96c44a0a8b44f81c4 100644 (file)
@@ -9,7 +9,7 @@
   - add support for different stretch/shrink constants?
   
 */
-
+#include <stdio.h>
 #include <math.h>
 #include <libc-extension.hh>   // isinf
 
 #include "spaceable-grob.hh"
 #include "dimensions.hh"
 
+
+/*
+   A simple spacing constraint solver. The approach:
+
+   Stretch the line uniformly until none of the constraints (rods)
+   block.  It then is very wide.
+
+      Compress until the next constraint blocks,
+
+      Mark the springs over the constrained part to be non-active.
+      
+   Repeat with the smaller set of non-active constraints, until all
+   constraints blocked, or until the line is as short as desired.
+
+   This is much simpler, and much much faster than full scale
+   Constrained QP. On the other hand, a situation like this will not
+   be typeset as dense as possible, because
+
+   c4                   c4           c4                  c4
+   veryveryverylongsyllable2         veryveryverylongsyllable2
+   " "4                 veryveryverylongsyllable2        syllable4
+
+
+   can be further compressed to
+
+
+   c4    c4                        c4   c4
+   veryveryverylongsyllable2       veryveryverylongsyllable2
+   " "4  veryveryverylongsyllable2      syllable4
+
+
+   Perhaps this is not a bad thing, because the 1st looks better anyway.  */
+
+
 Simple_spacer::Simple_spacer ()
 {
+  /*
+    Give an extra penalty for compression. Needed to avoid compressing
+    tightly spaced lines.
+  */
+  compression_penalty_b_ = false;
   active_count_ = 0;
-  force_f_ = 0.;
-  indent_f_ =0.0;
-  default_space_f_ = 20 PT;
+  force_ = 0.;
+  indent_ =0.0;
+  default_space_ = 20 PT;
 }
 
 void
@@ -38,18 +77,34 @@ Simple_spacer::add_rod (int l, int r, Real dist)
       programming_error ("Weird minimum distance. Ignoring");
       return;
     }
-  
-  
+
   Real c = range_stiffness (l,r);
+  if (isinf (c))
+    {
+      /*
+       If a spring is fixed, we have to do something here:
+       we let the rod override the spring. 
+       */
+      Real total_dist = 0.;
+      for (int i = l ; i < r; i++)
+       total_dist += springs_[i].ideal_;
+
+      if (total_dist < dist)
+       for (int i = l ; i < r; i++)
+         springs_[i].ideal_ *= dist/total_dist;
+
+      return;
+    }
+  
   Real d = range_ideal_len (l,r);
   Real block_stretch = dist - d;
   
   Real block_force = c * block_stretch;
-  force_f_ = force_f_ >? block_force;
+  force_ = force_ >? block_force;
 
   for (int i=l; i < r; i++)
-    springs_[i].block_force_f_ = block_force >?
-      springs_[i].block_force_f_ ;
+    springs_[i].block_force_ = block_force >?
+      springs_[i].block_force_ ;
 }
 
 Real
@@ -57,7 +112,7 @@ Simple_spacer::range_ideal_len (int l, int r)   const
 {
   Real d =0.;
   for (int i=l; i < r; i++)
-    d += springs_[i].ideal_f_;
+    d += springs_[i].ideal_;
   return d;
 }
 
@@ -66,7 +121,10 @@ Simple_spacer::range_stiffness (int l, int r) const
 {
   Real den =0.0;
   for (int i=l; i < r; i++)
-    den += 1 / springs_[i].hooke_f_;
+    {
+      if (springs_[i].active_b_)
+       den += 1 / springs_[i].hooke_;
+    }
 
   return 1 / den;
 }
@@ -78,7 +136,7 @@ Simple_spacer::active_blocking_force () const
   for (int i=0; i < springs_.size (); i++)
     if (springs_[i].active_b_)
       {
-       bf = bf >? springs_[i].block_force_f_;
+       bf = bf >? springs_[i].block_force_;
       }
   return bf;
 }
@@ -90,7 +148,7 @@ Simple_spacer::active_springs_stiffness () const
   for (int i=0; i < springs_.size (); i++)
     if (springs_[i].active_b_)
       {
-       den += 1 / springs_[i].hooke_f_;
+       den += 1 / springs_[i].hooke_;
       }
   return 1/den;
 }
@@ -98,11 +156,10 @@ Simple_spacer::active_springs_stiffness () const
 void
 Simple_spacer::set_active_states ()
 {
-  // safe, since
-  // force is only copied.
+  /* float comparison is safe, since force is only copied.  */
   for (int i=0 ; i <springs_.size (); i++)
     if (springs_[i].active_b_
-       && springs_[i].block_force_f_ >= force_f_)
+       && springs_[i].block_force_ >= force_)
       {
        springs_[i].active_b_ = false;
        active_count_ --; 
@@ -114,19 +171,11 @@ Simple_spacer::configuration_length () const
 {
   Real l =0.;
   for (int i=0; i < springs_.size (); i++)
-    l += springs_[i].length (force_f_);
+    l += springs_[i].length (force_);
 
   return l;
 }
 
-Real
-Spring_description::length (Real f) const
-{
-  if (!active_b_)
-    f = block_force_f_;
-  return ideal_f_ + f / hooke_f_ ;
-}
-
 bool
 Simple_spacer::active_b () const
 {
@@ -138,12 +187,12 @@ Simple_spacer::my_solve_linelen ()
 {
   while (active_b ())
     {
-      force_f_ = active_blocking_force ();
+      force_ = active_blocking_force ();
       Real conf = configuration_length ();
 
-      if (conf < line_len_f_)
+      if (conf < line_len_)
        {
-         force_f_ += (line_len_f_  - conf) * active_springs_stiffness ();
+         force_ += (line_len_  - conf) * active_springs_stiffness ();
          break;
        }
       else
@@ -157,9 +206,9 @@ Simple_spacer::my_solve_natural_len ()
 {
   while (active_b ())
     {
-      force_f_ = active_blocking_force () >? 0.0;
+      force_ = active_blocking_force () >? 0.0;
 
-      if (force_f_ < 1e-8) // ugh.,
+      if (force_ < 1e-8) // ugh.,
        break;
       
       set_active_states ();
@@ -167,8 +216,10 @@ Simple_spacer::my_solve_natural_len ()
 }
 
 void
-Simple_spacer::add_columns (Link_array<Grob> cols)
+Simple_spacer::add_columns (Link_array<Grob> const &icols)
 {
+  Link_array<Grob> cols(icols);
+  
   for (int i =  cols.size (); i--;)
     if (gh_pair_p (cols[i]->get_grob_property ("between-cols")))
       {
@@ -179,46 +230,62 @@ Simple_spacer::add_columns (Link_array<Grob> cols)
   spaced_cols_ = cols;
   for (int i=0; i < cols.size () - 1; i++)
     {
-      SCM spring_params = SCM_EOL;
+      Spring_smob *spring = 0;
+
       for (SCM s = cols[i]->get_grob_property ("ideal-distances");
-          !gh_pair_p (spring_params) && gh_pair_p (s);
+          !spring && gh_pair_p (s);
           s = ly_cdr (s))
        {
-         Grob *other = unsmob_grob (ly_caar (s));
-         if (other != cols[i+1])
-           continue;
-
-         spring_params = ly_cdar (s);
+         Spring_smob *sp = unsmob_spring (ly_car (s));
+         
+         
+         if (sp->other_ == cols[i+1])
+           spring = sp;
        }
 
       Spring_description desc;
-      if (gh_pair_p (spring_params))
+      if (spring)
        {
-         desc.ideal_f_ = gh_scm2double (ly_car (spring_params));
-         desc.hooke_f_ = gh_scm2double (ly_cdr (spring_params));
+         desc.ideal_ = spring->distance_;
+         desc.hooke_ = spring->strength_;
        }
       else
        {
          programming_error (_f("No spring between column %d and next one",
-                               Paper_column::rank_i (cols[i])
+                               Paper_column::get_rank (cols[i])
                                ));
-         desc.hooke_f_ = 1.0;
-         desc.ideal_f_ = default_space_f_;
+         desc.hooke_ = 1.0;
+         desc.ideal_ = default_space_;
+
+         continue;
        }
 
       if (!desc.sane_b ())
        {
          programming_error ("Insane spring found. Setting to unit spring.");
 
-         cout << "columns " << Paper_column::rank_i (cols[i])
-              << " " << Paper_column::rank_i (cols[i+1]) << endl;
-         desc.hooke_f_ = 1.0;
-         desc.ideal_f_ = 1.0;
+         desc.hooke_ = 1.0;
+         desc.ideal_ = 1.0;
+       }
+
+      if (isinf (desc.hooke_))
+       {
+         desc.active_b_ = false;
+         springs_.push (desc);
+       }
+      else
+       {
+         desc.block_force_ = - desc.hooke_ * desc.ideal_; // block at distance 0
+         springs_.push (desc);
+      
+         active_count_ ++;
+       }
+
+      if (spring->expand_only_b_)
+       {
+         compression_penalty_b_ = true;
        }
       
-      desc.block_force_f_ = - desc.hooke_f_ * desc.ideal_f_; // block at distance 0
-      springs_.push (desc);
-      active_count_ ++;
     }
   
   for (int i=0; i < cols.size () - 1; i++)
@@ -227,7 +294,7 @@ Simple_spacer::add_columns (Link_array<Grob> cols)
           gh_pair_p (s); s = ly_cdr (s))
        {
          Grob * other = unsmob_grob (ly_caar (s));
-         int oi = cols.find_i (other);
+         int oi = cols.find_index (other);
          if (oi >= 0)
            {
              add_rod (i, oi, gh_scm2double (ly_cdar (s)));
@@ -238,26 +305,57 @@ Simple_spacer::add_columns (Link_array<Grob> cols)
   /*
     TODO: should support natural length on only the last line.
    */
-  if (line_len_f_ < 0)
+  if (line_len_ < 0)
     my_solve_natural_len ();
   else
     my_solve_linelen ();
 }
 
+/*
+  
+  TODO: should a add penalty for widely varying spring forces (caused
+  by constraints, eg.
+
+
+         =====  
+         |   |
+  o|o|  x ##x
+
+
+  The ## forces the notes apart; we shouldn't allow the O's to touch
+  this closely.
+  
+ */
 void
-Simple_spacer::solve (Column_x_positions *positions) const
+Simple_spacer::solve (Column_x_positions *positions, bool ragged) const
 {
-  positions->force_f_ = force_f_;
+  positions->force_ = force_;
+  if ((force_ < 0))
+    {
+
+      /*
+       We used to have a penalty for compression, no matter what, but that
+       fucked up wtk1-fugue2 (taking 3 full pages.)
+
+       maybe this should be tunable?
+       */
+      if (compression_penalty_b_)
+       ; //    positions->force_ *= 2; //  hmm.
+    }
   
-  positions->config_.push (indent_f_);
+  positions->config_.push (indent_);
   for (int i=0; i <springs_.size (); i++)
     {
-      positions->config_.push (positions->config_.top () + springs_[i].length (force_f_));
+      Real  l = springs_[i].length ((ragged) ? 0.0 : force_);
+      positions->config_.push (positions->config_.top () + l);
+      /*
+       we have l>= 0 here, up to rounding errors 
+      */
     }
   positions->cols_ = spaced_cols_;
   positions->loose_cols_ = loose_cols_;
   
-  positions->satisfies_constraints_b_ = (line_len_f_ < 0) || active_b ();
+  positions->satisfies_constraints_b_ = (line_len_ < 0) || active_b ();
 
 
   /*
@@ -280,26 +378,32 @@ Simple_spacer::solve (Column_x_positions *positions) const
 
   positions->satisfies_constraints_b_ =
     positions->satisfies_constraints_b_ && break_satisfy;
-}
-
-
-
 
+  if (ragged && force_ < 0)
+    positions->satisfies_constraints_b_ = false;
+}
 
+/****************************************************************/
 
 Spring_description::Spring_description ()
 {
-  ideal_f_ =0.0;
-  hooke_f_ =0.0;
+  ideal_ =0.0;
+  hooke_ =0.0;
   active_b_ = true;
-  block_force_f_ = 0.0;
+  block_force_ = 0.0;
 }
 
 
 bool
 Spring_description::sane_b () const
 {
-  return (hooke_f_ > 0) &&  ! isinf (ideal_f_) && !isnan (ideal_f_);
+  return (hooke_ > 0) &&  !isinf (ideal_) && !isnan (ideal_);
 }
 
-
+Real
+Spring_description::length (Real f) const
+{
+  if (!active_b_)
+    f = block_force_;
+  return ideal_ + f / hooke_ ;
+}