]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/simple-spacer.cc
*** empty log message ***
[lilypond.git] / lily / simple-spacer.cc
index 97d0c2f14d2a79ee76dd8a8400e73d5d782bc2b6..8aab99bc4fa19410f4cd280b988055f8baa81fc2 100644 (file)
@@ -3,13 +3,13 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 1999--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1999--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 
   TODO:
   - add support for different stretch/shrink constants?
   
 */
-
+#include <stdio.h>
 #include <math.h>
 #include <libc-extension.hh>   // isinf
 
@@ -64,9 +64,9 @@ Simple_spacer::Simple_spacer ()
   */
   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
@@ -87,11 +87,11 @@ Simple_spacer::add_rod (int l, int r, Real dist)
        */
       Real total_dist = 0.;
       for (int i = l ; i < r; i++)
-       total_dist += springs_[i].ideal_f_;
+       total_dist += springs_[i].ideal_;
 
       if (total_dist < dist)
        for (int i = l ; i < r; i++)
-         springs_[i].ideal_f_ *= dist/total_dist;
+         springs_[i].ideal_ *= dist/total_dist;
 
       return;
     }
@@ -100,11 +100,11 @@ Simple_spacer::add_rod (int l, int r, Real dist)
   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
@@ -112,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;
 }
 
@@ -122,21 +122,21 @@ Simple_spacer::range_stiffness (int l, int r) const
   Real den =0.0;
   for (int i=l; i < r; i++)
     {
-      if (springs_[i].active_b_)
-       den += 1 / springs_[i].hooke_f_;
+      if (springs_[i].is_active_)
+       den += 1 / springs_[i].hooke_;
     }
 
   return 1 / den;
 }
 
 Real
-Simple_spacer::active_blocking_force () const
+Simple_spacer::is_activelocking_force () const
 {
   Real bf = - infinity_f; 
   for (int i=0; i < springs_.size (); i++)
-    if (springs_[i].active_b_)
+    if (springs_[i].is_active_)
       {
-       bf = bf >? springs_[i].block_force_f_;
+       bf = bf >? springs_[i].block_force_;
       }
   return bf;
 }
@@ -144,13 +144,7 @@ Simple_spacer::active_blocking_force () const
 Real
 Simple_spacer::active_springs_stiffness () const
 {
-  Real den = 0.0;
-  for (int i=0; i < springs_.size (); i++)
-    if (springs_[i].active_b_)
-      {
-       den += 1 / springs_[i].hooke_f_;
-      }
-  return 1/den;
+  return range_stiffness (0, springs_.size ());
 }
 
 void
@@ -158,10 +152,10 @@ Simple_spacer::set_active_states ()
 {
   /* 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_)
+    if (springs_[i].is_active_
+       && springs_[i].block_force_ >= force_)
       {
-       springs_[i].active_b_ = false;
+       springs_[i].is_active_ = false;
        active_count_ --; 
       }
 }   
@@ -171,13 +165,13 @@ 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;
 }
 
 bool
-Simple_spacer::active_b () const
+Simple_spacer::is_active () const
 {
   return active_count_; 
 }
@@ -185,14 +179,14 @@ Simple_spacer::active_b () const
 void
 Simple_spacer::my_solve_linelen ()
 {
-  while (active_b ())
+  while (is_active ())
     {
-      force_f_ = active_blocking_force ();
+      force_ = is_activelocking_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
@@ -204,11 +198,11 @@ Simple_spacer::my_solve_linelen ()
 void
 Simple_spacer::my_solve_natural_len ()
 {
-  while (active_b ())
+  while (is_active ())
     {
-      force_f_ = active_blocking_force () >? 0.0;
+      force_ = is_activelocking_force () >? 0.0;
 
-      if (force_f_ < 1e-8) // ugh.,
+      if (force_ < 1e-8) // ugh.,
        break;
       
       set_active_states ();
@@ -218,10 +212,10 @@ Simple_spacer::my_solve_natural_len ()
 void
 Simple_spacer::add_columns (Link_array<Grob> const &icols)
 {
-  Link_array<Grob> cols(icols);
+  Link_array<Grob> cols (icols);
   
   for (int i =  cols.size (); i--;)
-    if (gh_pair_p (cols[i]->get_grob_property ("between-cols")))
+    if (ly_c_pair_p (cols[i]->get_property ("between-cols")))
       {
        loose_cols_.push (cols[i]);
        cols.del (i);
@@ -232,8 +226,8 @@ Simple_spacer::add_columns (Link_array<Grob> const &icols)
     {
       Spring_smob *spring = 0;
 
-      for (SCM s = cols[i]->get_grob_property ("ideal-distances");
-          !spring && gh_pair_p (s);
+      for (SCM s = cols[i]->get_property ("ideal-distances");
+          !spring && ly_c_pair_p (s);
           s = ly_cdr (s))
        {
          Spring_smob *sp = unsmob_spring (ly_car (s));
@@ -246,36 +240,36 @@ Simple_spacer::add_columns (Link_array<Grob> const &icols)
       Spring_description desc;
       if (spring)
        {
-         desc.ideal_f_ = spring->distance_f_;
-         desc.hooke_f_ = spring->strength_f_;
+         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])
+         programming_error (_f ("No spring between column %d and next one",
+                               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 ())
+      if (!desc.is_sane ())
        {
          programming_error ("Insane spring found. Setting to unit spring.");
 
-         desc.hooke_f_ = 1.0;
-         desc.ideal_f_ = 1.0;
+         desc.hooke_ = 1.0;
+         desc.ideal_ = 1.0;
        }
 
-      if (isinf (desc.hooke_f_))
+      if (isinf (desc.hooke_))
        {
-         desc.active_b_ = false;
+         desc.is_active_ = false;
          springs_.push (desc);
        }
       else
        {
-         desc.block_force_f_ = - desc.hooke_f_ * desc.ideal_f_; // block at distance 0
+         desc.block_force_ = - desc.hooke_ * desc.ideal_; // block at distance 0
          springs_.push (desc);
       
          active_count_ ++;
@@ -291,59 +285,81 @@ Simple_spacer::add_columns (Link_array<Grob> const &icols)
   for (int i=0; i < cols.size () - 1; i++)
     {
       for (SCM s = Spaceable_grob::get_minimum_distances (cols[i]);
-          gh_pair_p (s); s = ly_cdr (s))
+          ly_c_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)));
+             add_rod (i, oi, ly_scm2double (ly_cdar (s)));
            }
        }
     }
-
-  /*
-    TODO: should support natural length on only the last line.
-   */
-  if (line_len_f_ < 0)
-    my_solve_natural_len ();
-  else
-    my_solve_linelen ();
 }
 
-#include <stdio.h>
+/*
+  
+  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, bool ragged) const
+Simple_spacer::solve (Column_x_positions *positions, bool ragged) 
 {
-  positions->force_f_ = force_f_;
-  if ((force_f_ < 0))
-    {
-
-      /*
-       We used to have a penalty for compression, no matter what, but that
-       fucked up wtk1-fugue2 (taking 3 full pages.)
+  if (ragged)
+    my_solve_natural_len ();
+  else
+    my_solve_linelen ();
 
-       maybe this should be tunable?
-       */
-      if (compression_penalty_b_)
-       ; //    positions->force_f_ *= 2; //  hmm.
-    }
+  positions->force_ = force_;
   
-  positions->config_.push (indent_f_);
+  /*
+    We used to have a penalty for compression, no matter what, but that
+    fucked up wtk1-fugue2 (taking 3 full pages.)
+  */
+  positions->config_.push (indent_);
   for (int i=0; i <springs_.size (); i++)
     {
-      Real  l = springs_[i].length ((ragged) ? 0.0 : 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 
       */
     }
+
+  /*
+    For raggedright, we must have a measure of music density: this is
+    to prevent lots of short lines (which all have force = 0).
+    */
+  if (ragged)
+    {
+      Real len = positions->config_.top ();
+      if (line_len_ - len  >= 0)
+       positions->force_ = ((line_len_ - len) *  active_springs_stiffness ());
+      else
+       {
+         positions->force_ = 0.0;
+         /*
+           Don't go past end-of-line in ragged right.
+          */
+         positions->satisfies_constraints_ = false;
+       }
+    }
+
+
   positions->cols_ = spaced_cols_;
   positions->loose_cols_ = loose_cols_;
-  
-  positions->satisfies_constraints_b_ = (line_len_f_ < 0) || active_b ();
-
+  positions->satisfies_constraints_ =
+    positions->satisfies_constraints_ && is_active ();
 
   /*
     Check if breaking constraints are met.
@@ -352,45 +368,42 @@ Simple_spacer::solve (Column_x_positions *positions, bool ragged) const
   int sz =  positions->cols_.size ();
   for (int i = sz; i--; )
     {
-      SCM p = positions->cols_[i]->get_grob_property( "penalty");
-      if (gh_number_p (p))
+      SCM p = positions->cols_[i]->get_property ( "penalty");
+      if (ly_c_number_p (p))
        {
-         if (gh_scm2double (p) < -9999)
+         if (ly_scm2double (p) < -9999)
            break_satisfy = break_satisfy && (i == 0 || i == sz -1);
-         if (gh_scm2double (p) > 9999)
+         if (ly_scm2double (p) > 9999)
            break_satisfy = break_satisfy && !(i == 0 || i == sz -1);
        }
       
     }
 
-  positions->satisfies_constraints_b_ =
-    positions->satisfies_constraints_b_ && break_satisfy;
-
-  if (ragged && force_f_ < 0)
-    positions->satisfies_constraints_b_ = false;
+  positions->satisfies_constraints_ =
+    positions->satisfies_constraints_ && break_satisfy;
 }
 
 /****************************************************************/
 
 Spring_description::Spring_description ()
 {
-  ideal_f_ =0.0;
-  hooke_f_ =0.0;
-  active_b_ = true;
-  block_force_f_ = 0.0;
+  ideal_ =0.0;
+  hooke_ =0.0;
+  is_active_ = true;
+  block_force_ = 0.0;
 }
 
 
 bool
-Spring_description::sane_b () const
+Spring_description::is_sane () 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_f_;
-  return ideal_f_ + f / hooke_f_ ;
+  if (!is_active_)
+    f = block_force_;
+  return ideal_ + f / hooke_ ;
 }