]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/simple-spacer.cc
release: 1.2.14
[lilypond.git] / lily / simple-spacer.cc
index 46ccff03d85b56fb84b48cc08b47d68a1498a1f0..a053d9f6f873b47d0fb3495e8c0957efed11b9c3 100644 (file)
+/*   
+  simple-spacer.cc -- implement Simple_spacer
+  
+  source file of the GNU LilyPond music typesetter
+  
+  (c) 1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+
+  TODO:
+  - add support for different stretch/shrink constants?
+  - Use force as a minimizing function, and use it to discourage mixes of
+  wide and tight lines.
+  
+*/
+
+
 #include "simple-spacer.hh"
-#include "idealspacing.hh"
-// #include ""
+#include "paper-column.hh"
+#include "spring.hh"
+#include "rod.hh"
+#include "warn.hh"
+#include "column-x-positions.hh"
+#include "dimensions.hh"
 
+Simple_spacer::Simple_spacer ()
+{
+  force_f_ = 0.;
+  indent_f_ =0.0;
+  default_space_f_ = 20 PT;
+  compression_energy_factor_f_ = 3.0;
+}
 
 void
-Spring_info::set(Idealspacing *i)
+Simple_spacer::add_rod (int l, int r, Real dist)
 {
-  space_f_ = i->space_f_;
-  hooke_f_ = i->hooke_f_;
+  Real c = range_stiffness (l,r);
+  Real d = range_ideal_len (l,r);
+  Real block_stretch = dist - d;
+  
+  Real block_force = c * block_stretch;
+  force_f_ = force_f_ >? block_force;
+  
+  for (int i=l; i < r; i++)
+    springs_[i].block_force_f_ = block_force >?
+      springs_[i].block_force_f_ ;
 }
 
-Spring_info::Spring_info()
+Real
+Simple_spacer::range_ideal_len (int l, int r)   const
 {
-  space_f_ = 0.0;
-  hooke_f_ = 1.0;
-  blocking_stretch_f_ = infinity_f;
-  blocking_rod_l_ = 0;
+  Real d =0.;
+  for (int i=l; i < r; i++)
+    d += springs_[i].ideal_f_;
+  return d;
 }
 
-  
+Real
+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_;
+
+  return 1 / den;
+}
+
+Real
+Simple_spacer::active_blocking_force () const
+{
+  Real bf = - infinity_f; 
+  for (int i=0; i < springs_.size (); i++)
+    if (springs_[i].active_b_)
+      {
+       bf = bf >? springs_[i].block_force_f_;
+      }
+  return bf;
+}
+
+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;
+}
 
 void
-Simple_spring_spacer::init ()
+Simple_spacer::set_active_states ()
 {
-  for (PCursor<Rod_info*> i(rods_.top()); i.ok (); i++)
-    {
-      Real hooke=0.0;
-      Real dist= i->distance_f_;
+  // safe, since
+  // force is only copied.
+  for (int i=0 ; i <springs_.size (); i++)
+    if (springs_[i].block_force_f_ >= force_f_) 
+      springs_[i].active_b_ = false;
+}   
 
-      hooke =0.0;
-      
-      for (int j = i->cols_[LEFT]; j < i->cols_[RIGHT]; j++)
-       {
-         hooke += 1/springs_[j].hooke_f_;
-         dist -= springs_[j].space_f_;
-       }
-      
-      hooke = 1/hooke;
+Real
+Simple_spacer::configuration_length () const
+{
+  Real l =0.;
+  for (int i=0; i < springs_.size (); i++)
+    l += springs_[i].length (force_f_);
 
-      for (int j = i->cols_[LEFT]; j < i->cols_[RIGHT]; j++)
-       {
-         Real block_stretch = hooke * dist / (springs_[j].space_f_ *
-                                              springs_[j].hooke_f_ );
+  return l;
+}
 
-         if (block_stretch < springs_[j].blocking_stretch_f_)
-           {
-             springs_[j].blocking_stretch_f_ = block_stretch;
-             springs_[j].blocking_rod_l_ = i.ptr ();
-           }
-       }
-    }
+Real
+Spring_description::length (Real f) const
+{
+  if (!active_b_)
+    f = block_force_f_;
+  return ideal_f_ + f / hooke_f_ ;
 }
 
-Array<Real>
-Simple_spring_spacer::solve ()
+bool
+Simple_spacer::active_b () const
 {
-  Real start_force = 0.0;
+   for (int i=0; i < springs_.size (); i++)
+    if (springs_[i].active_b_)
+      return true;
+   return false;
+}
 
-  for (int i=0; i< springs_.size (); i++)
+void
+Simple_spacer::my_solve_linelen ()
+{
+  while (active_b ())
     {
-      start_force = start_force >?
-       springs_[i].blocking_stretch_f_ * springs_[i].hooke_f_;
+      force_f_ = active_blocking_force ();
+      Real conf = configuration_length ();
+
+      if (conf < line_len_f_)
+       {
+         force_f_ +=  (line_len_f_  - conf) * active_springs_stiffness ();
+         break;
+       }
+      else
+       set_active_states ();
     }
+}
 
-  Array<Real> stretch_factors;
-  Array<bool> blocked;
-  int blocked_count=0; 
-  Real current_len =0.0;
-  for (int i=0; i < springs_.size (); i++)
+
+void
+Simple_spacer::my_solve_natural_len ()
+{
+  while (active_b ())
     {
-      Real stretch = start_force / (springs_[i].hooke_f_ * springs_[i].space_f_);
-      stretch_factors.push (stretch);
-      current_len += (1  + stretch) * springs_[i].space_f_;
-      blocked.push(false);
+      force_f_ = active_blocking_force () >? 0.0;
+
+      if (force_f_ < 1e-8) // ugh.,
+       break;
+      
+      set_active_states ();
     }
+}
 
-  while (blocked_count < blocked.size ())
+void
+Simple_spacer::add_columns (Link_array<Paper_column> cols)
+{
+  for (int i=0; i < cols.size () - 1; i++)
     {
-      Real      next_stretch = -1.0;
-      int block_index;
-      for (int i=0; i< stretch_factors.size (); i++)
+      Paper_column * c = cols [i];
+      Column_spring *to_next = 0;
+      for (int j =0; !to_next && j < c->spring_arr_drul_[RIGHT].size( ); j++)
        {
-         if (!blocked[i])
-           {
-             next_stretch = next_stretch >? springs_[i].blocking_stretch_f_;
+         Column_spring &sp = c->spring_arr_drul_[RIGHT] [j];
+         if (sp.other_l_ != cols[i+1])
+           continue;
 
-             if (next_stretch < springs_[i].blocking_stretch_f_)
-               {
-                 next_stretch = springs_[i].blocking_stretch_f_;
-                 block_index = i;
-               }
-           }
+         to_next = &sp;
        }
-      current_len = 0.0;
 
-      Real force = next_stretch * (springs_[block_index].space_f_* springs_[block_index].hooke_f_);
-      for (int i=0; i< stretch_factors.size (); i++)
+      Spring_description desc;
+      if (to_next)
        {
-         if (!blocked[i])
-           {
-             stretch_factors[i] = force / (springs_[i].space_f_ * springs_[i].hooke_f_);
-           }
-         current_len += (1.0 + stretch_factors[i]) * springs_[i].space_f_;
+         desc.hooke_f_ = to_next->strength_f_;
+         desc.ideal_f_ = to_next->distance_f_;
        }
-
-      Rod_info *blockrod = springs_[block_index].blocking_rod_l_;
-      for (int j = blockrod->cols_ [LEFT]; j < blockrod->cols_ [RIGHT]; j++)
+      else
+       {
+         desc.hooke_f_ = 1.0;
+         desc.ideal_f_ = default_space_f_;
+       }
+      desc.block_force_f_ = - desc.hooke_f_ * desc.ideal_f_; // block at distance 0
+      springs_.push  (desc);
+    }
+  
+  for (int i=0; i < cols.size () - 1; i++)
+    {
+      Array<Column_rod> * rods = &cols [i]->minimal_dists_arr_drul_[RIGHT];
+      for (int j =0; j < rods->size( ); j++)
        {
-         blocked[j] = true;
-         blocked_count ++;
+         int oi = cols.find_i (rods->elem (j).other_l_ );
+         if (oi >= 0)
+           {
+             add_rod (i, oi, rods->elem (j).distance_f_);
+           }
        }
     }
 
+  if (line_len_f_ < 0)
+    my_solve_natural_len ();
+  else
+    my_solve_linelen ();
+}
 
-  Array<Real> distances;
-  for (int i=0; i < stretch_factors.size (); i++)
+void
+Simple_spacer::solve (Column_x_positions *positions) const
+{
+  positions->energy_f_  = energy_f ();  // abs (force_f_);
+  positions->force_f_ = force_f_;
+  
+  positions->config_.push (indent_f_);
+  for (int i=0; i <springs_.size (); i++)
     {
-      distances.push (stretch_factors[i] * springs_[i].space_f_);
+      positions->config_.push (positions->config_.top () + springs_[i].length (force_f_));
     }
-  return distances;
+
+  positions->satisfies_constraints_b_ =  (line_len_f_ < 0) || active_b ();
+}
+
+
+
+Spring_description::Spring_description( )
+{
+  ideal_f_ =0.0;
+  hooke_f_ =0.0;
+  active_b_ = true;
+  block_force_f_ = 0.0;
 }
 
+Real
+Spring_description::energy_f (Real force) const
+{
+  Real stretch = (force >? block_force_f_) / hooke_f_;
+  Real e = 0.5 * stretch * stretch * hooke_f_;
+  return e;
+}
+
+Real
+Simple_spacer::energy_f () const
+{
+  Real e =0.;
+
+  for (int i=0; i <springs_.size (); i++)
+    {
+      e += springs_[i].energy_f (force_f_);
+    }
+
+  if (force_f_ < 0)
+    e *= compression_energy_factor_f_;
+
+  return e;
+}