# HG changeset patch # User Ivan Sutoris # Date 1222527220 -7200 # Node ID e3cfbfd636369930ba676da5ad3dead4587ec816 # Parent 2bc8ec18b2ea010fed1ef69bcb24ec2e816e3410 describe additional arguments in sqp() documentation string diff -r 2bc8ec18b2ea -r e3cfbfd63636 scripts/ChangeLog --- a/scripts/ChangeLog Fri Sep 26 17:35:49 2008 -0400 +++ b/scripts/ChangeLog Sat Sep 27 16:53:40 2008 +0200 @@ -1,3 +1,7 @@ +2008-09-27 Ivan Sutoris + + * optimization/sqp.m: Document additional parameters. + 2008-09-26 David Bateman * general/subsindex.m: Dummy subsindex function for help string diff -r 2bc8ec18b2ea -r e3cfbfd63636 scripts/optimization/sqp.m --- a/scripts/optimization/sqp.m Fri Sep 26 17:35:49 2008 -0400 +++ b/scripts/optimization/sqp.m Sat Sep 27 16:53:40 2008 +0200 @@ -17,7 +17,7 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} address@hidden, @var{obj}, @var{info}, @var{iter}, @var{nf}, @var{lambda}] =} sqp (@var{x}, @var{phi}, @var{g}, @var{h}) +## @deftypefn {Function File} address@hidden, @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 ## @@ -130,6 +131,17 @@ ## [ dx_1 dx_2 dx_N ] ## @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 address@hidden 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}: ##