patch::: 1.2.9.jcn2

[lilypond.git] / lily / include / ineq-constrained-qp.hh

diff --git a/lily/include/ineq-constrained-qp.hh b/lily/include/ineq-constrained-qp.hh
index 5686d9e361efa94fe244457aeeb7ea828647fa37..247f2a7688238987af74c3d9020ebd4be6921439 100644 (file)
--- a/lily/include/ineq-constrained-qp.hh
+++ b/lily/include/ineq-constrained-qp.hh
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 
@@ -14,7 +14,24 @@
 
 #include "matrix.hh"
 
-/// inequality constrained quadratic program
+/** inequality constrained quadratic program
+
+    It takes the form of
+
+    optimise for x : x*quad_ *x + lin_* x + const_term_
+
+    subject to for all i:  cons_[i] * x >= consrhs_[i]
+
+
+    @usage:
+    instantiate Ineq_constrained_qp.
+    
+    Modify quad_, lin_ and const_term_ directly. Use
+    add_inequality_cons () to add constraints.  Call solve () with a
+    feasible solution
+
+    
+ */
 class Ineq_constrained_qp {
     friend class Active_constraints;