Mercurial > octave
annotate liboctave/numeric/LSODE-opts.in @ 21966:112b20240c87
move docstrings in C++ files out of C strings and into comments
* __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc,
__ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc,
__pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc,
bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc,
dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc,
dlmread.cc, dot.cc, eig.cc, ellipj.cc, error.cc, fft.cc, fft2.cc,
fftn.cc, file-io.cc, filter.cc, find.cc, gammainc.cc, gcd.cc,
getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc,
hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, kron.cc,
load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc,
lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc,
oct-hist.cc, octave-link.cc, ordschur.cc, pager.cc, pinv.cc,
pr-output.cc, profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc,
sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc,
sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc,
time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc,
utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc,
audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc,
convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc,
ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc,
ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc,
ov-oncleanup.cc, ov-range.cc, ov-re-mat.cc, ov-struct.cc,
ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc,
ov-usr-fcn.cc, ov.cc, octave.cc, pt-arg-list.cc, pt-binop.cc,
pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy:
Docstrings are now comments instead of C strings.
* build-aux/mk-opts.pl: Emit docstrings as comments instead of C
strings.
* DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments.
* builtins.h: Include builtin-defun-decls.h unconditionally.
* defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration.
(DEFALIAS): Always expand to nothing.
* defun-dld.h: No special macro expansions for MAKE_BUILTINS.
(DEFUN_DLD): Use FORWARD_DECLARE_FUN.
(DEFUNX_DLD): Use FORWARD_DECLARE_FUNX.
* defun-int.h: No special macro expansions for MAKE_BUILTINS.
(FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros.
(DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass
"external-doc" to DEFINE_FUNX_INSTALLER_FUN.
(DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL,
DEFALIAS_INTERNAL): Delete.
* common.mk (move_if_change_rule): New macro.
(simple_move_if_change_rule): Define using move_if_change_rule.
* find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file
name extension to ".df".
* libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files.
* mkbuiltins: New argument, SRCDIR. Operate directly on source files.
* mkdefs: Delete.
* libinterp/module.mk (BUILT_SOURCES): Update list to contain only
files included in other source files.
(GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete.
(LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here.
(LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from
the list.
(libinterp_EXTRA_DIST): Remove mkdefs from the list.
(FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES.
(DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES.
(SRC_DEFUN_FILES): Rename from SRC_DEF_FILES.
(ALL_DEFUN_FILES): Rename from ALL_DEF_FILES.
(%.df: %.cc): Delete pattern rule.
(libinterp/build-env-features.cc, libinterp/builtins.cc,
libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change.
(libinterp/builtins.cc, libinterp/builtin-defun-decls.h):
Update mkbuiltins command.
($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command.
* liboctave/module.mk (BUILT_SOURCES): Don't include
liboctave-build-info.cc in the list.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Tue, 21 Jun 2016 16:07:51 -0400 |
| parents | 4197fc428c7d |
| children | bac0d6f07a3e |
| rev | line source |
|---|---|
|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
1 # Copyright (C) 2002-2015 John W. Eaton |
| 7017 | 2 # |
| 3 # This file is part of Octave. | |
|
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11574
diff
changeset
|
4 # |
| 7017 | 5 # Octave is free software; you can redistribute it and/or modify it |
| 6 # under the terms of the GNU General Public License as published by the | |
| 7 # Free Software Foundation; either version 3 of the License, or (at | |
| 8 # your option) any later version. | |
|
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11574
diff
changeset
|
9 # |
| 7017 | 10 # Octave is distributed in the hope that it will be useful, but WITHOUT |
| 11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 13 # for more details. | |
|
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11574
diff
changeset
|
14 # |
| 7017 | 15 # You should have received a copy of the GNU General Public License |
| 16 # along with Octave; see the file COPYING. If not, see | |
| 17 # <http://www.gnu.org/licenses/>. | |
| 18 | |
| 3998 | 19 CLASS = "LSODE" |
| 20 | |
| 4044 | 21 INCLUDE = "ODE.h" |
| 22 | |
| 3998 | 23 OPTION |
| 24 NAME = "absolute tolerance" | |
| 4051 | 25 DOC_ITEM |
| 26 Absolute tolerance. May be either vector or scalar. If a vector, it | |
| 27 must match the dimension of the state vector. | |
| 10840 | 28 |
| 4051 | 29 END_DOC_ITEM |
| 3998 | 30 TYPE = "Array<double>" |
| 31 SET_ARG_TYPE = "const $TYPE&" | |
| 32 INIT_BODY | |
|
11574
a83bad07f7e3
attempt better backward compatibility for Array resize functions
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
33 $OPTVAR.resize (dim_vector (1, 1)); |
|
15220
61822c866ba1
use std::numeric_limits<T>::epsilon in C++ code
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
34 $OPTVAR(0) = ::sqrt (std::numeric_limits<double>::epsilon ()); |
| 3998 | 35 END_INIT_BODY |
| 36 SET_CODE | |
| 37 void set_$OPT (double val) | |
| 38 { | |
|
11574
a83bad07f7e3
attempt better backward compatibility for Array resize functions
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
39 $OPTVAR.resize (dim_vector (1, 1)); |
|
15220
61822c866ba1
use std::numeric_limits<T>::epsilon in C++ code
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
40 $OPTVAR(0) = (val > 0.0) ? val : ::sqrt (std::numeric_limits<double>::epsilon ()); |
| 4049 | 41 reset = true; |
| 3998 | 42 } |
| 43 | |
| 44 void set_$OPT (const $TYPE& val) | |
| 4049 | 45 { $OPTVAR = val; reset = true; } |
| 3998 | 46 END_SET_CODE |
| 47 END_OPTION | |
| 48 | |
| 49 OPTION | |
| 4051 | 50 NAME = "relative tolerance" |
| 51 DOC_ITEM | |
| 52 Relative tolerance parameter. Unlike the absolute tolerance, this | |
| 53 parameter may only be a scalar. | |
| 54 | |
| 55 The local error test applied at each integration step is | |
| 56 | |
| 57 @example | |
|
9067
8970b4b10e9f
Cleanup documentation for quad.texi and diffeq.texi
Rik <rdrider0-list@yahoo.com>
parents:
7081
diff
changeset
|
58 @group |
| 7081 | 59 abs (local error in x(i)) <= ... |
| 60 rtol * abs (y(i)) + atol(i) | |
|
9067
8970b4b10e9f
Cleanup documentation for quad.texi and diffeq.texi
Rik <rdrider0-list@yahoo.com>
parents:
7081
diff
changeset
|
61 @end group |
| 4051 | 62 @end example |
| 10840 | 63 |
| 4051 | 64 END_DOC_ITEM |
| 65 TYPE = "double" | |
|
15220
61822c866ba1
use std::numeric_limits<T>::epsilon in C++ code
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
66 INIT_VALUE = "::sqrt (std::numeric_limits<double>::epsilon ())" |
|
61822c866ba1
use std::numeric_limits<T>::epsilon in C++ code
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
67 SET_EXPR = "(val > 0.0) ? val : ::sqrt (std::numeric_limits<double>::epsilon ())" |
| 4051 | 68 END_OPTION |
| 69 | |
| 70 OPTION | |
| 3998 | 71 NAME = "integration method" |
| 4231 | 72 DOC_ITEM |
| 7007 | 73 A string specifying the method of integration to use to solve the ODE |
| 4051 | 74 system. Valid values are |
| 75 | |
| 76 @table @asis | |
|
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
77 @item @qcode{"adams"} |
|
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
78 @itemx @qcode{"non-stiff"} |
| 4051 | 79 No Jacobian used (even if it is available). |
| 10840 | 80 |
|
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
81 @item @qcode{"bdf"} |
|
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
82 @itemx @qcode{"stiff"} |
| 4051 | 83 Use stiff backward differentiation formula (BDF) method. If a |
| 84 function to compute the Jacobian is not supplied, @code{lsode} will | |
| 85 compute a finite difference approximation of the Jacobian matrix. | |
| 86 @end table | |
| 10840 | 87 |
| 4051 | 88 END_DOC_ITEM |
| 3998 | 89 TYPE = "std::string" |
| 90 SET_ARG_TYPE = "const $TYPE&" | |
| 91 INIT_VALUE = ""stiff"" | |
| 92 SET_BODY | |
| 93 if (val == "stiff" || val == "bdf") | |
| 94 $OPTVAR = "stiff"; | |
| 95 else if (val == "non-stiff" || val == "adams") | |
| 96 $OPTVAR = "non-stiff"; | |
| 97 else | |
| 98 (*current_liboctave_error_handler) | |
| 99 ("lsode_options: method must be \"stiff\", \"bdf\", \"non-stiff\", or \"adams\""); | |
| 100 END_SET_BODY | |
| 101 END_OPTION | |
| 102 | |
| 103 OPTION | |
| 104 NAME = "initial step size" | |
| 4051 | 105 DOC_ITEM |
| 106 The step size to be attempted on the first step (default is determined | |
| 107 automatically). | |
| 10840 | 108 |
| 4051 | 109 END_DOC_ITEM |
| 3998 | 110 TYPE = "double" |
| 111 INIT_VALUE = "-1.0" | |
| 112 SET_EXPR = "(val >= 0.0) ? val : -1.0" | |
| 113 END_OPTION | |
| 114 | |
| 115 OPTION | |
| 4231 | 116 NAME = "maximum order" |
| 117 DOC_ITEM | |
| 118 Restrict the maximum order of the solution method. If using the Adams | |
| 119 method, this option must be between 1 and 12. Otherwise, it must be | |
| 120 between 1 and 5, inclusive. | |
| 10840 | 121 |
| 4231 | 122 END_DOC_ITEM |
| 5275 | 123 TYPE = "octave_idx_type" |
| 4231 | 124 INIT_VALUE = "-1" |
| 125 SET_EXPR = "val" | |
| 126 END_OPTION | |
| 127 | |
| 128 OPTION | |
| 3998 | 129 NAME = "maximum step size" |
| 4051 | 130 DOC_ITEM |
| 131 Setting the maximum stepsize will avoid passing over very large | |
| 132 regions (default is not specified). | |
| 10840 | 133 |
| 4051 | 134 END_DOC_ITEM |
| 3998 | 135 TYPE = "double" |
| 136 INIT_VALUE = "-1.0" | |
| 137 SET_EXPR = "(val >= 0.0) ? val : -1.0" | |
| 138 END_OPTION | |
| 139 | |
| 140 OPTION | |
| 141 NAME = "minimum step size" | |
| 4051 | 142 DOC_ITEM |
| 143 The minimum absolute step size allowed (default is 0). | |
| 10840 | 144 |
| 4051 | 145 END_DOC_ITEM |
| 3998 | 146 TYPE = "double" |
| 147 INIT_VALUE = "0.0" | |
| 148 SET_EXPR = "(val >= 0.0) ? val : 0.0" | |
| 149 END_OPTION | |
| 150 | |
| 151 OPTION | |
| 152 NAME = "step limit" | |
| 4051 | 153 DOC_ITEM |
| 154 Maximum number of steps allowed (default is 100000). | |
| 155 END_DOC_ITEM | |
| 5275 | 156 TYPE = "octave_idx_type" |
| 3998 | 157 INIT_VALUE = "100000" |
| 158 SET_EXPR = "val" | |
| 159 END_OPTION |