Mercurial > hg > octave-lyh
view liboctave/NLEqn-opts.in @ 7875:bff8dbc1be11
mlock: doc fix
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 06 Jun 2008 11:35:10 -0400 |
parents | a1dbe9d80eee |
children |
line wrap: on
line source
# Copyright (C) 2002 John W. Eaton # # This file is part of Octave. # # Octave is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License as published by the # Free Software Foundation; either version 3 of the License, or (at # your option) any later version. # # Octave is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License # for more details. # # You should have received a copy of the GNU General Public License # along with Octave; see the file COPYING. If not, see # <http://www.gnu.org/licenses/>. CLASS = "NLEqn" FCN_NAME = "fsolve" INCLUDE = "dColVector.h" INCLUDE = "NLFunc.h" DOC_STRING When called with two arguments, this function allows you set options parameters for the function @code{fsolve}. Given one argument, @code{fsolve_options} returns the value of the corresponding option. If no arguments are supplied, the names of all the available options and their current values are displayed. END_DOC_STRING OPTION NAME = "tolerance" DOC_ITEM Nonnegative relative tolerance. END_DOC_ITEM TYPE = "double" INIT_VALUE = "::sqrt (DBL_EPSILON)" SET_EXPR = "(val > 0.0) ? val : ::sqrt (DBL_EPSILON)" END_OPTION