comparison liboctave/numeric/LSODE-opts.in @ 31253:a40c0b7aa376

maint: changes to follow Octave coding conventions. * NEWS.8.md: Wrap lines to 72 chars. * LSODE-opts.in: Use two spaces after sentence ending period. * LSODE.cc: Use minimum of two spaces between code and start of comment. * MemoizedFunction.m: Change copyright date to 2022 since this is the year it was accepted into core. Don't wrap error() lines to 80 chars. Use newlines to improve readability of switch statements. Use minimum of two spaces between code and start of comment. * del2.m, integral.m, interp1.m, interp2.m, griddata.m, inpolygon.m, waitbar.m, cubehelix.m, ind2x.m, importdata.m, textread.m, logm.m, lighting.m, shading.m, xticklabels.m, yticklabels.m, zticklabels.m, colorbar.m, meshc.m, print.m, __gnuplot_draw_axes__.m, struct2hdl.m, ppval.m, ismember.m, iqr.m: Use a space between comment character '#' and start of comment. Use hyphen for adjectives describing dimensions such as "1-D". * vectorize.m, ode23s.m: Use is_function_handle() instead of "isa (x, "function_handle")" for clarity and performance. * clearAllMemoizedCaches.m: Change copyright date to 2022 since this is the year it was accepted into core. Remove input validation which is done by interpreter. Use two newlines between end of code and start of BIST tests. * memoize.m: Change copyright date to 2022 since this is the year it was accepted into core. Re-wrap documentation to 80 chars. Use is_function_handle() instead of "isa (x, "function_handle")" for clarity and performance. Use two newlines between end of code and start of BIST tests. Use semicolon for assert statements within %!test block. Re-write BIST tests for input validation. * __memoize__.m: Change copyright date to 2022 since this is the year it was accepted into core. Use spaces in for statements to improve readability. * unique.m: Add FIXME note to commented BIST test * dec2bin.m: Remove stray newline at end of file. * triplequad.m: Reduce doubly-commented BIST syntax using "#%!#" to "#%!". * delaunayn.m: Use input variable names in error() statements. Use minimum of two spaces between code and start of comment. Use hyphen for describing dimensions. Use two newlines between end of code and start of BIST tests. Update BIST tests to pass.
author Rik <rik@octave.org>
date Mon, 03 Oct 2022 18:06:55 -0700
parents de6fc38c78c6
children 96f751f8392c
comparison
equal deleted inserted replaced
31252:e78f6e2aa807 31253:a40c0b7aa376
167 167
168 OPTION 168 OPTION
169 NAME = "jacobian type" 169 NAME = "jacobian type"
170 DOC_ITEM 170 DOC_ITEM
171 A string specifying the type of Jacobian used with the stiff backward 171 A string specifying the type of Jacobian used with the stiff backward
172 differentiation formula (BDF) integration method. Valid values are 172 differentiation formula (BDF) integration method. Valid values are
173 173
174 @table @asis 174 @table @asis
175 @item @qcode{"full"} 175 @item @qcode{"full"}
176 The default. All partial derivatives are approximated or used from the 176 The default. All partial derivatives are approximated or used from the
177 user-supplied Jacobian function. 177 user-supplied Jacobian function.
178 178
179 @item @qcode{"banded"} 179 @item @qcode{"banded"}
180 Only the diagonal and the number of lower and upper subdiagonals specified by 180 Only the diagonal and the number of lower and upper subdiagonals specified by
181 the options @qcode{"lower jacobian subdiagonals"} and @qcode{"upper jacobian 181 the options @qcode{"lower jacobian subdiagonals"} and @qcode{"upper jacobian
182 subdiagonals"}, respectively, are approximated or used from the user-supplied 182 subdiagonals"}, respectively, are approximated or used from the user-supplied
183 Jacobian function. A user-supplied Jacobian function may set all other 183 Jacobian function. A user-supplied Jacobian function may set all other
184 partial derivatives to arbitrary values. 184 partial derivatives to arbitrary values.
185 185
186 @item @qcode{"diagonal"} 186 @item @qcode{"diagonal"}
187 If a Jacobian function is supplied by the user, this setting has no effect. 187 If a Jacobian function is supplied by the user, this setting has no effect.
188 A Jacobian approximated by @code{lsode} is restricted to the diagonal, where 188 A Jacobian approximated by @code{lsode} is restricted to the diagonal, where
207 207
208 OPTION 208 OPTION
209 NAME = "lower jacobian subdiagonals" 209 NAME = "lower jacobian subdiagonals"
210 DOC_ITEM 210 DOC_ITEM
211 Number of lower subdiagonals used if option @qcode{"jacobian type"} is set to 211 Number of lower subdiagonals used if option @qcode{"jacobian type"} is set to
212 @qcode{"banded"}. The default is zero. 212 @qcode{"banded"}. The default is zero.
213 213
214 END_DOC_ITEM 214 END_DOC_ITEM
215 TYPE = "octave_idx_type" 215 TYPE = "octave_idx_type"
216 INIT_VALUE = "0" 216 INIT_VALUE = "0"
217 SET_EXPR = "val" 217 SET_EXPR = "val"
219 219
220 OPTION 220 OPTION
221 NAME = "upper jacobian subdiagonals" 221 NAME = "upper jacobian subdiagonals"
222 DOC_ITEM 222 DOC_ITEM
223 Number of upper subdiagonals used if option @qcode{"jacobian type"} is set to 223 Number of upper subdiagonals used if option @qcode{"jacobian type"} is set to
224 @qcode{"banded"}. The default is zero. 224 @qcode{"banded"}. The default is zero.
225 225
226 END_DOC_ITEM 226 END_DOC_ITEM
227 TYPE = "octave_idx_type" 227 TYPE = "octave_idx_type"
228 INIT_VALUE = "0" 228 INIT_VALUE = "0"
229 SET_EXPR = "val" 229 SET_EXPR = "val"