annotate liboctave/NLEqn-opts.in @ 5018:1c65a8e44ef9 ss-2-1-59

[project @ 2004-09-22 03:33:29 by jwe]
author jwe
date Wed, 22 Sep 2004 03:33:29 +0000
parents 6481f41a79f3
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
1 CLASS = "NLEqn"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
2
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
3 FCN_NAME = "fsolve"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
4
4044
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
5 INCLUDE = "dColVector.h"
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
6 INCLUDE = "NLFunc.h"
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
7
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
8
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
9 DOC_STRING
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
10 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
11 parameters for the function @code{fsolve}. Given one argument,
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
12 @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
13 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
14 their current values are displayed.
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
15 END_DOC_STRING
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
16
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
17 OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
18 NAME = "tolerance"
4050
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4044
diff changeset
19 DOC_ITEM
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4044
diff changeset
20 Nonnegative relative tolerance.
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4044
diff changeset
21 END_DOC_ITEM
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
22 TYPE = "double"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
23 INIT_VALUE = "::sqrt (DBL_EPSILON)"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
24 SET_EXPR = "(val > 0.0) ? val : ::sqrt (DBL_EPSILON)"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
25 END_OPTION