/*
- simple-spacer.cc -- implement Simple_spacer
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
-
- (c) 1999--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ Copyright (C) 1999--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
TODO:
- add support for different stretch/shrink constants?
+
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
#include <cstdio>
#include "column-x-positions.hh"
#include "dimensions.hh"
#include "international.hh"
-#include "libc-extension.hh" // isinf
+#include "libc-extension.hh" // isinf
#include "paper-column.hh"
#include "simple-spacer.hh"
#include "spaceable-grob.hh"
Real
Simple_spacer::rod_force (int l, int r, Real dist)
{
- Real c = range_stiffness (l, r);
Real d = range_ideal_len (l, r);
+ Real c = range_stiffness (l, r, dist > d);
Real block_stretch = dist - d;
+
+ if (isinf (c) && block_stretch == 0) /* take care of the 0*infinity_f case */
+ return 0;
return c * block_stretch;
}
{
Real spring_dist = range_ideal_len (l, r);
if (spring_dist < dist)
- for (int i = l; i < r; i++)
- springs_[i].ideal_ *= dist / spring_dist;
+ for (int i = l; i < r; i++)
+ {
+ if (spring_dist)
+ springs_[i].set_distance (springs_[i].distance () * dist / spring_dist);
+ else
+ springs_[i].set_distance (dist / (r - l));
+ }
return;
}
force_ = max (force_, block_force);
for (int i = l; i < r; i++)
- springs_[i].block_force_ = max (block_force, springs_[i].block_force_);
+ springs_[i].set_blocking_force (max (block_force, springs_[i].blocking_force ()));
}
Real
{
Real d = 0.;
for (int i = l; i < r; i++)
- d += springs_[i].ideal_;
+ d += springs_[i].distance ();
return d;
}
Real
-Simple_spacer::range_stiffness (int l, int r) const
+Simple_spacer::range_stiffness (int l, int r, bool stretch) const
{
Real den = 0.0;
for (int i = l; i < r; i++)
- den += springs_[i].inverse_hooke_;
+ den += stretch ? springs_[i].inverse_stretch_strength ()
+ : springs_[i].inverse_compress_strength ();
return 1 / den;
}
return l;
}
+void
+Simple_spacer::set_force (Real force)
+{
+ force_ = force;
+}
+
void
Simple_spacer::solve (Real line_len, bool ragged)
{
Real conf = configuration_length (force_);
- double inv_hooke = 0;
- for (vsize i=0; i < springs_.size (); i++)
- inv_hooke += springs_[i].inverse_hooke_;
ragged_ = ragged;
line_len_ = line_len;
- if ((inv_hooke > 0) && (conf < line_len_))
+ if (conf < line_len_)
force_ = expand_line ();
else if (conf > line_len_)
force_ = compress_line ();
double cur_len = configuration_length (force_);
fits_ = true;
- for (vsize i=0; i < springs_.size (); i++)
- inv_hooke += springs_[i].inverse_hooke_;
+ for (vsize i = 0; i < springs_.size (); i++)
+ inv_hooke += springs_[i].inverse_stretch_strength ();
+
+ if (inv_hooke == 0.0) /* avoid division by zero. If springs are infinitely stiff */
+ inv_hooke = 1e-6; /* then report a very large stretching force */
assert (cur_len <= line_len_);
return (line_len_ - cur_len) / inv_hooke + force_;
Real
Simple_spacer::compress_line ()
{
- double inv_hooke = 0;
double cur_len = configuration_length (force_);
double cur_force = force_;
+ bool compressed = false;
+
+ /* just because we are in compress_line () doesn't mean that the line
+ will actually be compressed (as in, a negative force) because
+ we start out with a stretched line. Here, we check whether we
+ will be compressed or stretched (so we know which spring constant to use) */
+ if (configuration_length (0.0) > line_len_)
+ {
+ cur_force = 0.0;
+ cur_len = configuration_length (0.0);
+ compressed = true;
+ }
fits_ = true;
- for (vsize i=0; i < springs_.size (); i++)
- inv_hooke += springs_[i].inverse_hooke_;
assert (line_len_ <= cur_len);
- vector<Spring_description> sorted_springs = springs_;
- sort (sorted_springs.begin (), sorted_springs.end (), greater<Spring_description> ());
- for (vsize i = 0; i < sorted_springs.size (); i++)
+ vector<Spring> sorted_springs = springs_;
+ sort (sorted_springs.begin (), sorted_springs.end (), greater<Spring> ());
+
+ /* inv_hooke is the total flexibility of currently-active springs */
+ double inv_hooke = 0;
+ vsize i = sorted_springs.size ();
+ for (; i && sorted_springs[i - 1].blocking_force () < cur_force; i--)
+ inv_hooke += compressed
+ ? sorted_springs[i - 1].inverse_compress_strength ()
+ : sorted_springs[i - 1].inverse_stretch_strength ();
+ /* i now indexes the first active spring, so */
+ for (; i < sorted_springs.size (); i++)
{
- Spring_description sp = sorted_springs[i];
+ Spring sp = sorted_springs[i];
- assert (sp.block_force_ <= cur_force);
- if (isinf (sp.block_force_))
- break;
+ if (isinf (sp.blocking_force ()))
+ break;
- double block_dist = (cur_force - sp.block_force_) * inv_hooke;
+ double block_dist = (cur_force - sp.blocking_force ()) * inv_hooke;
if (cur_len - block_dist < line_len_)
- {
- cur_force += (line_len_ - cur_len) / inv_hooke;
- cur_len = line_len_;
-
- /*
- Paranoia check.
- */
- assert (fabs (configuration_length (cur_force) - cur_len) < 1e-6);
- return cur_force;
- }
-
+ {
+ cur_force += (line_len_ - cur_len) / inv_hooke;
+ cur_len = line_len_;
+
+ /*
+ Paranoia check.
+ */
+ assert (fabs (configuration_length (cur_force) - cur_len) < 1e-6);
+ return cur_force;
+ }
+
cur_len -= block_dist;
- inv_hooke -= sp.inverse_hooke_;
- cur_force = sp.block_force_;
+ inv_hooke -= compressed ? sp.inverse_compress_strength () : sp.inverse_stretch_strength ();
+ cur_force = sp.blocking_force ();
}
fits_ = false;
}
void
-Simple_spacer::add_spring (Real ideal, Real inverse_hooke)
+Simple_spacer::add_spring (Spring const &sp)
{
- Spring_description description;
-
- description.ideal_ = ideal;
- description.inverse_hooke_ = inverse_hooke;
- if (!description.is_sane ())
- {
- programming_error ("insane spring found, setting to unit");
-
- description.inverse_hooke_ = 1.0;
- description.ideal_ = 1.0;
- }
-
- description.block_force_ = -description.ideal_ / description.inverse_hooke_;
- // block at distance 0
-
- springs_.push_back (description);
+ force_ = max (force_, sp.blocking_force ());
+ springs_.push_back (sp);
}
vector<Real>
/* Use a convex compression penalty. */
Real f = force_;
- return f - (f < 0 ? f*f*f*f*4 : 0);
-}
-
-/****************************************************************/
-
-Spring_description::Spring_description ()
-{
- ideal_ = 0.0;
- inverse_hooke_ = 0.0;
- block_force_ = 0.0;
-}
-
-bool
-Spring_description::is_sane () const
-{
- return (inverse_hooke_ >= 0)
- && ideal_ >= 0
- && !isinf (ideal_) && !isnan (ideal_)
- && (inverse_hooke_ == 0.0 || fabs (inverse_hooke_) > 1e-8)
- ;
-}
-
-Real
-Spring_description::length (Real f) const
-{
- return ideal_ + max (f, block_force_) * inverse_hooke_;
+ return f - (f < 0 ? f * f * f * f * 2 : 0);
}
/****************************************************************/
-/*
- 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.
-*/
-
struct Rod_description
{
vsize r_;
Real dist_;
- bool operator< (const Rod_description r)
+ bool operator < (const Rod_description r)
{
return r_ < r.r_;
}
{
vector<Rod_description> rods_;
vector<Rod_description> end_rods_; /* use these if they end at the last column of the line */
- Real ideal_;
- Real inverse_hooke_;
- Real end_ideal_;
- Real end_inverse_hooke_;
+ Spring spring_;
+ Spring end_spring_;
+
SCM break_permission_;
Interval keep_inside_line_;
Column_description ()
{
- ideal_ = 0;
- inverse_hooke_ = 0;
- end_ideal_ = 0;
- end_inverse_hooke_ = 0;
break_permission_ = SCM_EOL;
}
};
return (scm_is_pair (g->get_object ("between-cols")));
}
-static Grob*
+static Grob *
maybe_find_prebroken_piece (Grob *g, Direction d)
{
- Grob *ret = dynamic_cast<Item*> (g)->find_prebroken_piece (d);
+ Grob *ret = dynamic_cast<Item *> (g)->find_prebroken_piece (d);
if (ret)
return ret;
return g;
}
-static Grob*
-next_spaceable_column (vector<Grob*> const &list, vsize starting)
+static Grob *
+next_spaceable_column (vector<Grob *> const &list, vsize starting)
{
- for (vsize i = starting+1; i < list.size (); i++)
+ for (vsize i = starting + 1; i < list.size (); i++)
if (!is_loose (list[i]))
return list[i];
return 0;
}
static Column_description
-get_column_description (vector<Grob*> const &cols, vsize col_index, bool line_starter)
+get_column_description (vector<Grob *> const &cols, vsize col_index, bool line_starter)
{
Grob *col = cols[col_index];
if (line_starter)
Column_description description;
Grob *next_col = next_spaceable_column (cols, col_index);
if (next_col)
- Spaceable_grob::get_spring (col, next_col, &description.ideal_, &description.inverse_hooke_);
- Grob *end_col = dynamic_cast<Item*> (cols[col_index+1])->find_prebroken_piece (LEFT);
- if (end_col)
- Spaceable_grob::get_spring (col, end_col, &description.end_ideal_, &description.end_inverse_hooke_);
+ description.spring_ = Spaceable_grob::get_spring (col, next_col);
+
+ if (col_index + 1 < cols.size ())
+ {
+ Grob *end_col = dynamic_cast<Item *> (cols[col_index + 1])->find_prebroken_piece (LEFT);
+ if (end_col)
+ description.end_spring_ = Spaceable_grob::get_spring (col, end_col);
+ }
for (SCM s = Spaceable_grob::get_minimum_distances (col);
scm_is_pair (s); s = scm_cdr (s))
{
- Grob *other = unsmob_grob (scm_caar (s));
+ Grob *other = Grob::unsmob (scm_caar (s));
vsize j = binary_search (cols, other, Paper_column::less_than, col_index);
if (j != VPOS)
- {
- if (cols[j] == other)
- description.rods_.push_back (Rod_description (j, scm_to_double (scm_cdar (s))));
- else /* it must end at the LEFT prebroken_piece */
- description.end_rods_.push_back (Rod_description (j, scm_to_double (scm_cdar (s))));
- }
+ {
+ if (cols[j] == other)
+ description.rods_.push_back (Rod_description (j, scm_to_double (scm_cdar (s))));
+ else /* it must end at the LEFT prebroken_piece */
+ /* see Spanner::set_spacing_rods for more comments on how
+ to deal with situations where we don't know if we're
+ ending yet on the left prebroken piece */
+ description.end_rods_.push_back (Rod_description (j, scm_to_double (scm_cdar (s))));
+ }
}
-
+
if (!line_starter && to_boolean (col->get_property ("keep-inside-line")))
description.keep_inside_line_ = col->extent (col, X_AXIS);
}
vector<Real>
-get_line_forces (vector<Grob*> const &columns,
- Real line_len, Real indent, bool ragged)
+get_line_forces (vector<Grob *> const &columns,
+ Real line_len, Real indent, bool ragged)
{
vector<vsize> breaks;
vector<Real> force;
- vector<Grob*> non_loose;
+ vector<Grob *> non_loose;
vector<Column_description> cols;
SCM force_break = ly_symbol2scm ("force");
for (vsize i = 1; i + 1 < non_loose.size (); i++)
{
if (Paper_column::is_breakable (non_loose[i]))
- breaks.push_back (cols.size ());
+ breaks.push_back (cols.size ());
cols.push_back (get_column_description (non_loose, i, false));
}
cols[breaks[b]] = get_column_description (non_loose, breaks[b], true);
vsize st = breaks[b];
- for (vsize c = b+1; c < breaks.size (); c++)
- {
- vsize end = breaks[c];
- Simple_spacer spacer;
-
- for (vsize i = breaks[b]; i < end - 1; i++)
- spacer.add_spring (cols[i].ideal_, cols[i].inverse_hooke_);
- spacer.add_spring (cols[end-1].end_ideal_, cols[end-1].end_inverse_hooke_);
-
-
- for (vsize i = breaks[b]; i < end; i++)
- {
- for (vsize r = 0; r < cols[i].rods_.size (); r++)
- if (cols[i].rods_[r].r_ < end)
- spacer.add_rod (i - st, cols[i].rods_[r].r_ - st, cols[i].rods_[r].dist_);
- for (vsize r = 0; r < cols[i].end_rods_.size (); r++)
- if (cols[i].end_rods_[r].r_ == end)
- spacer.add_rod (i - st, end - st, cols[i].end_rods_[r].dist_);
- if (!cols[i].keep_inside_line_.is_empty ())
- {
- spacer.add_rod (i - st, end - st, cols[i].keep_inside_line_[RIGHT]);
- spacer.add_rod (0, i - st, -cols[i].keep_inside_line_[LEFT]);
- }
- }
- spacer.solve ((b == 0) ? line_len - indent : line_len, ragged);
- force[b * breaks.size () + c] = spacer.force_penalty (ragged);
-
- if (!spacer.fits ())
- {
- if (c == b + 1)
- force[b * breaks.size () + c] = -200000;
- else
- force[b * breaks.size () + c] = infinity_f;
- break;
- }
- if (end < cols.size () && cols[end].break_permission_ == force_break)
- break;
- }
+ for (vsize c = b + 1; c < breaks.size (); c++)
+ {
+ vsize end = breaks[c];
+ Simple_spacer spacer;
+
+ for (vsize i = breaks[b]; i < end - 1; i++)
+ spacer.add_spring (cols[i].spring_);
+ spacer.add_spring (cols[end - 1].end_spring_);
+
+ for (vsize i = breaks[b]; i < end; i++)
+ {
+ for (vsize r = 0; r < cols[i].rods_.size (); r++)
+ if (cols[i].rods_[r].r_ < end)
+ spacer.add_rod (i - st, cols[i].rods_[r].r_ - st, cols[i].rods_[r].dist_);
+ for (vsize r = 0; r < cols[i].end_rods_.size (); r++)
+ if (cols[i].end_rods_[r].r_ == end)
+ spacer.add_rod (i - st, end - st, cols[i].end_rods_[r].dist_);
+ if (!cols[i].keep_inside_line_.is_empty ())
+ {
+ spacer.add_rod (i - st, end - st, cols[i].keep_inside_line_[RIGHT]);
+ spacer.add_rod (0, i - st, -cols[i].keep_inside_line_[LEFT]);
+ }
+ }
+ spacer.solve ((b == 0) ? line_len - indent : line_len, ragged);
+ force[b * breaks.size () + c] = spacer.force_penalty (ragged);
+
+ if (!spacer.fits ())
+ {
+ if (c == b + 1)
+ force[b * breaks.size () + c] = -200000;
+ else
+ force[b * breaks.size () + c] = infinity_f;
+ break;
+ }
+ if (end < cols.size () && cols[end].break_permission_ == force_break)
+ break;
+ }
}
return force;
}
Column_x_positions
-get_line_configuration (vector<Grob*> const &columns,
- Real line_len,
- Real indent,
- bool ragged)
+get_line_configuration (vector<Grob *> const &columns,
+ Real line_len,
+ Real indent,
+ bool ragged)
{
vector<Column_description> cols;
Simple_spacer spacer;
Column_x_positions ret;
- ret.cols_.push_back (dynamic_cast<Item*> (columns[0])->find_prebroken_piece (RIGHT));
+ ret.cols_.push_back (dynamic_cast<Item *> (columns[0])->find_prebroken_piece (RIGHT));
for (vsize i = 1; i + 1 < columns.size (); i++)
{
if (is_loose (columns[i]))
- ret.loose_cols_.push_back (columns[i]);
+ ret.loose_cols_.push_back (columns[i]);
else
- ret.cols_.push_back (columns[i]);
+ ret.cols_.push_back (columns[i]);
}
- ret.cols_.push_back (dynamic_cast<Item*> (columns.back ())->find_prebroken_piece (LEFT));
+ ret.cols_.push_back (dynamic_cast<Item *> (columns.back ())->find_prebroken_piece (LEFT));
/* since we've already put our line-ending column in the column list, we can ignore
the end_XXX_ fields of our column_description */
for (vsize i = 0; i + 1 < ret.cols_.size (); i++)
{
cols.push_back (get_column_description (ret.cols_, i, i == 0));
- spacer.add_spring (cols[i].ideal_, cols[i].inverse_hooke_);
+ spacer.add_spring (cols[i].spring_);
}
for (vsize i = 0; i < cols.size (); i++)
{
for (vsize r = 0; r < cols[i].rods_.size (); r++)
- spacer.add_rod (i, cols[i].rods_[r].r_, cols[i].rods_[r].dist_);
+ spacer.add_rod (i, cols[i].rods_[r].r_, cols[i].rods_[r].dist_);
if (!cols[i].keep_inside_line_.is_empty ())
- {
- spacer.add_rod (i, cols.size (), cols[i].keep_inside_line_[RIGHT]);
- spacer.add_rod (0, i, -cols[i].keep_inside_line_[LEFT]);
- }
+ {
+ spacer.add_rod (i, cols.size (), cols[i].keep_inside_line_[RIGHT]);
+ spacer.add_rod (0, i, -cols[i].keep_inside_line_[LEFT]);
+ }
}
spacer.solve (line_len, ragged);
{
SCM p = ret.cols_[i]->get_property ("line-break-permission");
if (p == ly_symbol2scm ("force"))
- ret.satisfies_constraints_ = false;
+ ret.satisfies_constraints_ = false;
}
return ret;
}
+#include "ly-smobs.icc"
+
+IMPLEMENT_SIMPLE_SMOBS (Simple_spacer);
+IMPLEMENT_DEFAULT_EQUAL_P (Simple_spacer);
+
+SCM
+Simple_spacer::mark_smob (SCM /* x */)
+{
+ return SCM_EOL;
+}
+
+int
+Simple_spacer::print_smob (SCM /* x */, SCM p, scm_print_state *)
+{
+ scm_puts ("#<Simple spacer>", p);
+ return 1;
+}
+
projects / lilypond.git / blobdiff