Run grand-replace (issue 3765)

[lilypond.git] / lily / spring.cc

diff --git a/lily/spring.cc b/lily/spring.cc
index 312b2ed00f49644598966832b50d1598396eae3b..f4123b9891527abc9c8633c7abe3f48a1c77fd6f 100644 (file)
--- a/lily/spring.cc
+++ b/lily/spring.cc
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2007--2012 Joe Neeman <joeneeman@gmail.com>
+  Copyright (C) 2007--2014 Joe Neeman <joeneeman@gmail.com>
 
   LilyPond is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -17,6 +17,23 @@
   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+/*
+  Springs help chains of objects, such as the notes in a line of music,
+  distribute themselves evenly.
+  Each spring decides the length from the reference point of one object
+  along the line to the reference point of the next, based on a force
+  applied to the entire chain (see Spring::length() for details):
+     length = distance_ + flexibility * force
+
+  distance_  is the ideal separation between reference points
+  inverse_stretch_strength_ is the flexibility when the force is stretching
+  inverse_compress_strength_ is the flexibility when the force is compressing
+  min_distance_ sets a lower limit on length
+
+  Typically, the force applied to a list of objects ranges from about
+  -1 to about 1, though there are no set limits.
+*/
+
 #include "spring.hh"
 
 Spring::Spring ()
@@ -69,7 +86,7 @@ Spring::operator *= (Real r)
 {
   distance_ = max (min_distance_, distance_ * r);
   inverse_compress_strength_ = max (0.0, distance_ - min_distance_);
-  inverse_stretch_strength_ *= 0.8;
+  inverse_stretch_strength_ *= r;
   update_blocking_force ();
 }