]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/simple-spacer.cc
*** empty log message ***
[lilypond.git] / lily / simple-spacer.cc
index be05115a6dda560bf32aae8b4e085e5fa1ce4f4b..a7fd8a7680a141835c51ad8a10167a4e12f19112 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
 
@@ -62,11 +62,10 @@ 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
@@ -87,11 +86,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 +99,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 +111,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,8 +121,8 @@ 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;
@@ -134,9 +133,9 @@ Simple_spacer::active_blocking_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 +143,28 @@ 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;
+  Real  stiff =  range_stiffness (0, springs_.size ());
+  if (isinf (stiff))
+    {
+      /*
+       all springs are inactive. Take the stiffness of the
+       latest spring to block.
+       */
+
+      Real max_block_force = -infinity_f;
+      int max_i = -1;
+      for (int i=0; i < springs_.size (); i++)
+       {
+         if (springs_[i].block_force_ > max_block_force)
+           {
+             max_i = i;
+             max_block_force = springs_[i].block_force_;
+           }
+       }
+
+      stiff = springs_[max_i].hooke_;   
+    }
+  return stiff;
 }
 
 void
@@ -158,10 +172,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 +185,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 +199,14 @@ Simple_spacer::active_b () const
 void
 Simple_spacer::my_solve_linelen ()
 {
-  while (active_b ())
+  while (is_active ())
     {
-      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
@@ -204,150 +218,191 @@ 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_ = active_blocking_force () >? 0.0;
 
-      if (force_f_ < 1e-8) // ugh.,
+      if (force_ < 1e-8) // ugh.,
        break;
       
       set_active_states ();
     }
 }
 
-void
-Simple_spacer::add_columns (Link_array<Grob> cols)
+LY_DEFINE(ly_solve_spring_rod_problem, "ly:solve-spring-rod-problem",
+         4, 1, 0, (SCM springs, SCM rods, SCM length, SCM ragged),
+         "Solve a spring and rod problem for @var{count} objects, that "
+         "are connected by @var{count-1} springs, and an arbitrary number of rods "
+         "Springs have the format (ideal, hooke) and rods (idx1, idx2, distance) "
+         "@var{length} is a number, @var{ragged} a boolean "
+         "Return: a list containing the force (#f for non-satisfied constraints) "
+         "followed by the @var{spring-count}+1 positions of the objects. "
+         )
 {
-  for (int i =  cols.size (); i--;)
-    if (gh_pair_p (cols[i]->get_grob_property ("between-cols")))
-      {
-       loose_cols_.push (cols[i]);
-       cols.del (i);
-      }
+  int len = scm_ilength (springs);
+  if (len == 0)
+    return scm_list_2 (scm_from_double (0.0), scm_from_double (0.0));
   
-  spaced_cols_ = cols;
-  for (int i=0; i < cols.size () - 1; i++)
-    {
-      Spring_smob *spring = 0;
-
-      for (SCM s = cols[i]->get_grob_property ("ideal-distances");
-          !spring && gh_pair_p (s);
-          s = ly_cdr (s))
-       {
-         Spring_smob *sp = unsmob_spring (ly_car (s));
-         
-         
-         if (sp->other_ == cols[i+1])
-           spring = sp;
-       }
+  SCM_ASSERT_TYPE (len >= 0, springs, SCM_ARG1, __FUNCTION__, "list of springs");
+  SCM_ASSERT_TYPE (scm_ilength (rods) >= 0, rods, SCM_ARG2, __FUNCTION__, "list of rods");
+  SCM_ASSERT_TYPE (scm_is_number (length) || length == SCM_BOOL_F,
+                  length, SCM_ARG3, __FUNCTION__, "number or #f");
 
-      Spring_description desc;
-      if (spring)
-       {
-         desc.ideal_f_ = spring->distance_f_;
-         desc.hooke_f_ = spring->strength_f_;
-       }
-      else
-       {
-         programming_error (_f("No spring between column %d and next one",
-                               Paper_column::rank_i (cols[i])
-                               ));
-         desc.hooke_f_ = 1.0;
-         desc.ideal_f_ = default_space_f_;
 
-         continue;
-       }
-
-      if (!desc.sane_b ())
-       {
-         programming_error ("Insane spring found. Setting to unit spring.");
+  bool is_ragged   = ragged == SCM_BOOL_T; 
+  Simple_spacer spacer; 
+  for (SCM s = springs; ly_c_pair_p (s); s = ly_cdr (s))
+    {
+      Real ideal = scm_to_double (ly_caar (s));
+      Real hooke = scm_to_double (ly_cadar (s));
 
-         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;
-       }
+      spacer.add_spring (ideal, hooke);
+    }
 
-      if (isinf (desc.hooke_f_))
-       {
-         desc.active_b_ = false;
-         springs_.push (desc);
-       }
-      else
-       {
-         desc.block_force_f_ = - desc.hooke_f_ * desc.ideal_f_; // block at distance 0
-         springs_.push (desc);
+  for (SCM s = rods; ly_c_pair_p (s); s = ly_cdr (s))
+    {
+      SCM entry = ly_car (s);
+      int l = scm_to_int (ly_car (entry));
+      int r = scm_to_int (ly_cadr (entry));
+      entry = ly_cddr (entry);
       
-         active_count_ ++;
-       }
+      Real distance = scm_to_double (ly_car (entry));
+      spacer.add_rod (l, r, distance);
+    }
 
-      if (spring->expand_only_b_)
-       {
-         compression_penalty_b_ = true;
-       }
+  spacer.line_len_ = scm_to_double (length);
       
+  if (is_ragged)
+    spacer.my_solve_natural_len ();
+  else
+    spacer.my_solve_linelen ();
+
+  Array<Real> posns;
+  posns.push (0.0);
+  for (int i = 0; i < spacer.springs_.size(); i++)
+    {
+      Real l = spacer.springs_[i].length ((is_ragged) ? 0.0 : spacer.force_);
+      posns.push (posns.top() + l);
+    }
+
+  SCM force_return = SCM_BOOL_F;
+  if (is_ragged)
+    {
+      Real len = posns.top ();
+      if (spacer.line_len_ - len  >= 0)
+       force_return  = scm_from_double ((spacer.line_len_ - len)
+                                        * spacer.active_springs_stiffness ());
+    }
+  else if (not isinf (spacer.force_)
+          && spacer.is_active ())
+    {
+      force_return = scm_from_double (spacer.force_);
     }
   
-  for (int i=0; i < cols.size () - 1; i++)
+  SCM retval= SCM_EOL;
+  for (int i = posns.size(); i--;)
     {
-      for (SCM s = Spaceable_grob::get_minimum_distances (cols[i]);
-          gh_pair_p (s); s = ly_cdr (s))
-       {
-         Grob * other = unsmob_grob (ly_caar (s));
-         int oi = cols.find_i (other);
-         if (oi >= 0)
-           {
-             add_rod (i, oi, gh_scm2double (ly_cdar (s)));
-           }
-       }
+      retval = scm_cons (scm_from_double (posns[i]), retval); 
     }
 
-  /*
-    TODO: should support natural length on only the last line.
-   */
-  if (line_len_f_ < 0)
-    my_solve_natural_len ();
-  else
-    my_solve_linelen ();
+  retval = scm_cons (force_return, retval);
+  return retval;  
 }
+         
+         
+/****************************************************************/
 
-#include <stdio.h>
+Spring_description::Spring_description ()
+{
+  ideal_ =0.0;
+  hooke_ =0.0;
+  is_active_ = true;
+  block_force_ = 0.0;
+}
+
+
+bool
+Spring_description::is_sane () const
+{
+  return (hooke_ > 0)
+    && ideal_ > 0
+    && !isinf (ideal_) && !isnan (ideal_);
+}
 
+Real
+Spring_description::length (Real f) const
+{
+  if (!is_active_)
+    f = block_force_;
+  return ideal_ + f / hooke_ ;
+}
+/****************************************************************/
+
+
+/*
+  
+  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_wrapper::solve (Column_x_positions *positions, bool ragged) 
 {
-  positions->force_f_ = force_f_;
-  if ((force_f_ < 0))
-    {
+  if (ragged)
+    spacer_->my_solve_natural_len ();
+  else
+    spacer_->my_solve_linelen ();
 
+  positions->force_ = spacer_->force_;
+  
+  /*
+    We used to have a penalty for compression, no matter what, but that
+    fucked up wtk1-fugue2 (taking 3 full pages.)
+  */
+  positions->config_.push (spacer_->indent_);
+  for (int i=0; i < spacer_->springs_.size (); i++)
+    {
+      Real  l = spacer_->springs_[i].length ((ragged) ? 0.0 : spacer_->force_);
+      positions->config_.push (positions->config_.top () + l);
       /*
-       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_f_ *= 2; //  hmm.
+       we have l>= 0 here, up to rounding errors 
+      */
     }
-  
-  positions->config_.push (indent_f_);
-  for (int i=0; i <springs_.size (); i++)
+
+  /*
+    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)
     {
-      if (ragged)
-        {
-         // ragged right operation: do not apply any force
-         positions->config_.push (positions->config_.top () + springs_[i].length (0.0));
-       }
+      Real len = positions->config_.top ();
+      if (spacer_->line_len_ - len  >= 0)
+       positions->force_ = ((spacer_->line_len_ - len)
+                            * spacer_->active_springs_stiffness ());
       else
-        {
-         positions->config_.push (positions->config_.top () + springs_[i].length (force_f_));
+       {
+         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_ && spacer_->is_active ();
 
   /*
     Check if breaking constraints are met.
@@ -356,42 +411,117 @@ 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;
+  positions->satisfies_constraints_ =
+    positions->satisfies_constraints_ && break_satisfy;
 }
 
-/****************************************************************/
+void
+Simple_spacer::add_spring (Real ideal, Real hooke)
+{
+  Spring_description desc;
 
-Spring_description::Spring_description ()
+  desc.ideal_ = ideal;
+  desc.hooke_ = hooke;
+  if (!desc.is_sane ())
+    {
+      programming_error ("Insane spring found. Setting to unit spring.");
+
+      desc.hooke_ = 1.0;
+      desc.ideal_ = 1.0;
+    }
+  
+  if (isinf (hooke))
+    {
+      desc.is_active_ = false;
+    }
+  else
+    {
+      /*
+       desc.is_active_ ? 
+      */
+      desc.block_force_ = - desc.hooke_ * desc.ideal_; // block at distance 0
+      
+      active_count_ ++;
+    }
+  springs_.push (desc);
+}
+
+void
+Simple_spacer_wrapper::add_columns (Link_array<Grob> const &icols)
 {
-  ideal_f_ =0.0;
-  hooke_f_ =0.0;
-  active_b_ = true;
-  block_force_f_ = 0.0;
+  Link_array<Grob> cols (icols);
+  
+  for (int i =  cols.size (); i--;)
+    if (ly_c_pair_p (cols[i]->get_property ("between-cols")))
+      {
+       loose_cols_.push (cols[i]);
+       cols.del (i);
+      }
+  
+  spaced_cols_ = cols;
+  for (int i=0; i < cols.size () - 1; i++)
+    {
+      Spring_smob *spring = 0;
+
+      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));
+         
+         
+         if (sp->other_ == cols[i+1])
+           spring = sp;
+       }
+
+      if (!spring)
+       programming_error (_f ("No spring between column %d and next one",
+                              Paper_column::get_rank (cols[i])
+                              ));
+
+      Real ideal = (spring) ? spring->distance_ : spacer_->default_space_;
+      Real hooke = (spring) ? spring->strength_ : 1.0;
+       
+      spacer_->add_spring (ideal, hooke);
+    }
+  
+  for (int i=0; i < cols.size () - 1; i++)
+    {
+      for (SCM s = Spaceable_grob::get_minimum_distances (cols[i]);
+          ly_c_pair_p (s); s = ly_cdr (s))
+       {
+         Grob * other = unsmob_grob (ly_caar (s));
+         int oi = cols.find_index (other);
+         if (oi >= 0)
+           {
+             spacer_->add_rod (i, oi, ly_scm2double (ly_cdar (s)));
+           }
+       }
+    }
 }
 
+Simple_spacer_wrapper::Simple_spacer_wrapper ()
+{
+  spacer_ = new Simple_spacer ();
+}
 
-bool
-Spring_description::sane_b () const
+Simple_spacer_wrapper::~Simple_spacer_wrapper ()
 {
-  return (hooke_f_ > 0) &&  !isinf (ideal_f_) && !isnan (ideal_f_);
+  delete spacer_;
 }
 
-Real
-Spring_description::length (Real f) const
+
+Simple_spacer_wrapper::Simple_spacer_wrapper (Simple_spacer_wrapper const&)
 {
-  if (!active_b_)
-    f = block_force_f_;
-  return ideal_f_ + f / hooke_f_ ;
 }