Mercurial > hg > octave-lyh

comparison scripts/optimization/fsolve.m @ 14143:04dcbb8fb880 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fsolve.m: Move @seealso to bottom in docstring to silence warning.
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Tue, 03 Jan 2012 12:03:12 -0500
parents 72c96de7a403
children f3d52523cde1
comparison
equal deleted inserted replaced
14140:6aa14605c6c0 14143:04dcbb8fb880
84 ## The trust region radius became excessively small. 84 ## The trust region radius became excessively small.
85 ## @end table 85 ## @end table
86 ## 86 ##
87 ## Note: If you only have a single nonlinear equation of one variable, using 87 ## Note: If you only have a single nonlinear equation of one variable, using
88 ## @code{fzero} is usually a much better idea. 88 ## @code{fzero} is usually a much better idea.
89 ## @seealso{fzero, optimset}
90 ## 89 ##
91 ## Note about user-supplied Jacobians: 90 ## Note about user-supplied Jacobians:
92 ## As an inherent property of the algorithm, Jacobian is always requested for a 91 ## As an inherent property of the algorithm, Jacobian is always requested for a
93 ## solution vector whose residual vector is already known, and it is the last 92 ## solution vector whose residual vector is already known, and it is the last
94 ## accepted successful step. Often this will be one of the last two calls, but 93 ## accepted successful step. Often this will be one of the last two calls, but
119 ## endif 118 ## endif
120 ## ## maybe output iteration status, etc. 119 ## ## maybe output iteration status, etc.
121 ## endif 120 ## endif
122 ## endfunction 121 ## endfunction
123 ## 122 ##
124 ## ## @dots{}. 123 ## ## @dots{}
125 ## 124 ##
126 ## fsolve (@@user_func, x0, optimset ("OutputFcn", @@user_func, @dots{})) 125 ## fsolve (@@user_func, x0, optimset ("OutputFcn", @@user_func, @dots{}))
127 ## @end example 126 ## @end example
127 ## @seealso{fzero, optimset}
128 ## @end deftypefn 128 ## @end deftypefn
129 129
130 ## PKG_ADD: ## Discard result to avoid polluting workspace with ans at startup. 130 ## PKG_ADD: ## Discard result to avoid polluting workspace with ans at startup.
131 ## PKG_ADD: [~] = __all_opts__ ("fsolve"); 131 ## PKG_ADD: [~] = __all_opts__ ("fsolve");
132 132