changeset 11867:db621daaafaf release-3-0-x

describe additional arguments in sqp() documentation string
author Ivan Sutoris <ivan.sutoris@gmail.com>
date Fri, 10 Oct 2008 11:10:44 +0200
parents 01cad2a83492
children 1ffc52012b46
files scripts/ChangeLog scripts/optimization/sqp.m
diffstat 2 files changed, 18 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/ChangeLog
+++ b/scripts/ChangeLog
@@ -4,6 +4,10 @@
 
 	* polynomial/conv.m: Correct row/col orientation of output.
 
+2008-09-27  Ivan Sutoris  <ivan.sutoris@gmail.com>
+
+	* optimization/sqp.m: Document additional parameters.
+
 2008-09-24  John W. Eaton  <jwe@octave.org>
 
 	* plot/fplot.m: Call axis after calling plot.
--- a/scripts/optimization/sqp.m
+++ b/scripts/optimization/sqp.m
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {[@var{x}, @var{obj}, @var{info}, @var{iter}, @var{nf}, @var{lambda}] =} sqp (@var{x}, @var{phi}, @var{g}, @var{h})
+## @deftypefn {Function File} {[@var{x}, @var{obj}, @var{info}, @var{iter}, @var{nf}, @var{lambda}] =} sqp (@var{x}, @var{phi}, @var{g}, @var{h}, @var{lb}, @var{ub}, @var{maxiter}, @var{tolerance})
 ## Solve the nonlinear program
 ## @iftex
 ## @tex
@@ -38,7 +38,7 @@
 ## @iftex
 ## @tex
 ## $$
-##  g(x) = 0 \qquad h(x) \geq 0
+##  g(x) = 0 \qquad h(x) \geq 0 \qquad lb \leq x \leq ub
 ## $$
 ## @end tex
 ## @end iftex
@@ -47,6 +47,7 @@
 ## @example
 ##      g(x)  = 0
 ##      h(x) >= 0
+##      lb <= x <= ub
 ## @end example
 ## @end ifnottex
 ##
@@ -131,6 +132,17 @@
 ## @end example
 ## @end ifnottex
 ##
+## The fifth and sixth arguments are vectors containing lower and upper bounds
+## on @var{x}. These must be consistent with equality and inequality
+## constraints @var{g} and @var{h}. If the bounds are not specified, or are
+## empty, they are set to -@var{realmax} and @var{realmax} by default.
+##
+## The seventh argument is max. number of iterations. If not specified,
+## the default value is 100.
+##
+## The eighth argument is tolerance for stopping criteria. If not specified,
+## the default value is @var{eps}.
+##
 ## Here is an example of calling @code{sqp}:
 ##
 ## @example