Mercurial > octave-nkf

comparison scripts/ode/private/odepkg_structure_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 fcb792acab9b
children eb9e2d187ed2
comparison
equal deleted inserted replaced
20579:52ce821a52fd 20580:25623ef2ff4f
13 %# GNU General Public License for more details. 13 %# GNU General Public License for more details.
14 %# 14 %#
15 %# You should have received a copy of the GNU General Public License 15 %# You should have received a copy of the GNU General Public License
16 %# along with this program; If not, see <http://www.gnu.org/licenses/>. 16 %# along with this program; If not, see <http://www.gnu.org/licenses/>.
17 17
18 %# -*- texinfo -*- 18 ## -*- texinfo -*-
19 %# @deftypefn {Function File} {[@var{newstruct}] =} odepkg_structure_check (@var{oldstruct}, [@var{"solver"}]) 19 ## @deftypefn {Function File} {[@var{newstruct}] =} odepkg_structure_check (@var{oldstruct}, [@var{"solver"}])
20 %# 20 ##
21 %# If this function is called with one input argument of type structure array then check the field names and the field values of the OdePkg structure @var{oldstruct} and return the structure as @var{newstruct} if no error is found. Optionally if this function is called with a second input argument @var{"solver"} of type string taht specifies the name of a valid OdePkg solver then a higher level error detection is performed. The function does not modify any of the field names or field values but terminates with an error if an invalid option or value is found. 21 ## If this function is called with one input argument of type structure array
22 %# 22 ## then check the field names and the field values of the OdePkg structure
23 %# This function is an OdePkg internal helper function therefore it should never be necessary that this function is called directly by a user. There is only little error detection implemented in this function file to achieve the highest performance. 23 ## @var{oldstruct} and return the structure as @var{newstruct} if no error is
24 %# 24 ## found.
25 %# Run examples with the command 25 ##
26 %# @example 26 ## Optionally if this function is called with a second input argument
27 %# demo odepkg_structure_check 27 ## @var{"solver"} of type string taht specifies the name of a valid OdePkg
28 %# @end example 28 ## solver then a higher level error detection is performed. The function
29 %# @end deftypefn 29 ## does not modify any of the field names or field values but terminates with
30 %# 30 ## an error if an invalid option or value is found.
31 %# @seealso{odepkg} 31 ##
32 ## This function is an OdePkg internal helper function therefore it should
33 ## never be necessary that this function is called directly by a user. There
34 ## is only little error detection implemented in this function file to
35 ## achieve the highest performance.
36 ##
37 ## Run examples with the command
38 ##
39 ## @example
40 ## demo odepkg_structure_check
41 ## @end example
42 ## @end deftypefn
43 ##
44 ## @seealso{odepkg}
32 45
33 function [vret] = odepkg_structure_check (varargin) 46 function [vret] = odepkg_structure_check (varargin)
34 47
35 %# Check the number of input arguments 48 %# Check the number of input arguments
36 if (nargin == 0) 49 if (nargin == 0)