File: NLEqn-opts.in

package info (click to toggle)
octave3.0 1%3A3.0.1-6lenny3
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 49,912 kB
  • ctags: 27,149
  • sloc: cpp: 166,567; fortran: 61,399; ansic: 8,766; sh: 5,856; lex: 4,419; makefile: 3,965; yacc: 3,013; lisp: 1,692; objc: 889; perl: 795; awk: 532
file content (43 lines) | stat: -rw-r--r-- 1,348 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# 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