Mercurial > hg > octave-lyh
annotate liboctave/DASSL-opts.in @ 14819:67b6b47a22f6
doc: Clarify docstrings for canonicalize_file_name, make_absolute_filename
* syscalls.cc (canonicalize_file_name): Clarify docstring.
* utils.cc (make_absolute_filename): Clarify docstring.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Fri, 29 Jun 2012 13:38:28 -0700 |
| parents | 72c96de7a403 |
| children | 61822c866ba1 |
| rev | line source |
|---|---|
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
1 # Copyright (C) 2002-2012 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 = "DASSL" |
| 20 | |
| 4044 | 21 INCLUDE = "DAE.h" |
| 22 | |
| 3998 | 23 OPTION |
| 24 NAME = "absolute tolerance" | |
| 4050 | 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, and the relative | |
| 28 tolerance must also be a vector of the same length. | |
| 10840 | 29 |
| 4050 | 30 END_DOC_ITEM |
| 3998 | 31 TYPE = "Array<double>" |
| 32 SET_ARG_TYPE = "const $TYPE&" | |
| 33 INIT_BODY | |
|
11574
a83bad07f7e3
attempt better backward compatibility for Array resize functions
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
34 $OPTVAR.resize (dim_vector (1, 1)); |
| 3998 | 35 $OPTVAR(0) = ::sqrt (DBL_EPSILON); |
| 36 END_INIT_BODY | |
| 37 SET_CODE | |
| 38 void set_$OPT (double val) | |
| 39 { | |
|
11574
a83bad07f7e3
attempt better backward compatibility for Array resize functions
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
40 $OPTVAR.resize (dim_vector (1, 1)); |
| 3998 | 41 $OPTVAR(0) = (val > 0.0) ? val : ::sqrt (DBL_EPSILON); |
| 4049 | 42 reset = true; |
| 3998 | 43 } |
| 44 | |
| 45 void set_$OPT (const $TYPE& val) | |
| 4049 | 46 { $OPTVAR = val; reset = true; } |
| 3998 | 47 END_SET_CODE |
| 48 END_OPTION | |
| 49 | |
| 50 OPTION | |
| 51 NAME = "relative tolerance" | |
| 4050 | 52 DOC_ITEM |
| 53 Relative tolerance. May be either vector or scalar. If a vector, it | |
| 54 must match the dimension of the state vector, and the absolute | |
| 55 tolerance must also be a vector of the same length. | |
| 56 | |
| 57 The local error test applied at each integration step is | |
| 4051 | 58 |
| 4050 | 59 @example |
|
9067
8970b4b10e9f
Cleanup documentation for quad.texi and diffeq.texi
Rik <rdrider0-list@yahoo.com>
parents:
7017
diff
changeset
|
60 @group |
| 5016 | 61 abs (local error in x(i)) |
| 62 <= rtol(i) * abs (Y(i)) + atol(i) | |
|
9067
8970b4b10e9f
Cleanup documentation for quad.texi and diffeq.texi
Rik <rdrider0-list@yahoo.com>
parents:
7017
diff
changeset
|
63 @end group |
| 4050 | 64 @end example |
| 10840 | 65 |
| 4050 | 66 END_DOC_ITEM |
| 3998 | 67 TYPE = "Array<double>" |
| 68 SET_ARG_TYPE = "const $TYPE&" | |
| 69 INIT_BODY | |
|
11574
a83bad07f7e3
attempt better backward compatibility for Array resize functions
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
70 $OPTVAR.resize (dim_vector (1, 1)); |
| 3998 | 71 $OPTVAR(0) = ::sqrt (DBL_EPSILON); |
| 72 END_INIT_BODY | |
| 73 SET_CODE | |
| 74 void set_$OPT (double val) | |
| 75 { | |
|
11574
a83bad07f7e3
attempt better backward compatibility for Array resize functions
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
76 $OPTVAR.resize (dim_vector (1, 1)); |
| 3998 | 77 $OPTVAR(0) = (val > 0.0) ? val : ::sqrt (DBL_EPSILON); |
| 4049 | 78 reset = true; |
| 3998 | 79 } |
| 80 | |
| 81 void set_$OPT (const $TYPE& val) | |
| 4049 | 82 { $OPTVAR = val; reset = true; } |
| 3998 | 83 END_SET_CODE |
| 84 END_OPTION | |
| 85 | |
| 86 OPTION | |
| 4047 | 87 NAME = "compute consistent initial condition" |
| 4050 | 88 DOC_ITEM |
| 7007 | 89 If nonzero, @code{dassl} will attempt to compute a consistent set of initial |
| 4050 | 90 conditions. This is generally not reliable, so it is best to provide |
| 91 a consistent set and leave this option set to zero. | |
| 10840 | 92 |
| 4050 | 93 END_DOC_ITEM |
| 5275 | 94 TYPE = "octave_idx_type" |
| 4047 | 95 INIT_VALUE = "0" |
| 96 SET_EXPR = "val" | |
| 97 END_OPTION | |
| 98 | |
| 99 OPTION | |
| 100 NAME = "enforce nonnegativity constraints" | |
| 4050 | 101 DOC_ITEM |
| 102 If you know that the solutions to your equations will always be | |
|
10711
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10350
diff
changeset
|
103 non-negative, it may help to set this parameter to a nonzero |
| 4050 | 104 value. However, it is probably best to try leaving this option set to |
| 105 zero first, and only setting it to a nonzero value if that doesn't | |
| 106 work very well. | |
| 10840 | 107 |
| 4050 | 108 END_DOC_ITEM |
| 5275 | 109 TYPE = "octave_idx_type" |
| 4047 | 110 INIT_VALUE = "0" |
| 111 SET_EXPR = "val" | |
| 112 END_OPTION | |
| 113 | |
| 114 OPTION | |
| 3998 | 115 NAME = "initial step size" |
| 4050 | 116 DOC_ITEM |
| 7001 | 117 Differential-algebraic problems may occasionally suffer from severe |
| 4050 | 118 scaling difficulties on the first step. If you know a great deal |
| 119 about the scaling of your problem, you can help to alleviate this | |
| 120 problem by specifying an initial stepsize. | |
| 10840 | 121 |
| 4050 | 122 END_DOC_ITEM |
| 3998 | 123 TYPE = "double" |
| 124 INIT_VALUE = "-1.0" | |
| 125 SET_EXPR = "(val >= 0.0) ? val : -1.0" | |
| 126 END_OPTION | |
| 127 | |
| 128 OPTION | |
| 4044 | 129 NAME = "maximum order" |
| 4050 | 130 DOC_ITEM |
| 131 Restrict the maximum order of the solution method. This option must | |
| 132 be between 1 and 5, inclusive. | |
| 10840 | 133 |
| 4050 | 134 END_DOC_ITEM |
| 5275 | 135 TYPE = "octave_idx_type" |
| 4044 | 136 INIT_VALUE = "-1" |
| 137 SET_EXPR = "val" | |
| 138 END_OPTION | |
| 139 | |
| 140 OPTION | |
| 3998 | 141 NAME = "maximum step size" |
| 4050 | 142 DOC_ITEM |
| 143 Setting the maximum stepsize will avoid passing over very large | |
| 4051 | 144 regions (default is not specified). |
| 10840 | 145 |
| 4050 | 146 END_DOC_ITEM |
| 3998 | 147 TYPE = "double" |
| 148 INIT_VALUE = "-1.0" | |
| 149 SET_EXPR = "(val >= 0.0) ? val : -1.0" | |
| 150 END_OPTION | |
| 4429 | 151 |
| 152 OPTION | |
| 153 NAME = "step limit" | |
| 154 DOC_ITEM | |
| 155 Maximum number of integration steps to attempt on a single call to the | |
| 156 underlying Fortran code. | |
| 157 END_DOC_ITEM | |
| 5275 | 158 TYPE = "octave_idx_type" |
| 4429 | 159 INIT_VALUE = "-1" |
| 160 SET_EXPR = "(val >= 0) ? val : -1" | |
| 161 END_OPTION |