Mercurial > hg > octave-nkf

comparison scripts/optimization/fsolve.m @ 8514:39867b4aca52

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fsolve.m: additional doc fix
author John W. Eaton <jwe@octave.org>
date Wed, 14 Jan 2009 15:58:20 -0500
parents 352d3245d4c1
children ec2715c76039
comparison
equal deleted inserted replaced
8513:352d3245d4c1 8514:39867b4aca52
23 ## @deftypefnx{Function File} {[@var{x}, @var{fvec}, @var{info}, @var{output}, @var{fjac}]} = fsolve (@var{fcn}, @dots{}) 23 ## @deftypefnx{Function File} {[@var{x}, @var{fvec}, @var{info}, @var{output}, @var{fjac}]} = fsolve (@var{fcn}, @dots{})
24 ## Solve a system of nonlinear equations defined by the function @var{fcn}. 24 ## Solve a system of nonlinear equations defined by the function @var{fcn}.
25 ## @var{fcn} should accepts a vector (array) defining the unknown variables, 25 ## @var{fcn} should accepts a vector (array) defining the unknown variables,
26 ## and return a vector of left-hand sides of the equations. Right-hand sides 26 ## and return a vector of left-hand sides of the equations. Right-hand sides
27 ## are defined to be zeros. 27 ## are defined to be zeros.
28 ## In other words, this function attempts to determine a vector @var{X} such 28 ## In other words, this function attempts to determine a vector @var{x} such
29 ## that @code{@var{fcn}(@var{X})} gives (approximately) all zeros. 29 ## that @code{@var{fcn} (@var{x})} gives (approximately) all zeros.
30 ## @var{x0} determines a starting guess. The shape of @var{x0} is preserved 30 ## @var{x0} determines a starting guess. The shape of @var{x0} is preserved
31 ## in all calls to @var{fcn}, but otherwise it is treated as a column vector. 31 ## in all calls to @var{fcn}, but otherwise it is treated as a column vector.
32 ## @var{options} is a structure specifying additional options. Currently, fsolve 32 ## @var{options} is a structure specifying additional options. Currently, fsolve
33 ## recognizes these options: @code{"FunValCheck"}, @code{"OutputFcn"}, 33 ## recognizes these options: @code{"FunValCheck"}, @code{"OutputFcn"},
34 ## @code{"TolX"}, @code{"TolFun"}, @code{"MaxIter"}, 34 ## @code{"TolX"}, @code{"TolFun"}, @code{"MaxIter"},
35 ## @code{"MaxFunEvals"} and @code{"Jacobian"}. 35 ## @code{"MaxFunEvals"}, and @code{"Jacobian"}.
36 ## 36 ##
37 ## If @code{"Jacobian"} is @code{"on"}, it specifies that @var{fcn}, 37 ## If @code{"Jacobian"} is @code{"on"}, it specifies that @var{fcn},
38 ## called with 2 output arguments, also returns the Jacobian matrix 38 ## called with 2 output arguments, also returns the Jacobian matrix
39 ## of right-hand sides at the requested point. @code{"TolX"} specifies 39 ## of right-hand sides at the requested point. @code{"TolX"} specifies
40 ## the termination tolerance in the unknown variables, while 40 ## the termination tolerance in the unknown variables, while