]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spring-spacer.cc
release: 1.1.65
[lilypond.git] / lily / spring-spacer.cc
index b5cf85577fe6fe1b189e5758c61cbb1d4b47eb04..f80fe91561f68a8dff6c31f6af1acc7b6a3e9241 100644 (file)
@@ -11,7 +11,7 @@
 #include <limits.h>
 #include "killing-cons.tcc"
 #include "spring-spacer.hh"
-#include "p-col.hh"
+#include "paper-column.hh"
 #include "debug.hh"
 #include "dimensions.hh"
 #include "qlp.hh"
@@ -54,8 +54,6 @@ Spring_spacer::OK() const
 #ifndef NDEBUG
   for (int i = 1; i < cols_.size(); i++)
     assert (cols_[i].rank_i_ > cols_[i-1].rank_i_);
-  for (int i = 1; i < loose_col_arr_.size(); i++)
-    assert (loose_col_arr_[i].rank_i_ > loose_col_arr_[i-1].rank_i_);
 #endif
 }
 
@@ -78,72 +76,18 @@ Spring_spacer::handle_loose_cols()
   for (int i=1; i < fixed.size(); i++)
     connected.connect (fixed[i-1], fixed[i]);
 
+  /*
+    If columns do not have spacing information set, we need to supply our own.
+   */
+  Real d = paper_l ()->get_var ("loose_column_distance");
   for (int i = cols_.size(); i--;)
     {
       if (! connected.equiv (fixed[0], i))
        {
-         warning (_f ("unconnected column: %d", i));
-         loosen_column (i);
+         connected.connect (i-1, i);
+         connect (i-1, i, d, 1.0);
        }
     }
-  OK();
-}
-
-
-/**
-  Guess a stupid position for loose columns.  Put loose columns at
-  regular distances from enclosing calced columns
-  */
-void
-Spring_spacer::position_loose_cols (Vector &sol_vec) const
-{
-  if (!loose_col_arr_.size())
-    return ;
-  assert (sol_vec.dim());
-  Array<bool> fix_b_arr;
-  fix_b_arr.set_size (cols_.size() + loose_col_arr_.size ());
-  Real utter_right_f=-infinity_f;
-  Real utter_left_f =infinity_f;
-  for (int i=0; i < loose_col_arr_.size(); i++)
-    {
-      fix_b_arr[loose_col_arr_[i].rank_i_] = false;
-    }
-  for (int i=0; i < cols_.size(); i++)
-    {
-      int r= cols_[i].rank_i_;
-      fix_b_arr[r] = true;
-      utter_right_f = utter_right_f >? sol_vec (i);
-      utter_left_f = utter_left_f <? sol_vec (i);
-    }
-  Vector v (fix_b_arr.size());
-  int j =0;
-  int k =0;
-  for (int i=0; i < v.dim(); i++)
-    {
-      if (fix_b_arr[i])
-       {
-         assert (cols_[j].rank_i_ == i);
-         v (i) = sol_vec (j++);
-       }
-      else
-       {
-         Real left_pos_f =
-           (j>0) ?sol_vec (j-1) : utter_left_f;
-         Real right_pos_f =
-           (j < sol_vec.dim()) ? sol_vec (j) : utter_right_f;
-         int left_rank = (j>0) ? cols_[j-1].rank_i_ : 0;
-         int right_rank = (j<sol_vec.dim()) ? cols_[j].rank_i_ : sol_vec.dim ();
-
-         int d_r = right_rank - left_rank;
-         Column_info loose=loose_col_arr_[k++];
-         int r = loose.rank_i_ ;
-         assert (r > left_rank && r < right_rank);
-
-         v (i) =  (r - left_rank)*left_pos_f/ d_r +
-           (right_rank - r) *right_pos_f /d_r;
-       }
-    }
-  sol_vec = v;
 }
 
 bool
@@ -178,7 +122,8 @@ Spring_spacer::check_constraints (Vector v) const
   return true;
 }
 
-/** try to generate a solution which obeys the min distances and fixed positions
+/** try to generate a solution which obeys the min
+    distances and fixed positions
  */
 Vector
 Spring_spacer::try_initial_solution() const
@@ -317,7 +262,7 @@ Spring_spacer::lower_bound_solution (Column_x_positions*positions) const
 
   DOUT << "Lower bound sol: " << solution_vec;
   positions->energy_f_ = calculate_energy_f (solution_vec);
-  positions->config = solution_vec;
+  positions->config_ = solution_vec;
   positions->satisfies_constraints_b_ = check_constraints (solution_vec);
 }
 
@@ -349,10 +294,8 @@ Spring_spacer::solve (Column_x_positions*positions) const
        {
          WARN << _ ("solution doesn't satisfy constraints") << '\n' ;
        }
-      position_loose_cols (solution_vec);
       positions->energy_f_ = calculate_energy_f (solution_vec);
-      positions->config = solution_vec;
-      positions->error_col_l_arr_ = error_pcol_l_arr();
+      positions->config_ = solution_vec;
     }
   else
     {
@@ -392,54 +335,20 @@ Spring_spacer::add_column (Paper_column  *col, bool fixed, Real fixpos)
       r_rod.other_idx_ = this_rank;
       cols_[left_idx].rods_[RIGHT].push (r_rod);
     }
-  
-  cols_.push (c);
-}
-
-Line_of_cols
-Spring_spacer::error_pcol_l_arr() const
-{
-  Link_array<Paper_column> retval;
-  for (int i=0; i< cols_.size(); i++)
-    if (cols_[i].ugh_b_)
-      retval.push (cols_[i].pcol_l_);
-  for (int i=0;  i < loose_col_arr_.size(); i++)
-    {
-      retval.push (loose_col_arr_[i].pcol_l_);
-    }
-  return retval;
-}
-/*
-  Ugh. Should junk this.
- */
-void
-Spring_spacer::loosen_column (int idx)
-{
-  Column_info c=cols_.get (idx);
 
-  Cons<Idealspacing> **pp = &ideal_p_list_;
-
-  while (*pp)
+  for (int i=0; i < col->spring_arr_drul_[LEFT].size (); i++)
     {
-      Idealspacing *j = (*pp)->car_;
-      if (j->cols_drul_[LEFT] == idx|| j->cols_drul_[RIGHT] == idx)
-       {
-         delete remove_cons (pp);
-       }
-      else
-       {
-         pp = &(*pp)->next_;
-       }
-    }
-  c.ugh_b_ = true;
-
-  int j=0;
-  for (; j < loose_col_arr_.size(); j++)
-    {
-      if (loose_col_arr_[j].rank_i_ > c.rank_i_)
-       break;
+      Column_spring &cr = col->spring_arr_drul_[LEFT][i];
+      int idx = cr.other_l_->rank_i () - cols_[0].pcol_l_->rank_i ();
+      if (idx < 0)
+       continue;
+      
+      if (cols_[idx].pcol_l_ != cr.other_l_)
+       continue;
+      connect (idx, this_rank, cr.distance_f_, cr.strength_f_);
     }
-  loose_col_arr_.insert (c,j);
+      
+  cols_.push (c);
 }
 
 
@@ -477,17 +386,11 @@ Spring_spacer::connect (int i, int j, Real d, Real h)
   ideal_p_list_ = new Killing_cons<Idealspacing> (s, ideal_p_list_);
 }
 
-
-
-
 void
 Spring_spacer::prepare()
 {
-  DOUT << "Preparing..";
-  calc_idealspacing();
   handle_loose_cols();
   print();
-  DOUT << "finished preparing.\n";
 }
 
 Line_spacer*
@@ -498,256 +401,8 @@ Spring_spacer::constructor()
 
 
 
-/**
-  get the shortest_playing running note at a time. */
-void
-Spring_spacer::get_ruling_durations(Array<Moment> &shortest_playing_arr,
-                                   Array<Moment> &context_shortest_arr)
-{
-  for (int i=0; i < cols_.size(); i++)
-    {
-      scol_l (i)->preprocess();
-      scol_l (i)->print ();
-    }
-  int start_context_i=0;
-  Moment context_shortest;
-  context_shortest.set_infinite (1);
-  context_shortest_arr.set_size(cols_.size());
-
-  for (int i=0; i < cols_.size(); i++)
-    {
-      Moment now = scol_l (i)->when();
-      Moment shortest_playing;
-      shortest_playing.set_infinite (1);
-
-      if (scol_l (i)->breakable_b_)
-       {
-         for (int ji=i; ji >= start_context_i; ji--)
-           context_shortest_arr[ji] = context_shortest;
-         start_context_i = i;
-         context_shortest.set_infinite (1);
-       }
-      if (scol_l (i)->durations.size())
-       {
-         context_shortest = context_shortest <? scol_l(i)->durations[0];
-       }
-      
-      // ji was j, but triggered ICE
-      for (int ji=i+1; ji --;)
-       {
-         if (scol_l(ji)->durations.size() &&
-             now - scol_l(ji)->when() >= shortest_playing)
-           break;
-
-         for (int k =  scol_l (ji)->durations.size();
-              k-- && scol_l(ji)->durations[k] + scol_l(ji)->when() > now;
-              )
-           {
-             shortest_playing = shortest_playing <? scol_l(ji)->durations[k];
-           }
-       }
-      shortest_playing_arr.push(shortest_playing);
-    }
-
-#ifndef NPRINT
-  DOUT << "shortest_playing/:[ ";
-  for (int i=0; i < shortest_playing_arr.size(); i++)
-    {
-      DOUT << shortest_playing_arr[i] << " ";
-      DOUT << context_shortest_arr[i] << ", ";
-    }
-  DOUT << "]\n";
-#endif
-}
-
-/*
-  TODO: take out the refs to width
-
- */
-/**
-  generate springs between columns.
-
-  TODO: This needs rethinking....... 
-
-  *  Spacing should take optical
-  effects into account
 
-  *  Should be decentralised
-  
-  The algorithm is taken from :
-
-  John S. Gourlay. ``Spacing a Line of Music,'' Technical Report
-  OSU-CISRC-10/87-TR35, Department of Computer and Information
-  Science, The Ohio State University, 1987.
-
-  */
-void
-Spring_spacer::calc_idealspacing()
+Spring_spacer::~Spring_spacer()
 {
-  Array<Moment> shortest_playing_arr;
-  Array<Moment> context_shortest_arr;
-  get_ruling_durations(shortest_playing_arr, context_shortest_arr);
-
-  Real interline_f = paper_l ()->interline_f ();
-
-
-  Array<Real> ideal_arr;
-  Array<Real> hooke_arr;
-  for (int i=0; i < cols_.size() - 1; i++){
-    ideal_arr.push (-1.0);
-    hooke_arr.push (1.0);
-  }
-
-  /* 
-     First do all non-musical columns
-  */
-  for (int i=0; i < cols_.size(); i++)
-    {
-      if (!scol_l (i)->musical_b() && i+1 < cols_.size())
-       {
-         Real symbol_distance =cols_[i].width_[RIGHT] + 2 PT;
-         Real durational_distance = 0;
-         Moment delta_t =  scol_l (i+1)->when() - scol_l (i)->when () ;
-
-         /*
-           ugh should use shortest_playing distance
-         */
-         if (delta_t)
-           {
-             Real k=  paper_l()->arithmetic_constant (context_shortest_arr[i]);
-             durational_distance =  paper_l()->length_mom_to_dist (delta_t,k);
-           }
-         symbol_distance += -cols_[i+1].width_[LEFT];
-
-         ideal_arr[i] = symbol_distance >? durational_distance;
-         hooke_arr[i] = 1; //2.0;
-       }
-    }
-
-  /* 
-     Then musicals
-  */
-  for (int i=0; i < cols_.size(); i++)
-    {
-      if (scol_l (i)->musical_b())
-       {
-         Moment shortest_playing_len = shortest_playing_arr[i];
-         Moment context_shortest = context_shortest_arr[i];
-         if (! shortest_playing_len)
-           {
-             warning (_f ("can't find a ruling note at %s", 
-               scol_l (i)->when().str ()));
-             shortest_playing_len = 1;
-           }
-         if (! context_shortest)
-           {
-             warning (_f ("no minimum in measure at %s", 
-                     scol_l (i)->when().str ()));
-             context_shortest = 1;
-           }
-         Moment delta_t = scol_l (i+1)->when() - scol_l (i)->when ();
-         Real k=  paper_l()->arithmetic_constant(context_shortest);
-         Real dist = paper_l()->length_mom_to_dist (shortest_playing_len, k);
-         dist *= (double)(delta_t / shortest_playing_len);
-
-         /*
-           According to [Ross] and [Wanske], and from what i've seen:
-            
-           * whitespace at the begin of the bar should be fixed at 
-           (about) one interline.
-
-           [Ross]:
-           when spacing gets real tight, a smaller fixed value may be 
-           used, so that there are two discrete amounts of whitespace 
-           possible at the begin of a bar; but this is not implemented 
-           right now.
-            
-           * whitespace at the end of the bar is the normal amount of 
-           "hinterfleish" that would have been used, had there been
-           yet another note in the bar.  
-
-           [Ross]:
-           some editors argue that the bar line should not take any 
-           space, not to hinder the flow of music spaced around a bar 
-           line.  
-
-           [Ross] and [Wanske] do not suggest this, however.  Further, 
-           it introduces some spacing problems and I think that it is ugly 
-           too.
-           
-           [jcn]
-         */
-
-         /* 
-            first musical column of bar
-         */
-         if (i && scol_l (i - 1)->breakable_b_)
-           {
-             // one interline minimum at start of bar
-
-             // cols_[i].width_[RIGHT] += interline_f;
-             cols_[i].width_[RIGHT] = cols_[i].width_[RIGHT] >? interline_f;
-
-             // should adjust dist too?
-             ideal_arr[i-1] = ideal_arr[i-1] >? (2 * interline_f);
-           }
-
-         /* 
-            last musical column of bar
-         */
-         if (i + 1 < cols_.size () && scol_l(i+1)->breakable_b_)
-           {
-             // two interline minimum ok for last column?
-             dist = dist >? 2 * interline_f;
-
-             // set minimum rod 
-             /*
-               urg: simply *adding* an interline leaves big gaps at
-               end of measure in star-spangled-banner (after lyrics
-               at eom).
-
-                  cols_[i].width_[RIGHT] += interline_f; // before
-
-               having a minimum of one interline solves this problem
-               in most (but not all??) cases.
-
-               for music without lyrics (esp. when set very tightly),
-               adding an interline looks good: probably because this
-               hides a bug that allows the last note's "hinterfleish"
-               to be removed (e.g., see wtk1-fugue2: that's ugly now).
-               -- jcn
-              */
-
-             cols_[i].width_[RIGHT] = cols_[i].width_[RIGHT] >? 2 * interline_f;
-           }
-
-         // ugh, do we need this?
-         if (i < cols_.size () - 1 && !scol_l (i + 1)->musical_b ())
-           {
-             Real minimum = -cols_[i + 1].width_[LEFT] + cols_[i].width_[RIGHT]
-               + interline_f / 2;
-             dist = dist >? minimum;
-           }
-         ideal_arr[i] = dist;
-       }
-    }
-
-  /*
-    shorter distances should stretch less.
-
-    (and how bout
-
-      hooke[i] = 2 * max_ideal_space - ideal[i]
-
-    ?)
-  */
-  for (int i=0; i < ideal_arr.size(); i++)
-    hooke_arr[i] = 1/ideal_arr[i];
-
-  for (int i=0; i < ideal_arr.size(); i++)
-    {
-      assert (ideal_arr[i] >=0 && hooke_arr[i] >=0);
-      connect (i, i+1, ideal_arr[i], hooke_arr[i]);
-    }
+  delete ideal_p_list_;
 }