Mercurial > octave-nkf
view liboctave/LSODE-opts.in @ 8828:8463d1a2e544
Doc fixes.
* 2]$$. => 2].$$
* @var{extrapval} => @var{extrapval}.
* call helloworld.oct => called @file{helloworld.oct}
* @itemize => @table @code
* shows. => shows:
* save => @code{save}
* @ref{Breakpoints} => @pxref{Breakpoints}
* add @noindent following example
* which is computed => and compute it
* clarify wording
* remove comma
* good => well
* set => number
* by writing => with the command
* has the option of directly calling => can call
* [-like-] {+of the right size,+}
* solvers => routines
* handle => test for
* add introductory section
* add following
* {+the+} [0..bitmax] => [0,bitmax]
* of the => with
* number => value
* add usual
* Besides when doing comparisons, logical => Logical {+also+}
* array comparison => array, comparisons
* param => parameter
* works very similar => is similar
* strings, => strings
* most simple => simplest
* easier => more easily
* like => as
* called => called,
* clarify wording
* you should simply type => use
* clarify wording
* means => way
* equally => also
* [-way much-] {+way+}
* add with mean value parameter given by the first argument, @var{l}
* add Functions described as @dfn{mapping functions} apply the given
operation to each element when given a matrix argument.
* in this brief introduction => here
* It is worth noticing => Note
* add following
* means => ways
author | Brian Gough <bjg@network-theory.co.uk> |
---|---|
date | Fri, 20 Feb 2009 11:17:01 -0500 |
parents | 503001863427 |
children | 8970b4b10e9f |
line wrap: on
line source
# Copyright (C) 2002, 2005, 2007 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 = "LSODE" INCLUDE = "ODE.h" OPTION NAME = "absolute tolerance" DOC_ITEM Absolute tolerance. May be either vector or scalar. If a vector, it must match the dimension of the state vector. END_DOC_ITEM TYPE = "Array<double>" SET_ARG_TYPE = "const $TYPE&" INIT_BODY $OPTVAR.resize (1); $OPTVAR(0) = ::sqrt (DBL_EPSILON); END_INIT_BODY SET_CODE void set_$OPT (double val) { $OPTVAR.resize (1); $OPTVAR(0) = (val > 0.0) ? val : ::sqrt (DBL_EPSILON); reset = true; } void set_$OPT (const $TYPE& val) { $OPTVAR = val; reset = true; } END_SET_CODE END_OPTION OPTION NAME = "relative tolerance" DOC_ITEM Relative tolerance parameter. Unlike the absolute tolerance, this parameter may only be a scalar. The local error test applied at each integration step is @example abs (local error in x(i)) <= ... rtol * abs (y(i)) + atol(i) @end example END_DOC_ITEM TYPE = "double" INIT_VALUE = "::sqrt (DBL_EPSILON)" SET_EXPR = "(val > 0.0) ? val : ::sqrt (DBL_EPSILON)" END_OPTION OPTION NAME = "integration method" DOC_ITEM A string specifying the method of integration to use to solve the ODE system. Valid values are @table @asis @item \"adams\" @itemx \"non-stiff\" No Jacobian used (even if it is available). @item \"bdf\" @item \"stiff\" Use stiff backward differentiation formula (BDF) method. If a function to compute the Jacobian is not supplied, @code{lsode} will compute a finite difference approximation of the Jacobian matrix. @end table END_DOC_ITEM TYPE = "std::string" SET_ARG_TYPE = "const $TYPE&" INIT_VALUE = ""stiff"" SET_BODY if (val == "stiff" || val == "bdf") $OPTVAR = "stiff"; else if (val == "non-stiff" || val == "adams") $OPTVAR = "non-stiff"; else (*current_liboctave_error_handler) ("lsode_options: method must be \"stiff\", \"bdf\", \"non-stiff\", or \"adams\""); END_SET_BODY END_OPTION OPTION NAME = "initial step size" DOC_ITEM The step size to be attempted on the first step (default is determined automatically). END_DOC_ITEM TYPE = "double" INIT_VALUE = "-1.0" SET_EXPR = "(val >= 0.0) ? val : -1.0" END_OPTION OPTION NAME = "maximum order" DOC_ITEM Restrict the maximum order of the solution method. If using the Adams method, this option must be between 1 and 12. Otherwise, it must be between 1 and 5, inclusive. END_DOC_ITEM TYPE = "octave_idx_type" INIT_VALUE = "-1" SET_EXPR = "val" END_OPTION OPTION NAME = "maximum step size" DOC_ITEM Setting the maximum stepsize will avoid passing over very large regions (default is not specified). END_DOC_ITEM TYPE = "double" INIT_VALUE = "-1.0" SET_EXPR = "(val >= 0.0) ? val : -1.0" END_OPTION OPTION NAME = "minimum step size" DOC_ITEM The minimum absolute step size allowed (default is 0). END_DOC_ITEM TYPE = "double" INIT_VALUE = "0.0" SET_EXPR = "(val >= 0.0) ? val : 0.0" END_OPTION OPTION NAME = "step limit" DOC_ITEM Maximum number of steps allowed (default is 100000). END_DOC_ITEM TYPE = "octave_idx_type" INIT_VALUE = "100000" SET_EXPR = "val" END_OPTION