annotate liboctave/NLEqn-opts.in @ 7334:274d9642ac10 release-3-0-0

[project @ 2007-12-22 01:42:45 by jwe]
author jwe
date Sat, 22 Dec 2007 01:42:46 +0000
parents a1dbe9d80eee
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
1 # Copyright (C) 2002 John W. Eaton
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
2 #
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
3 # This file is part of Octave.
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
4 #
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
5 # Octave is free software; you can redistribute it and/or modify it
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
6 # under the terms of the GNU General Public License as published by the
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
7 # Free Software Foundation; either version 3 of the License, or (at
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
8 # your option) any later version.
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
9 #
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
10 # Octave is distributed in the hope that it will be useful, but WITHOUT
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
13 # for more details.
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
14 #
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
15 # You should have received a copy of the GNU General Public License
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
16 # along with Octave; see the file COPYING. If not, see
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
17 # <http://www.gnu.org/licenses/>.
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 4050
diff changeset
18
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
19 CLASS = "NLEqn"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
20
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
21 FCN_NAME = "fsolve"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
22
4044
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
23 INCLUDE = "dColVector.h"
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
24 INCLUDE = "NLFunc.h"
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
25
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
26
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
27 DOC_STRING
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
28 When called with two arguments, this function allows you set options
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
29 parameters for the function @code{fsolve}. Given one argument,
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
30 @code{fsolve_options} returns the value of the corresponding option. If
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
31 no arguments are supplied, the names of all the available options and
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
32 their current values are displayed.
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
33 END_DOC_STRING
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
34
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
35 OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
36 NAME = "tolerance"
4050
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4044
diff changeset
37 DOC_ITEM
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4044
diff changeset
38 Nonnegative relative tolerance.
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4044
diff changeset
39 END_DOC_ITEM
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
40 TYPE = "double"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
41 INIT_VALUE = "::sqrt (DBL_EPSILON)"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
42 SET_EXPR = "(val > 0.0) ? val : ::sqrt (DBL_EPSILON)"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
43 END_OPTION