release: 1.1.1

[lilypond.git] / lily / include / spring-spacer.hh

diff --git a/lily/include/spring-spacer.hh b/lily/include/spring-spacer.hh
index 55864615a24dbc49d801b91a5eec6d6d4509b680..33390810ced06f6ccc14a3d4d6facd1edd7ba044 100644 (file)
--- a/lily/include/spring-spacer.hh
+++ b/lily/include/spring-spacer.hh
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
+  (c)  1997--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 
@@ -13,10 +13,15 @@
 #include "line-spacer.hh"
 #include "plist.hh"
 #include "col-info.hh"
+#include "colhpos.hh"
+#include "moment.hh"
 
-/** the problem, given by the columns (which include constraints) and
-    intercolumn spacing. The problem is:
 
+
+/** 
+  Determine positions of columns connected by springs and held apart by rods.
+  
+  
     Generate a spacing which
     \begin{itemize}
     \item
@@ -24,6 +29,7 @@
     \item
     Looks good, ie tries to conform to  an ideal spacing as much as possible.
     \end{itemize}
+  
     This is converted by regarding idealspacing as "springs" attached
     to columns. The equilibrium of one spring is the ideal
     distance. The columns have a size, this imposes "hard" constraints
@@ -33,67 +39,63 @@
     The quality is given by the total potential energy in the
     springs. The lower the energy, the better the configuration.
 
-    TODO: make item widths work per pstaff.
+    TODO: make item widths work per Staff.
 
 */
 
 class Spring_spacer : public Line_spacer {
-    friend class Durations_iter;
-    
-    Pointer_list<Idealspacing *> ideal_p_list_;
-    Array<Colinfo> cols;
-    Array<Colinfo> loose_col_arr_;
-    
-    /// mark column #i# as being loose.
-    void loosen_column(int i);
-    /// the index of #c# in #cols#
-    int col_id(PCol const *c) const;
-
-    /// generate an (nonoptimal) solution
-    Vector find_initial_solution() const;
-
-    /// check if problem is too tight
-    bool check_feasible() const;
-
-    /// does #this# contain the column #w#? 
-    bool contains(PCol const *w);
-
-    /// make the energy function
-    void make_matrices(Matrix &quad, Vector &lin,Real&) const;
-
-    /// generate the LP constraints
-    void make_constraints(Mixed_qp& lp) const;
-
-
-    void handle_loose_cols();
-    void position_loose_cols(Vector &) const;
-   /**
-       add a idealspacing to the problem.
-      
-    One pair of columns can have no, one or more idealspacings,
-    since they can be "summed" if the columns to which #i# refers are
-    not in this problem, the spacing is ignored.
-    */
-    void add_ideal(Idealspacing const *i);
-    Vector try_initial_solution() const;
-    void calc_idealspacing();
-
-    Score_column* scol_l(int);
-    void connect(int i,int j, Real,Real);
-public:
-    static Line_spacer *constructor();
-    Array<PCol*> error_pcol_l_arr() const;
+  friend class Durations_iter;
+
+  Pointer_list<Idealspacing *> ideal_p_list_;
+  Array<Column_info> cols_;
+  Array<Column_info> loose_col_arr_;
+
+  
+  /// mark column #i# as being loose.
+  void loosen_column (int i);
+  /// the index of #c# in #cols#
+  int col_id (Paper_column const *c) const;
+
+  /// generate an (nonoptimal) solution
+  Vector find_initial_solution() const;
+
+  /// does #this# contain the column #w#? 
+  bool contains_b (Paper_column const *w);
 
-    virtual   Array<Real> solve() const;
-    virtual  void add_column(PCol  *, bool fixed=false, Real fixpos=0.0);
+  /// make the energy function
+  void make_matrices (Matrix &quad, Vector &lin,Real&) const;
+  void get_ruling_durations(Array<Moment>&, Array<Moment>&);
+
+  /// generate the LP constraints
+  void make_constraints (Mixed_qp& lp) const;
+
+
+  void handle_loose_cols();
+  void position_loose_cols (Vector &) const;
+  bool try_initial_solution_and_tell (Vector&)const;
+  Vector try_initial_solution() const;
+  void calc_idealspacing();
+  void set_fixed_cols (Mixed_qp&) const;
+
+  Score_column* scol_l (int);
+  void connect (int i,int j, Real,Real);
+  Line_of_cols error_pcol_l_arr() const;
+  Real calculate_energy_f (Vector) const;
+public:
+  static Line_spacer *constructor();
+  Real energy_normalisation_f_;
+  Spring_spacer ();
+  virtual void solve (Column_x_positions*) const;
+  virtual void lower_bound_solution (Column_x_positions*) const;
+  virtual void add_column (Paper_column  *, bool fixed=false, Real fixpos=0.0);
  
 
-    virtual Vector default_solution() const;
-    virtual   bool check_constraints(Vector v) const;
-    virtual    void OK() const;
-    virtual    void print() const;
-    virtual    void prepare();
-    virtual ~Spring_spacer(){}
+  virtual Vector default_solution() const;
+  virtual bool check_constraints (Vector v) const;
+  virtual void OK() const;
+  virtual void print() const;
+  virtual void prepare();
+  virtual ~Spring_spacer(){}
 };
 
 #endif // SPRING_SPACER_HH