Mercurial > octave-nkf

comparison scripts/ode/private/ode_struct_value_check.m @ 20580:25623ef2ff4f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Rewrite docstrings for ode* family of functions. * scripts/ode/module.mk: Remove extra newline. * ode45.m, odeget.m, odeset.m: Rewrite docstrings. * AbsRel_Norm.m, fuzzy_compare.m, hermite_quartic_interpolation.m, integrate_adaptive.m, integrate_const.m, integrate_n_steps.m, kahan.m, ode_struct_value_check.m, odepkg_event_handle.m, odepkg_structure_check.m, runge_kutta_45_dorpri.m, starting_stepsize.m: Don't break @deftypefn lines. Wrap lines at 80 columns rather than 72.
author Rik <rik@octave.org>
date Sat, 03 Oct 2015 21:03:16 -0700
parents 6256f6e366ac
children eb9e2d187ed2
comparison
equal deleted inserted replaced
20579:52ce821a52fd 20580:25623ef2ff4f
16 ## You should have received a copy of the GNU General Public License 16 ## You should have received a copy of the GNU General Public License
17 ## along with Octave; see the file COPYING. If not, see 17 ## along with Octave; see the file COPYING. If not, see
18 ## <http://www.gnu.org/licenses/>. 18 ## <http://www.gnu.org/licenses/>.
19 19
20 ## -*- texinfo -*- 20 ## -*- texinfo -*-
21 ## @deftypefn {Function File} {[@var{}] =} 21 ## @deftypefn {Function File} {[@var{}] =} ode_struct_value_check (@var{arg}, [@var{"solver"}])
22 ## ode_struct_value_check (@var{arg}, [@var{"solver"}])
23 ## 22 ##
24 ## If this function is called with one input argument of type structure array 23 ## If this function is called with one input argument of type structure array
25 ## then check the field names and the field values of the OdePkg structure 24 ## then check the field names and the field values of the OdePkg structure
26 ## @var{arg}. Optionally if this function is called with a second input 25 ## @var{arg}. Optionally if this function is called with a second input
27 ## argument @var{"solver"} of type string that specifies the name of a valid 26 ## argument @var{"solver"} of type string that specifies the name of a valid
28 ## OdePkg solver then a higher level error detection is performed. The function 27 ## OdePkg solver then a higher level error detection is performed. The function
29 ## does not modify any of the field names or field values but terminates with 28 ## does not modify any of the field names or field values but terminates with
30 ## an error if an invalid option or value is found. 29 ## an error if an invalid option or value is found.
31 ## 30 ##
32 ## This function is an OdePkg internal helper function therefore it should 31 ## This function is an OdePkg internal helper function therefore it should
33 ## never be necessary that this function is called directly by a user. 32 ## never be necessary that this function is called directly by a user.