Mercurial > octave-nkf

comparison scripts/ode/private/odepkg_event_handle.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
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 Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {[@var{sol}] =} odepkg_event_handle (@var{@@fun}, @var{time}, @var{y}, @var{flag}, [@var{par1}, @var{par2}, @dots{}]) 20 ## @deftypefn {Function File} {[@var{sol}] =} odepkg_event_handle (@var{@@fun}, @var{time}, @var{y}, @var{flag}, @var{par1}, @var{par2}, @dots{})
21 ## 21 ##
22 ## Return the solution of the event function that is specified as the first input argument @var{@@fun} in form of a function handle. The second input argument @var{time} is of type double scalar and specifies the time of the event evaluation, the third input argument @var{y} either is of type double column vector (for ODEs and DAEs) and specifies the solutions or is of type cell array (for IDEs and DDEs) and specifies the derivatives or the history values, the third input argument @var{flag} is of type string and can be of the form 22 ## Return the solution of the event function that is specified as the first
23 ## input argument @var{@@fun} in form of a function handle.
24 ##
25 ## The second input argument @var{time} is of type double scalar and
26 ## specifies the time of the event evaluation, the third input argument
27 ## @var{y} either is of type double column vector (for ODEs and DAEs) and
28 ## specifies the solutions or is of type cell array (for IDEs and DDEs) and
29 ## specifies the derivatives or the history values, the third input argument
30 ## @var{flag} is of type string and can be of the form
31 ##
23 ## @table @option 32 ## @table @option
24 ## @item @code{"init"} 33 ## @item @qcode{"init"}
25 ## then initialize internal persistent variables of the function @command{odepkg_event_handle} and return an empty cell array of size 4, 34 ## then initialize internal persistent variables of the function
26 ## @item @code{"calc"} 35 ## @command{odepkg_event_handle} and return an empty cell array of size 4,
27 ## then do the evaluation of the event function and return the solution @var{sol} as type cell array of size 4, 36 ##
28 ## @item @code{"done"} 37 ## @item @qcode{"calc"}
29 ## then cleanup internal variables of the function @command{odepkg_event_handle} and return an empty cell array of size 4. 38 ## then do the evaluation of the event function and return the solution
39 ## @var{sol} as type cell array of size 4,
40 ##
41 ## @item @qcode{"done"}
42 ## then cleanup internal variables of the function
43 ## @command{odepkg_event_handle} and return an empty cell array of size 4.
30 ## @end table 44 ## @end table
31 ## Optionally if further input arguments @var{par1}, @var{par2}, @dots{} of any type are given then pass these parameters through @command{odepkg_event_handle} to the event function.
32 ## 45 ##
33 ## 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. 46 ## Optionally if further input arguments @var{par1}, @var{par2}, @dots{} of
47 ## any type are given then pass these parameters through
48 ## @command{odepkg_event_handle} to the event function.
49 ##
50 ## This function is an OdePkg internal helper function therefore it should
51 ## never be necessary that this function is called directly by a user. There
52 ## is only little error detection implemented in this function file to
53 ## achieve the highest performance.
34 ## @end deftypefn 54 ## @end deftypefn
35 ## 55 ##
36 ## @seealso{odepkg} 56 ## @seealso{odepkg}
37 57
38 function [vretval] = odepkg_event_handle (vevefun, vt, vy, vflag, varargin) 58 function [vretval] = odepkg_event_handle (vevefun, vt, vy, vflag, varargin)