X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fsimple-spacer.cc;h=f23dfb84504eb71001f2214c90711d9a12867975;hb=30a7c603fa9977c1a4a68868475d465e8f7132ca;hp=8261f702fa12d12bc286740f186f362d5909a14e;hpb=faaee71fb44c8e1040239797aad336f4e46c2c21;p=lilypond.git diff --git a/lily/simple-spacer.cc b/lily/simple-spacer.cc index 8261f702fa..f23dfb8450 100644 --- a/lily/simple-spacer.cc +++ b/lily/simple-spacer.cc @@ -1,60 +1,61 @@ -/* +/* simple-spacer.cc -- implement Simple_spacer - + source file of the GNU LilyPond music typesetter - - (c) 1999--2004 Han-Wen Nienhuys + + (c) 1999--2005 Han-Wen Nienhuys TODO: - add support for different stretch/shrink constants? - */ -#include + +#include #include -#include // isinf +#include "libc-extension.hh" // isinf #include "simple-spacer.hh" #include "paper-column.hh" #include "spring.hh" -#include "rod.hh" #include "warn.hh" #include "column-x-positions.hh" #include "spaceable-grob.hh" #include "dimensions.hh" - /* - A simple spacing constraint solver. The approach: + A simple spacing constraint solver. The approach: - Stretch the line uniformly until none of the constraints (rods) - block. It then is very wide. + Stretch the line uniformly until none of the constraints (rods) + block. It then is very wide. - Compress until the next constraint blocks, + Compress until the next constraint blocks, - Mark the springs over the constrained part to be non-active. - - Repeat with the smaller set of non-active constraints, until all - constraints blocked, or until the line is as short as desired. + Mark the springs over the constrained part to be non-active. - This is much simpler, and much much faster than full scale - Constrained QP. On the other hand, a situation like this will not - be typeset as dense as possible, because + Repeat with the smaller set of non-active constraints, until all + constraints blocked, or until the line is as short as desired. - c4 c4 c4 c4 - veryveryverylongsyllable2 veryveryverylongsyllable2 - " "4 veryveryverylongsyllable2 syllable4 + This is much simpler, and much much faster than full scale + Constrained QP. On the other hand, a situation like this will not + be typeset as dense as possible, because + c4 c4 c4 c4 + veryveryverylongsyllable2 veryveryverylongsyllable2 + " "4 veryveryverylongsyllable2 syllable4 - can be further compressed to + can be further compressed to - c4 c4 c4 c4 - veryveryverylongsyllable2 veryveryverylongsyllable2 - " "4 veryveryverylongsyllable2 syllable4 + c4 c4 c4 c4 + veryveryverylongsyllable2 veryveryverylongsyllable2 + " "4 veryveryverylongsyllable2 syllable4 - Perhaps this is not a bad thing, because the 1st looks better anyway. */ + Perhaps this is not a bad thing, because the 1st looks better anyway. */ + +/* + positive force = expanding, negative force = compressing. +*/ Simple_spacer::Simple_spacer () { @@ -64,7 +65,7 @@ Simple_spacer::Simple_spacer () */ active_count_ = 0; force_ = 0.; - indent_ =0.0; + indent_ = 0.0; default_space_ = 20 PT; } @@ -73,44 +74,43 @@ Simple_spacer::add_rod (int l, int r, Real dist) { if (isinf (dist) || isnan (dist)) { - programming_error ("Weird minimum distance. Ignoring"); + programming_error ("ignoring weird minimum distance"); return; } - Real c = range_stiffness (l,r); + Real c = range_stiffness (l, r); if (isinf (c)) { /* If a spring is fixed, we have to do something here: - we let the rod override the spring. - */ + we let the rod override the spring. + */ Real total_dist = 0.; - for (int i = l ; i < r; i++) + for (int i = l; i < r; i++) total_dist += springs_[i].ideal_; if (total_dist < dist) - for (int i = l ; i < r; i++) - springs_[i].ideal_ *= dist/total_dist; + for (int i = l; i < r; i++) + springs_[i].ideal_ *= dist / total_dist; return; } - - Real d = range_ideal_len (l,r); + + Real d = range_ideal_len (l, r); Real block_stretch = dist - d; - + Real block_force = c * block_stretch; - force_ = force_ >? block_force; + force_ = max (force_, block_force); - for (int i=l; i < r; i++) - springs_[i].block_force_ = block_force >? - springs_[i].block_force_ ; + for (int i = l; i < r; i++) + springs_[i].block_force_ = max (block_force, springs_[i].block_force_); } Real -Simple_spacer::range_ideal_len (int l, int r) const +Simple_spacer::range_ideal_len (int l, int r) const { - Real d =0.; - for (int i=l; i < r; i++) + Real d = 0.; + for (int i = l; i < r; i++) d += springs_[i].ideal_; return d; } @@ -118,8 +118,8 @@ Simple_spacer::range_ideal_len (int l, int r) const Real Simple_spacer::range_stiffness (int l, int r) const { - Real den =0.0; - for (int i=l; i < r; i++) + Real den = 0.0; + for (int i = l; i < r; i++) { if (springs_[i].is_active_) den += 1 / springs_[i].hooke_; @@ -131,11 +131,11 @@ Simple_spacer::range_stiffness (int l, int r) const Real Simple_spacer::active_blocking_force () const { - Real bf = - infinity_f; - for (int i=0; i < springs_.size (); i++) + Real bf = -infinity_f; + for (int i = 0; i < springs_.size (); i++) if (springs_[i].is_active_) { - bf = bf >? springs_[i].block_force_; + bf = max (bf, springs_[i].block_force_); } return bf; } @@ -143,17 +143,17 @@ Simple_spacer::active_blocking_force () const Real Simple_spacer::active_springs_stiffness () const { - Real stiff = range_stiffness (0, springs_.size ()); + Real stiff = range_stiffness (0, springs_.size ()); if (isinf (stiff)) { /* all springs are inactive. Take the stiffness of the latest spring to block. - */ + */ Real max_block_force = -infinity_f; int max_i = -1; - for (int i=0; i < springs_.size (); i++) + for (int i = 0; i < springs_.size (); i++) { if (springs_[i].block_force_ > max_block_force) { @@ -162,7 +162,7 @@ Simple_spacer::active_springs_stiffness () const } } - stiff = springs_[max_i].hooke_; + stiff = springs_[max_i].hooke_; } return stiff; } @@ -171,20 +171,20 @@ void Simple_spacer::set_active_states () { /* float comparison is safe, since force is only copied. */ - for (int i=0 ; i = force_) { springs_[i].is_active_ = false; - active_count_ --; + active_count_--; } -} +} Real Simple_spacer::configuration_length () const { - Real l =0.; - for (int i=0; i < springs_.size (); i++) + Real l = 0.; + for (int i = 0; i < springs_.size (); i++) l += springs_[i].length (force_); return l; @@ -193,7 +193,7 @@ Simple_spacer::configuration_length () const bool Simple_spacer::is_active () const { - return active_count_; + return active_count_; } void @@ -214,113 +214,42 @@ Simple_spacer::my_solve_linelen () } } - void Simple_spacer::my_solve_natural_len () { + Real line_len_force = 0.0; + while (is_active ()) { - force_ = active_blocking_force () >? 0.0; + force_ = max (active_blocking_force (), 0.0); + Real conf = configuration_length (); + + if (conf < line_len_) + { + line_len_force = force_ + + (line_len_ - conf) + * active_springs_stiffness (); + } if (force_ < 1e-8) // ugh., break; - - set_active_states (); - } -} - -LY_DEFINE(ly_solve_spring_rod_problem, "ly:solve-spring-rod-problem", - 4, 1, 0, (SCM springs, SCM rods, SCM length, SCM ragged), - "Solve a spring and rod problem for @var{count} objects, that " - "are connected by @var{count-1} springs, and an arbitrary number of rods " - "Springs have the format (ideal, hooke) and rods (idx1, idx2, distance) " - "@var{length} is a number, @var{ragged} a boolean " - "Return: a list containing the force (#f for non-satisfied constraints) " - "followed by the @var{spring-count}+1 positions of the objects. " - ) -{ - int len = scm_ilength (springs); - if (len == 0) - return scm_list_2 (scm_from_double (0.0), scm_from_double (0.0)); - - SCM_ASSERT_TYPE (len >= 0, springs, SCM_ARG1, __FUNCTION__, "list of springs"); - SCM_ASSERT_TYPE (scm_ilength (rods) >= 0, rods, SCM_ARG2, __FUNCTION__, "list of rods"); - SCM_ASSERT_TYPE (scm_is_number (length) || length == SCM_BOOL_F, - length, SCM_ARG3, __FUNCTION__, "number or #f"); - - - bool is_ragged = ragged == SCM_BOOL_T; - Simple_spacer spacer; - for (SCM s = springs; ly_c_pair_p (s); s = ly_cdr (s)) - { - Real ideal = scm_to_double (ly_caar (s)); - Real hooke = scm_to_double (ly_cadar (s)); - - spacer.add_spring (ideal, hooke); - } - - for (SCM s = rods; ly_c_pair_p (s); s = ly_cdr (s)) - { - SCM entry = ly_car (s); - int l = scm_to_int (ly_car (entry)); - int r = scm_to_int (ly_cadr (entry)); - entry = ly_cddr (entry); - - Real distance = scm_to_double (ly_car (entry)); - spacer.add_rod (l, r, distance); - } - - spacer.line_len_ = scm_to_double (length); - - if (is_ragged) - spacer.my_solve_natural_len (); - else - spacer.my_solve_linelen (); - - Array posns; - posns.push (0.0); - for (int i = 0; i < spacer.springs_.size(); i++) - { - Real l = spacer.springs_[i].length ((is_ragged) ? 0.0 : spacer.force_); - posns.push (posns.top() + l); - } - SCM force_return = SCM_BOOL_F; - if (is_ragged) - { - Real len = posns.top (); - if (spacer.line_len_ - len >= 0) - force_return = scm_from_double ((spacer.line_len_ - len) - * spacer.active_springs_stiffness ()); - } - else if (not isinf (spacer.force_) - && spacer.is_active ()) - { - force_return = scm_from_double (spacer.force_); - } - - SCM retval= SCM_EOL; - for (int i = posns.size(); i--;) - { - retval = scm_cons (scm_from_double (posns[i]), retval); + set_active_states (); } - retval = scm_cons (force_return, retval); - return retval; + force_ = line_len_force; } - - + /****************************************************************/ Spring_description::Spring_description () { - ideal_ =0.0; - hooke_ =0.0; + ideal_ = 0.0; + hooke_ = 0.0; is_active_ = true; block_force_ = 0.0; } - bool Spring_description::is_sane () const { @@ -334,28 +263,25 @@ Spring_description::length (Real f) const { if (!is_active_) f = block_force_; - return ideal_ + f / hooke_ ; + return ideal_ + f / hooke_; } /****************************************************************/ - /* - TODO: should a add penalty for widely varying spring forces (caused by constraints, eg. - ===== - | | - o|o| x ##x - + . ===== + . | | + .o|o|x ##x + . The ## forces the notes apart; we shouldn't allow the O's to touch this closely. - - */ +*/ void -Simple_spacer_wrapper::solve (Column_x_positions *positions, bool ragged) +Simple_spacer_wrapper::solve (Column_x_positions *positions, bool ragged) { if (ragged) spacer_->my_solve_natural_len (); @@ -363,67 +289,55 @@ Simple_spacer_wrapper::solve (Column_x_positions *positions, bool ragged) spacer_->my_solve_linelen (); positions->force_ = spacer_->force_; - + /* We used to have a penalty for compression, no matter what, but that fucked up wtk1-fugue2 (taking 3 full pages.) */ positions->config_.push (spacer_->indent_); - for (int i=0; i < spacer_->springs_.size (); i++) + for (int i = 0; i < spacer_->springs_.size (); i++) { - Real l = spacer_->springs_[i].length ((ragged) ? 0.0 : spacer_->force_); + Real l = spacer_->springs_[i].length ((ragged) ? 0.0 : spacer_->force_); positions->config_.push (positions->config_.top () + l); /* - we have l>= 0 here, up to rounding errors + we have l>= 0 here, up to rounding errors */ } /* For raggedright, we must have a measure of music density: this is to prevent lots of short lines (which all have force = 0). - */ + */ if (ragged) { - Real len = positions->config_.top (); - if (spacer_->line_len_ - len >= 0) - positions->force_ = ((spacer_->line_len_ - len) - * spacer_->active_springs_stiffness ()); - else - { - positions->force_ = 0.0; - /* - Don't go past end-of-line in ragged right. - */ - positions->satisfies_constraints_ = false; - } + positions->satisfies_constraints_ + = positions->config_.top () < spacer_->line_len_; } - + else + positions->satisfies_constraints_ = spacer_->is_active (); positions->cols_ = spaced_cols_; positions->loose_cols_ = loose_cols_; - positions->satisfies_constraints_ = - positions->satisfies_constraints_ && spacer_->is_active (); /* Check if breaking constraints are met. - */ + */ bool break_satisfy = true; - int sz = positions->cols_.size (); - for (int i = sz; i--; ) + int sz = positions->cols_.size (); + for (int i = sz; i--;) { - SCM p = positions->cols_[i]->get_property ( "penalty"); - if (ly_c_number_p (p)) + SCM p = positions->cols_[i]->get_property ("penalty"); + if (scm_is_number (p)) { if (scm_to_double (p) < -9999) break_satisfy = break_satisfy && (i == 0 || i == sz -1); if (scm_to_double (p) > 9999) - break_satisfy = break_satisfy && !(i == 0 || i == sz -1); + break_satisfy = break_satisfy && ! (i == 0 || i == sz -1); } - } - positions->satisfies_constraints_ = - positions->satisfies_constraints_ && break_satisfy; + positions->satisfies_constraints_ + = positions->satisfies_constraints_ && break_satisfy; } void @@ -435,12 +349,12 @@ Simple_spacer::add_spring (Real ideal, Real hooke) desc.hooke_ = hooke; if (!desc.is_sane ()) { - programming_error ("Insane spring found. Setting to unit spring."); + programming_error ("insane spring found, setting to unit"); desc.hooke_ = 1.0; desc.ideal_ = 1.0; } - + if (isinf (hooke)) { desc.is_active_ = false; @@ -448,64 +362,81 @@ Simple_spacer::add_spring (Real ideal, Real hooke) else { /* - desc.is_active_ ? + desc.is_active_ ? */ - desc.block_force_ = - desc.hooke_ * desc.ideal_; // block at distance 0 - - active_count_ ++; + desc.block_force_ = -desc.hooke_ * desc.ideal_; // block at distance 0 + + active_count_++; } springs_.push (desc); } +static int +compare_paper_column_rank (Grob *const &a, + Grob *const &b) +{ + return Paper_column::get_rank (a) - Paper_column::get_rank (b); +} + void Simple_spacer_wrapper::add_columns (Link_array const &icols) { Link_array cols (icols); - - for (int i = cols.size (); i--;) - if (ly_c_pair_p (cols[i]->get_property ("between-cols"))) + + for (int i = cols.size (); i--;) + if (scm_is_pair (cols[i]->get_property ("between-cols"))) { loose_cols_.push (cols[i]); cols.del (i); } - + spaced_cols_ = cols; - for (int i=0; i < cols.size () - 1; i++) + for (int i = 0; i < cols.size () - 1; i++) { Spring_smob *spring = 0; for (SCM s = cols[i]->get_property ("ideal-distances"); - !spring && ly_c_pair_p (s); - s = ly_cdr (s)) + !spring && scm_is_pair (s); + s = scm_cdr (s)) { - Spring_smob *sp = unsmob_spring (ly_car (s)); - - - if (sp->other_ == cols[i+1]) + Spring_smob *sp = unsmob_spring (scm_car (s)); + + if (sp->other_ == cols[i + 1]) spring = sp; } if (!spring) programming_error (_f ("No spring between column %d and next one", - Paper_column::get_rank (cols[i]) - )); + Paper_column::get_rank (cols[i]))); Real ideal = (spring) ? spring->distance_ : spacer_->default_space_; Real hooke = (spring) ? spring->strength_ : 1.0; - + spacer_->add_spring (ideal, hooke); } - - for (int i=0; i < cols.size () - 1; i++) + + for (int i = 0; i < cols.size () - 1; i++) { for (SCM s = Spaceable_grob::get_minimum_distances (cols[i]); - ly_c_pair_p (s); s = ly_cdr (s)) + scm_is_pair (s); s = scm_cdr (s)) + { + Grob *other = unsmob_grob (scm_caar (s)); + int oi = binsearch_links (cols, other, &compare_paper_column_rank); + if (oi >= 0 + && cols[oi] == other) + { + spacer_->add_rod (i, oi, scm_to_double (scm_cdar (s))); + } + } + + if (i + && !to_boolean (cols[i]->get_property ("allow-outside-line"))) { - Grob * other = unsmob_grob (ly_caar (s)); - int oi = cols.find_index (other); - if (oi >= 0) + Interval e = cols[i]->extent (cols[i], X_AXIS); + if (!e.is_empty ()) { - spacer_->add_rod (i, oi, scm_to_double (ly_cdar (s))); + spacer_->add_rod (i, cols.size () - 1, e[RIGHT]); + spacer_->add_rod (0, i, e[LEFT]); } } } @@ -521,7 +452,6 @@ Simple_spacer_wrapper::~Simple_spacer_wrapper () delete spacer_; } - -Simple_spacer_wrapper::Simple_spacer_wrapper (Simple_spacer_wrapper const&) +Simple_spacer_wrapper::Simple_spacer_wrapper (Simple_spacer_wrapper const &) { }