Mercurial > forge
changeset 3982:20d9f2a66ad9 octave-forge
Cleanup and unification of the help texts of each function.
line wrap: on
line diff
--- a/main/odepkg/inst/ode23.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/ode23.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,21 +16,22 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} ode23 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{sol} =} ode23 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{[t, y, [xe, ye, ie]]} =} ode23 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) +%# @deftypefn {Function File} {[@var{}] =} ode23 (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{sol}] =} ode23 (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{t}, @var{y}, [@var{xe}, @var{ye}, @var{ie}]] =} ode23 (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) %# -%# If called with no return argument, plots the solutions over time in a figure window while solving the set of equations that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} must be the time slot, @var{init} must be the states initial values, @var{opt} can optionally be the options structure that is created with the command @command{odeset} and @var{[P1, P2, @dots{}]} can optionally be all arguments that have to be passed to the function @var{fun}. If an invalid input argument is detected then the function terminates with an error. +%# This function file can be used to solve a set of non--stiff ordinary differential equations (non--stiff ODEs) or non--stiff differential algebraic equations (non--stiff DAEs) with the well known explicit Runge--Kutta method of order (2,3). %# -%# If called with one return argument, returns the solution structure @var{sol} after solving the set of ordinary differential equations. The solution structure @var{sol} has the fields @var{x} for the steps chosen by the solver, @var{y} for the solver solutions, @var{solver} for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with no return argument then plot the solution over time in a figure window while solving the set of ODEs that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} is a double vector that defines the time slot, @var{init} is a double vector that defines the initial values of the states, @var{opt} can optionally be a structure array that keeps the options created with the command @command{odeset} and @var{par1}, @var{par2}, @dots{} can optionally be other input arguments of any type that have to be passed to the function defined by @var{@@fun}. +%# +%# If this function is called with one return argument then return the solution @var{sol} of type structure array after solving the set of ODEs. The solution @var{sol} has the fields @var{x} of type double column vector for the steps chosen by the solver, @var{y} of type double column vector for the solutions at each time step of @var{x}, @var{solver} of type string for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector that keep the informations of the event function if an event function handle is set in the option argument @var{opt}. %# -%# If called with more than one return argument, returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with more than one return argument then return the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector. %# -%# Run +%# Run examples with the command %# @example %# demo ode23 %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/ode2r.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/ode2r.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,21 +16,22 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} ode2r (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{sol} =} ode2r (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{[t, y, [xe, ye, ie]]} =} ode2r (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) +%# @deftypefn {Function File} {[@var{}] =} ode2r (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{sol}] =} ode2r (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{t}, @var{y}, [@var{xe}, @var{ye}, @var{ie}]] =} ode2r (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) %# -%# If called with no return argument, plots the solutions over time in a figure window while solving the set of equations that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} must be the time slot, @var{init} must be the states initial values, @var{opt} can optionally be the options structure that is created with the command @command{odeset} and @var{[P1, P2, @dots{}]} can optionally be all arguments that have to be passed to the function @var{fun}. If an invalid input argument is detected then the function terminates with an error. +%# This function file can be used to solve a set of non--stiff ordinary differential equations (non--stiff ODEs) or non--stiff differential algebraic equations (non--stiff DAEs). This function file is a wrapper to @file{odepkg_mexsolver_radau.c} that uses Hairer's and Wanner's Fortran solver @file{radau.f}. %# -%# If called with one return argument, returns the solution structure @var{sol} after solving the set of ordinary differential equations. The solution structure @var{sol} has the fields @var{x} for the steps chosen by the solver, @var{y} for the solver solutions, @var{solver} for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with no return argument then plot the solution over time in a figure window while solving the set of ODEs that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} is a double vector that defines the time slot, @var{init} is a double vector that defines the initial values of the states, @var{opt} can optionally be a structure array that keeps the options created with the command @command{odeset} and @var{par1}, @var{par2}, @dots{} can optionally be other input arguments of any type that have to be passed to the function defined by @var{@@fun}. +%# +%# If this function is called with one return argument then return the solution @var{sol} of type structure array after solving the set of ODEs. The solution @var{sol} has the fields @var{x} of type double column vector for the steps chosen by the solver, @var{y} of type double column vector for the solutions at each time step of @var{x}, @var{solver} of type string for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector that keep the informations of the event function if an event function handle is set in the option argument @var{opt}. %# -%# If called with more than one return argument, returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with more than one return argument then return the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector. %# -%# Run +%# Run examples with the command %# @example %# demo ode2r %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/ode45.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/ode45.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,21 +16,22 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} ode45 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{sol} =} ode45 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{[t, y, [xe, ye, ie]]} =} ode45 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) +%# @deftypefn {Function File} {[@var{}] =} ode45 (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{sol}] =} ode45 (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{t}, @var{y}, [@var{xe}, @var{ye}, @var{ie}]] =} ode45 (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) %# -%# If called with no return argument, plots the solutions over time in a figure window while solving the set of equations that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} must be the time slot, @var{init} must be the states initial values, @var{opt} can optionally be the options structure that is created with the command @command{odeset} and @var{[P1, P2, @dots{}]} can optionally be all arguments that have to be passed to the function @var{fun}. If an invalid input argument is detected then the function terminates with an error. +%# This function file can be used to solve a set of non--stiff ordinary differential equations (non--stiff ODEs) or non--stiff differential algebraic equations (non--stiff DAEs) with the well known explicit Runge--Kutta method of order (4,5). %# -%# If called with one return argument, returns the solution structure @var{sol} after solving the set of ordinary differential equations. The solution structure @var{sol} has the fields @var{x} for the steps chosen by the solver, @var{y} for the solver solutions, @var{solver} for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with no return argument then plot the solution over time in a figure window while solving the set of ODEs that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} is a double vector that defines the time slot, @var{init} is a double vector that defines the initial values of the states, @var{opt} can optionally be a structure array that keeps the options created with the command @command{odeset} and @var{par1}, @var{par2}, @dots{} can optionally be other input arguments of any type that have to be passed to the function defined by @var{@@fun}. +%# +%# If this function is called with one return argument then return the solution @var{sol} of type structure array after solving the set of ODEs. The solution @var{sol} has the fields @var{x} of type double column vector for the steps chosen by the solver, @var{y} of type double column vector for the solutions at each time step of @var{x}, @var{solver} of type string for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector that keep the informations of the event function if an event function handle is set in the option argument @var{opt}. %# -%# If called with more than one return argument, returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with more than one return argument then return the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector. %# -%# Run +%# Run examples with the command %# @example %# demo ode45 %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/ode54.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/ode54.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,21 +16,22 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} ode54 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{sol} =} ode54 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{[t, y, [xe, ye, ie]]} =} ode54 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) +%# @deftypefn {Function File} {[@var{}] =} ode54 (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{sol}] =} ode54 (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{t}, @var{y}, [@var{xe}, @var{ye}, @var{ie}]] =} ode54 (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) %# -%# If called with no return argument, plots the solutions over time in a figure window while solving the set of equations that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} must be the time slot, @var{init} must be the states initial values, @var{opt} can optionally be the options structure that is created with the command @command{odeset} and @var{[P1, P2, @dots{}]} can optionally be all arguments that have to be passed to the function @var{fun}. If an invalid input argument is detected then the function terminates with an error. +%# This function file can be used to solve a set of non--stiff ordinary differential equations (non--stiff ODEs) or non--stiff differential algebraic equations (non--stiff DAEs) with the well known explicit Runge--Kutta method of order (5,4). %# -%# If called with one return argument, returns the solution structure @var{sol} after solving the set of ordinary differential equations. The solution structure @var{sol} has the fields @var{x} for the steps chosen by the solver, @var{y} for the solver solutions, @var{solver} for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with no return argument then plot the solution over time in a figure window while solving the set of ODEs that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} is a double vector that defines the time slot, @var{init} is a double vector that defines the initial values of the states, @var{opt} can optionally be a structure array that keeps the options created with the command @command{odeset} and @var{par1}, @var{par2}, @dots{} can optionally be other input arguments of any type that have to be passed to the function defined by @var{@@fun}. +%# +%# If this function is called with one return argument then return the solution @var{sol} of type structure array after solving the set of ODEs. The solution @var{sol} has the fields @var{x} of type double column vector for the steps chosen by the solver, @var{y} of type double column vector for the solutions at each time step of @var{x}, @var{solver} of type string for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector that keep the informations of the event function if an event function handle is set in the option argument @var{opt}. %# -%# If called with more than one return argument, returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with more than one return argument then return the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector. %# -%# Run +%# Run examples with the command %# @example %# demo ode54 %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/ode5d.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/ode5d.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,26 +16,20 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} ode5d (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{sol} =} ode5d (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{[t, y, [xe, ye, ie]]} =} ode5d (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# -%# If called with no return argument, plots the solutions over time in a figure window while solving the set of equations that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} must be the time slot, @var{init} must be the states initial values, @var{opt} can optionally be the options structure that is created with the command @command{odeset} and @var{[P1, P2, @dots{}]} can optionally be all arguments that have to be passed to the function @var{fun}. If an invalid input argument is detected then the function terminates with an error. -%# -%# If called with one return argument, returns the solution structure @var{sol} after solving the set of ordinary differential equations. The solution structure @var{sol} has the fields @var{x} for the steps chosen by the solver, @var{y} for the solver solutions, @var{solver} for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# @deftypefn {Function File} {[@var{}] =} ode5d (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{sol}] =} ode5d (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{t}, @var{y}, [@var{xe}, @var{ye}, @var{ie}]] =} ode5d (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) %# -%# If called with more than one return argument, returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# This function file can be used to solve a set of non--stiff ordinary differential equations (non--stiff ODEs) or non--stiff differential algebraic equations (non--stiff DAEs) with the well known explicit Runge--Kutta method of order (5,4). %# -%# Run -%# @example -%# demo ode5d -%# @end example -%# to see an example. +%# @b{Note: The function files @file{odepkg_mexsolver_dopri5} and @file{ode5d} will be removed when version 0.4.0 of OdePkg will be released. A similiar solver method is @file{ode54}, please use the @file{ode54} solver instead.} +%# %# @end deftypefn -%# %# @seealso{odepkg} function [varargout] = ode5d (varargin) + warning ('Solver ode5d is deprecated and will be removed with OdePkg 0.4.0'); + warning ('Use the very similiar solver ode54 instead.'); if (exist ('odepkg_mexsolver_dopri5') != 3) error ('Mex-function "odepkg_mexsolver_dopri5" is not installed'); else
--- a/main/odepkg/inst/ode5r.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/ode5r.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,21 +16,22 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} ode5r (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{sol} =} ode5r (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{[t, y, [xe, ye, ie]]} =} ode5r (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) +%# @deftypefn {Function File} {[@var{}] =} ode5r (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{sol}] =} ode5r (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{t}, @var{y}, [@var{xe}, @var{ye}, @var{ie}]] =} ode5r (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) %# -%# If called with no return argument, plots the solutions over time in a figure window while solving the set of equations that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} must be the time slot, @var{init} must be the states initial values, @var{opt} can optionally be the options structure that is created with the command @command{odeset} and @var{[P1, P2, @dots{}]} can optionally be all arguments that have to be passed to the function @var{fun}. If an invalid input argument is detected then the function terminates with an error. +%# This function file can be used to solve a set of non--stiff ordinary differential equations (non--stiff ODEs) and non-stiff differential algebraic equations (non-stiff DAEs). This function file is a wrapper to @file{odepkg_mexsolver_radau5.c} that uses Hairer's and Wanner's Fortran solver @file{radau5.f}. %# -%# If called with one return argument, returns the solution structure @var{sol} after solving the set of ordinary differential equations. The solution structure @var{sol} has the fields @var{x} for the steps chosen by the solver, @var{y} for the solver solutions, @var{solver} for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with no return argument then plot the solution over time in a figure window while solving the set of ODEs that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} is a double vector that defines the time slot, @var{init} is a double vector that defines the initial values of the states, @var{opt} can optionally be a structure array that keeps the options created with the command @command{odeset} and @var{par1}, @var{par2}, @dots{} can optionally be other input arguments of any type that have to be passed to the function defined by @var{@@fun}. +%# +%# If this function is called with one return argument then return the solution @var{sol} of type structure array after solving the set of ODEs. The solution @var{sol} has the fields @var{x} of type double column vector for the steps chosen by the solver, @var{y} of type double column vector for the solutions at each time step of @var{x}, @var{solver} of type string for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector that keep the informations of the event function if an event function handle is set in the option argument @var{opt}. %# -%# If called with more than one return argument, returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with more than one return argument then return the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector. %# -%# Run +%# Run examples with the command %# @example %# demo ode5r %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/ode78.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/ode78.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,21 +16,22 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} ode78 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{sol} =} ode78 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{[t, y, [xe, ye, ie]]} =} ode78 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) +%# @deftypefn {Function File} {[@var{}] =} ode78 (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{sol}] =} ode78 (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{t}, @var{y}, [@var{xe}, @var{ye}, @var{ie}]] =} ode78 (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) %# -%# If called with no return argument, plots the solutions over time in a figure window while solving the set of equations that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} must be the time slot, @var{init} must be the states initial values, @var{opt} can optionally be the options structure that is created with the command @command{odeset} and @var{[P1, P2, @dots{}]} can optionally be all arguments that have to be passed to the function @var{fun}. If an invalid input argument is detected then the function terminates with an error. +%# This function file can be used to solve a set of non--stiff ordinary differential equations (non--stiff ODEs) or non--stiff differential algebraic equations (non--stiff DAEs) with the well known explicit Runge--Kutta method of order (7,8). %# -%# If called with one return argument, returns the solution structure @var{sol} after solving the set of ordinary differential equations. The solution structure @var{sol} has the fields @var{x} for the steps chosen by the solver, @var{y} for the solver solutions, @var{solver} for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with no return argument then plot the solution over time in a figure window while solving the set of ODEs that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} is a double vector that defines the time slot, @var{init} is a double vector that defines the initial values of the states, @var{opt} can optionally be a structure array that keeps the options created with the command @command{odeset} and @var{par1}, @var{par2}, @dots{} can optionally be other input arguments of any type that have to be passed to the function defined by @var{@@fun}. +%# +%# If this function is called with one return argument then return the solution @var{sol} of type structure array after solving the set of ODEs. The solution @var{sol} has the fields @var{x} of type double column vector for the steps chosen by the solver, @var{y} of type double column vector for the solutions at each time step of @var{x}, @var{solver} of type string for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector that keep the informations of the event function if an event function handle is set in the option argument @var{opt}. %# -%# If called with more than one return argument, returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with more than one return argument then return the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector. %# -%# Run +%# Run examples with the command %# @example %# demo ode78 %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/ode8d.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/ode8d.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,26 +16,20 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} ode8d (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{sol} =} ode8d (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{[t, y, [xe, ye, ie]]} =} ode8d (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# -%# If called with no return argument, plots the solutions over time in a figure window while solving the set of equations that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} must be the time slot, @var{init} must be the states initial values, @var{opt} can optionally be the options structure that is created with the command @command{odeset} and @var{[P1, P2, @dots{}]} can optionally be all arguments that have to be passed to the function @var{fun}. If an invalid input argument is detected then the function terminates with an error. -%# -%# If called with one return argument, returns the solution structure @var{sol} after solving the set of ordinary differential equations. The solution structure @var{sol} has the fields @var{x} for the steps chosen by the solver, @var{y} for the solver solutions, @var{solver} for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# @deftypefn {Function File} {[@var{}] =} ode8d (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{sol}] =} ode8d (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{t}, @var{y}, [@var{xe}, @var{ye}, @var{ie}]] =} ode8d (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) %# -%# If called with more than one return argument, returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# This function file can be used to solve a set of non--stiff ordinary differential equations (non--stiff ODEs) or non--stiff differential algebraic equations (non--stiff DAEs) with the well known explicit Runge--Kutta method of order (8,5,3). %# -%# Run -%# @example -%# demo ode8d -%# @end example -%# to see an example. +%# @b{Note: The function files @file{odepkg_mexsolver_dop853} and @file{ode8d} will be removed when version 0.4.0 of OdePkg will be released. A similiar solver method is @file{ode78}, please use the @file{ode78} solver instead.} +%# %# @end deftypefn -%# %# @seealso{odepkg} function [varargout] = ode8d (varargin) + warning ('Solver ode8d is deprecated and will be removed with OdePkg 0.4.0'); + warning ('Use the very similiar solver ode78 instead.'); if (exist ('odepkg_mexsolver_dop853') != 3) error ('Mex-function "odepkg_mexsolver_dop853" is not installed'); else
--- a/main/odepkg/inst/odeget.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odeget.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,29 +16,25 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{ret} =} odeget (@var{odestruct}, @var{name}, @var{[default]}) -%# @deftypefnx {Function} {@var{ret} =} odeget (@var{odestruct}, @var{@{names@}}, @var{[@{defaults@}]}) +%# @deftypefn {Function File} {[@var{value}] =} odeget (@var{odestruct}, @var{option}, [@var{default}]) +%# @deftypefnx {Command} {[@var{values}] =} odeget (@var{odestruct}, @{@var{opt1}, @var{opt2}, @dots{}@}, [@{@var{def1}, @var{def2}, @dots{}@}]) %# -%# The first form returns the option value @var{ret} that is specified by the option name @var{name} from the odepkg option structure @var{odestruct}. Optionally the default value @var{default} is returned if this option was not manually set in @var{odestruct}. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with two input arguments and the first input argument @var{odestruct} is of type structure array and the second input argument @var{option} is of type string then return the option value @var{value} that is specified by the option name @var{option} in the OdePkg option structure @var{odestruct}. Optionally if this function is called with a third input argument then return the default value @var{default} if @var{option} is not set in the structure @var{odestruct}. %# -%# The second form returns the option values as a cell array @var{ret} in that order that is specified by the cell array of option names @var{@{names@}} from the odepkg option structure @var{odestruct}. Optionally the default value from the cell array @var{@{defaults@}} is returned that depends on that option that was not manually set in @var{odestruct}. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with two input arguments and the first input argument @var{odestruct} is of type structure array and the second input argument @var{option} is of type cell array of strings then return the option values @var{values} that are specified by the option names @var{opt1}, @var{opt2}, @dots{} in the OdePkg option structure @var{odestruct}. Optionally if this function is called with a third input argument of type cell array then return the default value @var{def1} if @var{opt1} is not set in the structure @var{odestruct}, @var{def2} if @var{opt2} is not set in the structure @var{odestruct}, @dots{} %# -%# Run +%# Run examples with the command %# @example %# demo odeget %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg} -%# Maintainer: Thomas Treichl -%# Created: 20060809 -%# ChangeLog: 20061022, Thomas Treichl -%# Changed help text. We cannot create a function of the form -%# odeget (@var{odestruct}, @var{name1}, @var{name2}) because we -%# would get a mismatch with function form 1 like described above. - +%# Note: 20061022, Thomas Treichl +%# We cannot create a function of the form odeget (@var{odestruct}, +%# @var{name1}, @var{name2}) because we would get a mismatch with +%# the function form 1 like described above. function [vret] = odeget (varargin)
--- a/main/odepkg/inst/odeox.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odeox.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,26 +16,19 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} odeox (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{sol} =} odeox (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{[t, y, [xe, ye, ie]]} =} odeox (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# -%# If called with no return argument, plots the solutions over time in a figure window while solving the set of equations that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} must be the time slot, @var{init} must be the states initial values, @var{opt} can optionally be the options structure that is created with the command @command{odeset} and @var{[P1, P2, @dots{}]} can optionally be all arguments that have to be passed to the function @var{fun}. If an invalid input argument is detected then the function terminates with an error. -%# -%# If called with one return argument, returns the solution structure @var{sol} after solving the set of ordinary differential equations. The solution structure @var{sol} has the fields @var{x} for the steps chosen by the solver, @var{y} for the solver solutions, @var{solver} for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# @deftypefn {Function File} {[@var{}] =} odeox (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{sol}] =} odeox (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{t}, @var{y}, [@var{xe}, @var{ye}, @var{ie}]] =} odeox (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) %# -%# If called with more than one return argument, returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# This function file can be used to solve a set of non--stiff ordinary differential equations (non--stiff ODEs) and non--stiff differential algebraic equations (non--stiff DAEs). %# -%# Run -%# @example -%# demo odeox -%# @end example -%# to see an example. +%# @b{Note: The function files @file{odepkg_mexsolver_odex} and @file{odeox} will be removed when version 0.4.0 of OdePkg will be released. A similiar solver method does not exist in OdePkg but you can use @file{ode23, ode45, ode54} or @file{ode78} instead.} +%# %# @end deftypefn -%# %# @seealso{odepkg} function [varargout] = odeox (varargin) + warning ('Solver odeox is deprecated and will be removed with OdePkg 0.4.0'); if (exist ('odepkg_mexsolver_odex') != 3) error ('Mex-function "odepkg_mexsolver_odex" is not installed'); else
--- a/main/odepkg/inst/odephas2.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odephas2.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,21 +16,28 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{ret} =} odephas2 (@var{t, y, flag}) -%# Opens a new figure window and plots the first result from the variable @var{y} over the second result from the variable @var{y} while solving. The return value @var{ret} depends on the input value of the variable @var{flag}. If @var{flag} is the string "init" then nothing is returned, else if @var{flag} is empty then the value true (resp. value 1) is returned, else if @var{flag} is the string "done" then again nothing will be returned. The input arguments @var{t} and @var{y} are the actual time stamp and the solver outputs. The value of the variable @var{t} is not needed by this function. The input arguments @var{t} and @var{y} are the actual time stamp and the solver output. This function is an odepkg plotter function that can be set with @command{odeset}, therefore this function should never be directly called by the user. No error handling has been implemented in this function to achieve the highest processing speed. +%# @deftypefn {Function File} {[@var{ret}] =} odephas2 (@var{t}, @var{y}, @var{flag}) %# -%# Run +%# Open a new figure window and plot the first result from the variable @var{y} that is of type double column vector over the second result from the variable @var{y} while solving. The types and the values of the input parameter @var{t} and the output parameter @var{ret} depend on the input value @var{flag} that is of type string. If @var{flag} is +%# @table @option +%# @item @code{"init"} +%# then @var{t} must be a double column vector of length 2 with the first and the last time step and nothing is returned from this function, +%# @item @code{""} +%# then @var{t} must be a double scalar specifying the actual time step and the return value is true (resp. value 1), +%# @item @code{"done"} +%# then @var{t} must be a double scalar specifying the last time step and nothing is returned from this function. +%# @end table +%# +%# This function is called by a OdePkg solver function if it was specified in an OdePkg options structure with the @command{odeset}. 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. +%# +%# Run examples with the command %# @example %# demo odephas2 %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg} -%# As in the definitions of initial value problems as functions and if -%# somebody uses event functions all input and output vectors must be -%# column vectors by now. function [varargout] = odephas2 (vt, vy, vflag) %# No input argument check is done for a higher processing speed
--- a/main/odepkg/inst/odephas3.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odephas3.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,21 +16,28 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{[ret]} =} odephas3 (@var{t, y, flag}) -%# Opens a new figure window and plots the first result from the variable @var{y} over the second and the third result from the variable @var{y} in three dimensions while solving. The return value @var{ret} depends on the input value of the variable @var{flag}. If @var{flag} is the string "init" then nothing is returned, else if @var{flag} is empty then the value true (resp. value 1) is returned, else if @var{flag} is the string "done" then again nothing will be returned. The input arguments @var{t} and @var{y} are the actual time stamp and the solver output. This function is an odepkg plotter function that can be set with @command{odeset}, therefore this function should never be directly called by the user. No error handling has been implemented in this function to achieve the highest processing speed. +%# @deftypefn {Function File} {[@var{ret}] =} odephas3 (@var{t}, @var{y}, @var{flag}) %# -%# Run +%# Open a new figure window and plot the first result from the variable @var{y} that is of type double column vector over the second and the third result from the variable @var{y} while solving. The types and the values of the input parameter @var{t} and the output parameter @var{ret} depend on the input value @var{flag} that is of type string. If @var{flag} is +%# @table @option +%# @item @code{"init"} +%# then @var{t} must be a double column vector of length 2 with the first and the last time step and nothing is returned from this function, +%# @item @code{""} +%# then @var{t} must be a double scalar specifying the actual time step and the return value is true (resp. value 1), +%# @item @code{"done"} +%# then @var{t} must be a double scalar specifying the last time step and nothing is returned from this function. +%# @end table +%# +%# This function is called by a OdePkg solver function if it was specified in an OdePkg options structure with the @command{odeset}. 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. +%# +%# Run examples with the command %# @example %# demo odephas3 %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg} -%# As in the definitions of initial value problems as functions and if -%# somebody uses event functions all input and output vectors must be -%# column vectors by now. function [varargout] = odephas3 (vt, vy, vflag) %# vt and vy are always column vectors, vflag can be either 'init'
--- a/main/odepkg/inst/odepkg.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,26 +16,20 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} odepkg () -%# OdePkg is part of the GNU Octave Repository (resp. the Octave-Forge project). The package includes commands for setting up various options, output functions etc. before solving a set of differential equations with the solver functions that are also included. OdePkg formerly was initiated to solve explicitly formulated ordinary differential equations (ODEs) only, but there are already improvements so that differential algebraic equations (DAEs) in explicit form can also be solved. At this time OdePkg is under development with the main target, to make a package that is mostly compatible to commercial solver products. -%# -%# For further details about the OdePkg run the following command to show up the complete tutorial +%# @deftypefn {Function File} {[@var{}] =} odepkg () +%# +%# OdePkg is part of the GNU Octave Repository (resp. the Octave--Forge project). The package includes commands for setting up various options, output functions etc. before solving a set of differential equations with the solver functions that are also included. At this time OdePkg is under development with the main target to make a package that is mostly compatible to proprietary solver products. +%# +%# If this function is called without any input argument then open the OdePkg tutorial in the Octave window. The tutorial can also be opened with the following command %# %# @example %# doc odepkg %# @end example %# @end deftypefn -%# Maintainer: Thomas Treichl -%# Created: 20060912 -%# ChangeLog: -%# 20070108, Thomas Treichl -%# Completely changed the behaviour of this function. +function [] = odepkg (vstr) -%# File will be cleaned up in the future -function [] = odepkg (vstr) - %# Check number and types of all input arguments - if (nargin == 0) + if (nargin == 0) %# Check number and types of all input arguments doc ('odepkg'); elseif (nargin > 1) error ('Number of input arguments must be exactly one'); @@ -44,8 +38,8 @@ elseif (isa (vstr, 'function_handle') == true) feval (vstr); else - error ('Input argument must be a valid string or function handle'); - end %# Check number and types of all input arguments + error ('Input argument must be a valid string or a valid function handle'); + end function [] = odepkg_validate_mfiles () @@ -75,6 +69,51 @@ printf ('Testing function odepkg_testsuite_chemakzo ... '); odepkg_testsuite_chemakzo (@odepkg_mexsolver_seulex, 10^-04); +function [] = odepkg_internal_helpextract () + + vfun = {'odepkg', ... + 'ode23', 'ode45', 'ode54', 'ode78', ... + 'ode5d', 'ode8d', 'odeox', ... + 'ode2r', 'ode5r', 'oders', 'odesx', ... + 'odeget', 'odeset', ... + 'odeplot', 'odephas2', 'odephas3', 'odeprint', ... + 'odepkg_structure_check', 'odepkg_event_handle', ... + 'odepkg_equations_lorenz', 'odepkg_equations_pendulous', ... + 'odepkg_equations_roessler', 'odepkg_equations_secondorderlag', ... + 'odepkg_equations_vanderpol', ... + 'odepkg_testsuite_calcscd', 'odepkg_testsuite_calcmescd', ... + 'odepkg_testsuite_chemakzo', 'odepkg_testsuite_hires', ... + 'odepkg_testsuite_implrober', ... + 'odepkg_testsuite_oregonator', 'odepkg_testsuite_pollution', ... + 'odepkg_testsuite_robertson', 'odepkg_testsuite_transistor', ... + }; + vfun = sort (vfun); + + [vout, vmsg] = fopen ('../doc/mfunref.texi', 'w'); + if ~(isempty (vmsg)), error (vmsg); end + for vcnt = 1:length (vfun) + if (exist (vfun{vcnt}, 'file')) + [vfid, vmsg] = fopen (which (vfun{vcnt}), 'r'); + if ~(isempty (vmsg)), error (vmsg); end + while (true) + vlin = fgets (vfid); + if ~(ischar (vlin)), break; end + if (regexp (vlin, '^(%# -\*- texinfo -\*-)')) + while (~isempty (regexp (vlin, '^(%#)')) && ... + isempty (regexp (vlin, '^(%# @end deftypefn)'))) + vlin = fgets (vfid); + if (length (vlin) > 3), fprintf (vout, '%s', vlin(4:end)); + else fprintf (vout, '%s', vlin(3:end)); + end + end + fprintf (vout, '\n'); + end + end + fclose (vfid); + end + end + fclose (vout); + function [] = odepkg_performance_mathires () vfun = {@ode113, @ode23, @ode45, ... @ode15s, @ode23s, @ode23t, @ode23tb};
--- a/main/odepkg/inst/odepkg_equations_lorenz.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_equations_lorenz.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,14 +16,14 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{ydot} =} odepkg_equations_lorenz (@var{t, y}) -%# Returns three derivatives of the ordinary differential equations (ODEs) from the Lorenz equation implementation, cf. @url{http://en.wikipedia.org/wiki/Lorenz_equation} for further details. The output argument @var{ydot} is a column vector and contains the derivatives, @var{y} also is a column vector that contains the integration results from the previous integration step and @var{t} is a scalar value with actual time stamp. There is no error handling implemented in this function to achieve the highest performance available. +%# @deftypefn {Function File} {[@var{ydot}] =} odepkg_equations_lorenz (@var{t}, @var{y}) %# -%# Run +%# Return three derivatives of the non--stiff ordinary differential equations (non--stiff ODEs) from the "Lorenz attractor" implementation, cf. @url{http://en.wikipedia.org/wiki/Lorenz_equation} for further details. The output argument @var{ydot} is a column vector and contains the derivatives, the input argument @var{y} also is a column vector that contains the integration results from the previous integration step and @var{t} is a double scalar that keeps the actual time stamp. There is no error handling implemented in this function to achieve the highest performance available. +%# +%# Run examples with the command %# @example %# demo odepkg_equations_lorenz %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odepkg_equations_pendulous.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_equations_pendulous.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,14 +16,14 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{ydot} =} odepkg_equations_pendulous (@var{t, y}) -%# Returns two derivatives of the ordinary differential equations (ODEs) from a pendulum implementation (ie. the motion of a simple pendulum with damping, cf. @url{http://en.wikipedia.org/wiki/Pendulum} for further details). The output argument @var{ydot} is a column vector and contains the derivatives, @var{y} also is a column vector that contains the integration results from the previous integration step and @var{t} is a scalar value with actual time stamp. There is no error handling implemented in this function to achieve the highest performance available. +%# @deftypefn {Function File} {[@var{ydot}] =} odepkg_equations_pendulous (@var{t}, @var{y}) %# -%# Run +%# Return two derivatives of the non--stiff ordinary differential equations (non--stiff ODEs) from a pendulum implementation, ie. the motion of a simple pendulum with damping, cf. @url{http://en.wikipedia.org/wiki/Pendulum} for further details. The output argument @var{ydot} is a column vector and contains the derivatives, the input argument @var{y} also is a column vector that contains the integration results from the previous integration step and @var{t} is a double scalar that keeps the actual time stamp. There is no error handling implemented in this function to achieve the highest performance available. +%# +%# Run examples with the command %# @example %# demo odepkg_equations_pendulous %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odepkg_equations_roessler.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_equations_roessler.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,14 +16,14 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{ydot} =} odepkg_equations_roessler (@var{t, y}) -%# Returns three derivatives of the ordinary differential equations (ODEs) from the Roessler attractor implementation, cf. @url{http://en.wikipedia.org/wiki/R%C3%B6ssler_attractor} for further details. The output argument @var{ydot} is a column vector and contains the derivatives, @var{y} also is a column vector that contains the integration results from the previous integration step and @var{t} is a scalar value with actual time stamp. There is no error handling implemented in this function to achieve the highest performance available. +%# @deftypefn {Function File} {[@var{ydot}] =} odepkg_equations_roessler (@var{t}, @var{y}) %# -%# Run +%# Return the three derivatives of the non--stiff ordinary differential equations (non--stiff ODEs) from the Roessler attractor implementation, cf. @url{http://en.wikipedia.org/wiki/R%C3%B6ssler_attractor} for further details. The output argument @var{ydot} is a column vector and contains the derivatives, the input argument @var{y} also is a column vector that contains the integration results from the previous integration step and @var{t} is a double scalar that keeps the actual time stamp. There is no error handling implemented in this function to achieve the highest performance available. +%# +%# Run examples with the command %# @example %# demo odepkg_equations_roessler %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odepkg_equations_secondorderlag.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_equations_secondorderlag.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,22 +16,18 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{ydot} =} odepkg_equations_secondorderlag (@var{t, y, [u, K, T1, T2]}) -%# Returns two derivatives of the ordinary differential equations (ODEs) from the second order lag implementation (control theory), cf. @url{http://en.wikipedia.org/wiki/Category:Control_theory} for further details. The output argument @var{ydot} is a column vector and contains the derivatives, @var{y} also is a column vector that contains the integration results from the previous integration step and @var{t} is a scalar value with actual time stamp. There is no error handling implemented in this function to achieve the highest performance available. +%# @deftypefn {Function File} {[@var{ydot}] =} odepkg_equations_secondorderlag (@var{t}, @var{y}, [@var{u}, @var{K}, @var{T1}, @var{T2}]) %# -%# Run +%# Return two derivatives of the non-stiff ordinary differential equations (non-stiff ODEs) from the second order lag implementation, cf. @url{http://en.wikipedia.org/wiki/Category:Control_theory} for further details. The output argument @var{ydot} is a column vector and contains the derivatives, the input argument @var{y} also is a column vector that contains the integration results from the previous integration step and @var{t} is a double scalar that keeps the actual time stamp. There is no error handling implemented in this function to achieve the highest performance available. +%# +%# Run examples with the command %# @example %# demo odepkg_equations_secondorderlag %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg} -%# Maintainer: Thomas Treichl -%# Created: 20060809 -%# ChangeLog: - function ydot = odepkg_equations_secondorderlag (tvar, yvar, varargin) %# odepkg_equations_vanderpol is a demo function. Therefore some
--- a/main/odepkg/inst/odepkg_equations_vanderpol.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_equations_vanderpol.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,25 +16,18 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} odepkg_equations_vanderpol () -%# Displays the help text of the function and terminates with an error. +%# @deftypefn {Function File} {[@var{ydot}] =} odepkg_equations_vanderpol (@var{t}, @var{y}, [@var{mu}]) %# -%# @deftypefnx {Function} {@var{ydot} =} odepkg_equations_vanderpol (@var{t, y}) -%# Returns two derivatives of the ordinary differential equations (ODEs) from the "Van der Pol" implementation, cf. @url{http://en.wikipedia.org/wiki/Van_der_Pol_oscillator} for further details. The output argument @var{ydot} is a column vector and contains the derivatives, @var{y} also is a column vector that contains the integration results from the previous integration step and @var{t} is a scalar value with actual time stamp. There is a error handling implemented in this function, ie. if an unvalid input argument is found then this function terminates with an error. +%# Return the two derivatives of the non-stiff ordinary differential equations (non-stiff ODEs) from the "Van der Pol" implementation, cf. @url{http://en.wikipedia.org/wiki/Van_der_Pol_oscillator} for further details. The output argument @var{ydot} is a column vector and contains the derivatives, the input argument @var{y} also is a column vector that contains the integration results from the previous integration step and @var{t} is a double scalar that keeps the actual time stamp. There is no error handling implemented in this function to achieve the highest performance available. %# -%# Run +%# Run examples with the command %# @example %# demo odepkg_equations_vanderpol %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg} -%# Maintainer: Thomas Treichl -%# Created: 20060809 -%# ChangeLog: - function ydot = odepkg_equations_vanderpol (tvar, yvar, varargin) %# odepkg_equations_vanderpol is a demo function. Therefore some
--- a/main/odepkg/inst/odepkg_event_handle.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_event_handle.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,13 +16,29 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{sol} =} odepkg_event_handle (@var{@@fun, time, y, flag, [P1, P2, @dots{}]}) -%# Evaluates the event function that is specified by the function handle @var{@@fun}. This function is an odepkg internal helper function, therefore this function should never be directly called by a user. No error handling has been implemented in this function to achieve the highest processing speed. +%# @deftypefn {Function File} {[@var{sol}] =} odepkg_event_handle (@var{@@fun}, @var{time}, @var{y}, @var{flag}, [@var{par1}, @var{par2}, @dots{}]) +%# +%# 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} is of type double column vector and specifies the solutions, the third input argument @var{flag} is of type string and can be of the form +%# @table @option +%# @item @code{"init"} +%# then initialize internal persistent variables of the function @command{odepkg_event_handle} and return an empty cell array of size 4, +%# @item @code{"calc"} +%# then do the evaluation of the event function and return the solution @var{sol} as type cell array of size 4, +%# @item @code{"done"} +%# then cleanup internal variables of the function @command{odepkg_event_handle} and return an empty cell array of size 4. +%# @end table +%# 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. +%# +%# 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. %# @end deftypefn %# %# @seealso{odepkg} function [vretval] = odepkg_event_handle (vevefun, vt, vy, vflag, varargin) + + %# No error handling has been implemented in this function to achieve + %# the highest performance available. + %# vretval{1} is true or false; either to terminate or to continue %# vretval{2} is the index information for which event occured %# vretval{3} is the time information column vector
--- a/main/odepkg/inst/odepkg_structure_check.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_structure_check.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,14 +16,16 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{odestruct} =} odepkg_structure_check (@var{odestruct}, ['@var{solver}']) -%# Checks the field names and the field values of the OdePkg option structure @var{odestruct} and returns it if it is valid. If optionally called with a second string input argument '@var{solver}' specifying the name of a valid OdePkg solver then a higher level error detection is performed. If an invalid structure fieldname or an invalid value for an option is given then the function returns an error. +%# @deftypefn {Function File} {[@var{newstruct}] =} odepkg_structure_check (@var{oldstruct}, [@var{"solver"}]) +%# +%# 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. %# -%# Run +%# 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. +%# +%# Run examples with the command %# @example %# demo odepkg_structure_check %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odepkg_testsuite_calcmescd.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_testsuite_calcmescd.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,15 +16,14 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} @var{mescd} = odepkg_testsuite_calcmescd (@var{solution, reference, abstol, reltol}) +%# @deftypefn {Function File} {[@var{mescd}] =} odepkg_testsuite_calcmescd (@var{solution}, @var{reference}, @var{abstol}, @var{reltol}) %# -%# Returns a normalized value for the minimum number of correct digits @var{mescd} that is calculated from the solution at the end of an integration interval @var{solution} and a set of reference values @var{reference}. The input arguments @var{abstol} and @var{reltol} are used to calculate a reference solution that depends on the relative and absolute error tolerances. +%# If this function is called with four input arguments of type double scalar or column vector then return a normalized value for the minimum number of correct digits @var{mescd} that is calculated from the solution at the end of an integration interval @var{solution} and a set of reference values @var{reference}. The input arguments @var{abstol} and @var{reltol} are used to calculate a reference solution that depends on the relative and absolute error tolerances. %# -%# Run +%# Run examples with the command %# @example %# demo odepkg_testsuite_calcmescd %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odepkg_testsuite_calcscd.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_testsuite_calcscd.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,15 +16,14 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} @var{scd} = odepkg_testsuite_calcscd (@var{solution, reference, abstol, reltol}) +%# @deftypefn {Function File} {[@var{scd}] =} odepkg_testsuite_calcscd (@var{solution}, @var{reference}, @var{abstol}, @var{reltol}) %# -%# Returns a normalized value for the minimum number of correct digits @var{scd} that is calculated from the solution at the end of an integration interval @var{solution} and a set of reference values @var{reference}. The input arguments @var{abstol} and @var{reltol} are unused but present because of compatibility with the function @command{odepkg_testsuite_calcmescd}. +%# If this function is called with four input arguments of type double scalar or column vector then return a normalized value for the minimum number of correct digits @var{scd} that is calculated from the solution at the end of an integration interval @var{solution} and a set of reference values @var{reference}. The input arguments @var{abstol} and @var{reltol} are unused but present because of compatibility to the function @command{odepkg_testsuite_calcmescd}. %# -%# Run +%# Run examples with the command %# @example %# demo odepkg_testsuite_calcscd %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odepkg_testsuite_chemakzo.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_testsuite_chemakzo.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,15 +16,14 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{solution}} = odepkg_testsuite_chemakzo (@var{@@solver, reltol}) +%# @deftypefn {Function File} {[@var{solution}] =} odepkg_testsuite_chemakzo (@var{@@solver}, @var{reltol}) %# -%# Returns the cell array @var{solution} with performance informations about the chemical AKZO Nobel test after solving (DAE-test). The input argument @var{@@solver} is a function handle specifying the solver that has to be used, @var{reltol} is the scalar value for the relative error tolerance. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with two input arguments and the first input argument @var{@@solver} is a function handle describing an OdePkg solver and the second input argument @var{reltol} is a double scalar describing the relative error tolerance then return a cell array @var{solution} with performance informations about the chemical AKZO Nobel testsuite of differential algebraic equations after solving (DAE--test). %# -%# Run +%# Run examples with the command %# @example %# demo odepkg_testsuite_chemakzo %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odepkg_testsuite_hires.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_testsuite_hires.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,15 +16,14 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{solution}} = odepkg_testsuite_hires (@var{@@solver, reltol}) +%# @deftypefn {Function File} {[@var{solution}] =} odepkg_testsuite_hires (@var{@@solver}, @var{reltol}) %# -%# Returns the cell array @var{solution} with performance informations about the HIRES testsuite of differential algebraic equations after solving (ODE-test). The input argument @var{@@solver} is a function handle specifying the solver that has to be used, @var{reltol} is the scalar value for the relative error tolerance. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with two input arguments and the first input argument @var{@@solver} is a function handle describing an OdePkg solver and the second input argument @var{reltol} is a double scalar describing the relative error tolerance then return a cell array @var{solution} with performance informations about the HIRES testsuite of ordinary differential equations after solving (ODE--test). %# -%# Run +%# Run examples with the command %# @example %# demo odepkg_testsuite_hires %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odepkg_testsuite_implrober.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_testsuite_implrober.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,15 +16,14 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{solution}} = odepkg_testsuite_implrober (@var{@@solver, reltol}) +%# @deftypefn {Function File} {[@var{solution}] =} odepkg_testsuite_implrober (@var{@@solver}, @var{reltol}) %# -%# Returns the cell array @var{solution} with performance informations about the implicit form of the modified ROBERTSON testsuite of implicit differential algebraic equations after solving (IDE-test). The input argument @var{@@solver} is a function handle specifying the solver that has to be used, @var{reltol} is the scalar value for the relative error tolerance. +%# If this function is called with two input arguments and the first input argument @var{@@solver} is a function handle describing an OdePkg solver and the second input argument @var{reltol} is a double scalar describing the relative error tolerance then return a cell array @var{solution} with performance informations about the implicit form of the modified ROBERTSON testsuite of implicit differential algebraic equations after solving (IDE--test). %# -%# Run +%# Run examples with the command %# @example %# demo odepkg_testsuite_implrober %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odepkg_testsuite_oregonator.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_testsuite_oregonator.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,15 +16,14 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{solution}} = odepkg_testsuite_oregonator (@var{@@solver, reltol}) +%# @deftypefn {Function File} {[@var{solution}] =} odepkg_testsuite_oregonator (@var{@@solver}, @var{reltol}) %# -%# Returns the cell array @var{solution} with performance informations about the OREGONATOR testsuite of ordinary differential equations after solving (ODE-test). The input argument @var{@@solver} is a function handle specifying the solver that has to be used, @var{reltol} is the scalar value for the relative error tolerance. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with two input arguments and the first input argument @var{@@solver} is a function handle describing an OdePkg solver and the second input argument @var{reltol} is a double scalar describing the relative error tolerance then return a cell array @var{solution} with performance informations about the OREGONATOR testsuite of ordinary differential equations after solving (ODE--test). %# -%# Run +%# Run examples with the command %# @example %# demo odepkg_testsuite_oregonator %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odepkg_testsuite_pollution.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_testsuite_pollution.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,15 +16,14 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{solution}} = odepkg_testsuite_pollution (@var{@@solver, reltol}) +%# @deftypefn {Function File} {[@var{solution}] =} odepkg_testsuite_pollution (@var{@@solver}, @var{reltol}) %# -%# Returns the cell array @var{solution} with performance informations about the POLLUTION testsuite of ordinary differential equations after solving (ODE-test). The input argument @var{@@solver} is a function handle specifying the solver that has to be used, @var{reltol} is the scalar value for the relative error tolerance. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with two input arguments and the first input argument @var{@@solver} is a function handle describing an OdePkg solver and the second input argument @var{reltol} is a double scalar describing the relative error tolerance then return the cell array @var{solution} with performance informations about the POLLUTION testsuite of ordinary differential equations after solving (ODE--test). %# -%# Run +%# Run examples with the command %# @example %# demo odepkg_testsuite_pollution %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odepkg_testsuite_robertson.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_testsuite_robertson.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,15 +16,14 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{solution}} = odepkg_testsuite_robertson (@var{@@solver, reltol}) +%# @deftypefn {Function File} {[@var{solution}] =} odepkg_testsuite_robertson (@var{@@solver}, @var{reltol}) %# -%# Returns the cell array @var{solution} with performance informations about the modified ROBERTSON testsuite of differential algebraic equations after solving (DAE-test). The input argument @var{@@solver} is a function handle specifying the solver that has to be used, @var{reltol} is the scalar value for the relative error tolerance. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with two input arguments and the first input argument @var{@@solver} is a function handle describing an OdePkg solver and the second input argument @var{reltol} is a double scalar describing the relative error tolerance then return a cell array @var{solution} with performance informations about the modified ROBERTSON testsuite of differential algebraic equations after solving (DAE--test). %# -%# Run +%# Run examples with the command %# @example %# demo odepkg_testsuite_robertson %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odepkg_testsuite_transistor.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odepkg_testsuite_transistor.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,15 +16,14 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{solution}} = odepkg_testsuite_transistor (@var{@@solver, reltol}) +%# @deftypefn {Function File} {[@var{solution}] =} odepkg_testsuite_transistor (@var{@@solver}, @var{reltol}) %# -%# Returns the cell array @var{solution} with performance informations about the TRANSISTOR testsuite of differential algebraic equations after solving (DAE-test). The input argument @var{@@solver} is a function handle specifying the solver that has to be used, @var{reltol} is the scalar value for the relative error tolerance. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with two input arguments and the first input argument @var{@@solver} is a function handle describing an OdePkg solver and the second input argument @var{reltol} is a double scalar describing the relative error tolerance then return the cell array @var{solution} with performance informations about the TRANSISTOR testsuite of differential algebraic equations after solving (DAE--test). %# -%# Run +%# Run examples with the command %# @example %# demo odepkg_testsuite_transistor %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odeplot.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odeplot.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,21 +16,28 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{[ret]} =} odeplot (@var{t, y, flag}) -%# Opens a new figure window and plots the results from the variable @var{y} over time while solving. The return value @var{ret} depends on the input value @var{flag}. If @var{flag} is the string "init" then nothing is returned, else if @var{flag} is empty then the value true (resp. value 1) is returned, else if @var{flag} is the string "done" then again nothing will be returned. The input arguments @var{t} and @var{y} are the actual time stamp and the solver output. This function is an odepkg plotter function that can be set with @command{odeset}, therefore this function should never be directly called by the user. No error handling has been implemented in this function to achieve the highest processing speed. +%# @deftypefn {Function File} {[@var{ret}] =} odeplot (@var{t}, @var{y}, @var{flag}) %# -%# Run +%# Open a new figure window and plot the results from the variable @var{y} of type column vector over time while solving. The types and the values of the input parameter @var{t} and the output parameter @var{ret} depend on the input value @var{flag} that is of type string. If @var{flag} is +%# @table @option +%# @item @code{"init"} +%# then @var{t} must be a double column vector of length 2 with the first and the last time step and nothing is returned from this function, +%# @item @code{""} +%# then @var{t} must be a double scalar specifying the actual time step and the return value is true (resp. value 1), +%# @item @code{"done"} +%# then @var{t} must be a double scalar specifying the last time step and nothing is returned from this function. +%# @end table +%# +%# This function is called by a OdePkg solver function if it was specified in an OdePkg options structure with the @command{odeset}. 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. +%# +%# Run examples with the command %# @example %# demo odeplot %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg} -%# As in the definitions of initial value problems as functions and if -%# somebody uses event functions all input and output vectors must be -%# column vectors by now. function [varargout] = odeplot (vt, vy, vflag) %# No input argument check is done for a higher processing speed @@ -41,7 +48,7 @@ %# Nothing to return, vt is either the time slot [tstart tstop] %# or [t0, t1, ..., tn], vy is the inital value vector 'vinit' vfigure = figure; -%# axis ([vt(1,1), vt(1,length(vt))]); +%# axis ([vt(1,1), vt(1,length(vt))]); vtold = vt(1,1); vyold = vy(:,1); vcounter = 1;
--- a/main/odepkg/inst/odeprint.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odeprint.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,21 +16,28 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{[ret]} =} odeprint (@var{t, y, flag}) -%# Displays the results of the differential equations in the octave window while solving. The first column shows the actual time stamp, the following columns show the values of the solvers for each time stamp. The return value @var{ret} depends on the input value @var{flag}. If @var{flag} is the string "init" then nothing is returned, else if @var{flag} is empty then true (resp. value 1) is returned to tell the calling solver function to continue, else if @var{flag} is the string "done" then again nothing will be returned. The input arguments @var{t} and @var{y} are the actual time stamp and the solver output. This function is an odepkg plotter function that can be set with @command{odeset}, therefore this function should never be directly called by the user. No error handling has been implemented in this function to achieve the highest processing speed. +%# @deftypefn {Function File} {[@var{ret}] =} odeprint (@var{t}, @var{y}, @var{flag}) %# -%# Run +%# Display the results of the set of differential equations in the Octave window while solving. The first column of the screen output shows the actual time stamp that is given with the input arguemtn @var{t}, the following columns show the results from the function evaluation that are given by the column vector @var{y}. The types and the values of the input parameter @var{t} and the output parameter @var{ret} depend on the input value @var{flag} that is of type string. If @var{flag} is +%# @table @option +%# @item @code{"init"} +%# then @var{t} must be a double column vector of length 2 with the first and the last time step and nothing is returned from this function, +%# @item @code{""} +%# then @var{t} must be a double scalar specifying the actual time step and the return value is true (resp. value 1), +%# @item @code{"done"} +%# then @var{t} must be a double scalar specifying the last time step and nothing is returned from this function. +%# @end table +%# +%# This function is called by a OdePkg solver function if it was specified in an OdePkg options structure with the @command{odeset}. 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. +%# +%# Run examples with the command %# @example %# demo odeprint %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg} -%# As in the definitions of initial value problems as functions and if -%# somebody uses event functions all input and output vectors must be -%# column vectors by now. function [varargout] = odeprint (vt, vy, vflag, varargin) %# No input argument check is done for a higher processing speed
--- a/main/odepkg/inst/oders.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/oders.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,21 +16,22 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} oders (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{sol} =} oders (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{[t, y, [xe, ye, ie]]} =} oders (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) +%# @deftypefn {Function File} {[@var{}] =} oders (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{sol}] =} oders (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{t}, @var{y}, [@var{xe}, @var{ye}, @var{ie}]] =} oders (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) %# -%# If called with no return argument, plots the solutions over time in a figure window while solving the set of equations that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} must be the time slot, @var{init} must be the states initial values, @var{opt} can optionally be the options structure that is created with the command @command{odeset} and @var{[P1, P2, @dots{}]} can optionally be all arguments that have to be passed to the function @var{fun}. If an invalid input argument is detected then the function terminates with an error. +%# This function file can be used to solve a set of non--stiff ordinary differential equations (non--stiff ODEs) and non-stiff differential algebraic equations (non-stiff DAEs). This function file is a wrapper to @file{odepkg_mexsolver_rodas.c} that uses Hairer's and Wanner's Fortran solver @file{rodas.f}. %# -%# If called with one return argument, returns the solution structure @var{sol} after solving the set of ordinary differential equations. The solution structure @var{sol} has the fields @var{x} for the steps chosen by the solver, @var{y} for the solver solutions, @var{solver} for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with no return argument then plot the solution over time in a figure window while solving the set of ODEs that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} is a double vector that defines the time slot, @var{init} is a double vector that defines the initial values of the states, @var{opt} can optionally be a structure array that keeps the options created with the command @command{odeset} and @var{par1}, @var{par2}, @dots{} can optionally be other input arguments of any type that have to be passed to the function defined by @var{@@fun}. +%# +%# If this function is called with one return argument then return the solution @var{sol} of type structure array after solving the set of ODEs. The solution @var{sol} has the fields @var{x} of type double column vector for the steps chosen by the solver, @var{y} of type double column vector for the solutions at each time step of @var{x}, @var{solver} of type string for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector that keep the informations of the event function if an event function handle is set in the option argument @var{opt}. %# -%# If called with more than one return argument, returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with more than one return argument then return the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector. %# -%# Run +%# Run examples with the command %# @example %# demo oders %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odeset.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odeset.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,24 +16,25 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} {@var{[odestruct]} =} odeset () -%# @deftypefnx {Function} {@var{[odestruct]} =} odeset (@var{"field1"}, @var{value1}, @dots{}) -%# @deftypefnx {Function} {@var{[odestruct]} =} odeset (@var{oldstruct}, @var{"field1"}, @var{value1}, @dots{}) -%# @deftypefnx {Function} {@var{[odestruct]} =} odeset (@var{oldstruct}, @var{newstruct}) +%# @deftypefn {Function File} {[@var{odestruct}] =} odeset () +%# @deftypefnx {Command} {[@var{odestruct}] =} odeset (@var{"field1"}, @var{value1}, @var{"field2"}, @var{value2}, @dots{}) +%# @deftypefnx {Command} {[@var{odestruct}] =} odeset (@var{oldstruct}, @var{"field1"}, @var{value1}, @var{"field2"}, @var{value2}, @dots{}) +%# @deftypefnx {Command} {[@var{odestruct}] =} odeset (@var{oldstruct}, @var{newstruct}) %# -%# If called without any input argument then creates a new OdePkg options structure with all necessary fields and sets the values of all fields to default values. +%# If this function is called without an input argument then return a new OdePkg options structure array that contains all the necessary fields and sets the values of all fields to default values. %# -%# If called with string input arguments identifying valid OdePkg options then creates a new OdePkg options structure with all necessary fields and sets the values of the fields @var{field1}, @var{field2} etc. to the values @var{value1}, @var{value2}, etc. +%# If this function is called with string input arguments @var{"field1"}, @var{"field2"}, @dots{} identifying valid OdePkg options then return a new OdePkg options structure with all necessary fields and set the values of the fields @var{"field1"}, @var{"field2"}, @dots{} to the values @var{value1}, @var{value2}, @dots{} %# -%# If called with the first input argument being a valid OdePkg structure then overwrites all values of options of the structure @var{oldstruct} in the fields @var{field1}, @var{field2}, etc. with new values @var{value1}, @var{value2}, etc. +%# If this function is called with a first input argument @var{oldstruct} of type structure array then overwrite all values of the options @var{"field1"}, @var{"field2"}, @dots{} of the structure @var{oldstruct} with new values @var{value1}, @var{value2}, @dots{} and return the modified structure array. %# -%# If called with two valid OdePkg structures then overwrites all values in the fields from the structure @var{oldstruct} with new values of the fields from the structure @var{newstruct}. Empty structure values from @var{newstruct} will not overwrite structure values from @var{oldstruct}. +%# If this function is called with two input argumnets @var{oldstruct} and @var{newstruct} of type structure array then overwrite all values in the fields from the structure @var{oldstruct} with new values of the fields from the structure @var{newstruct}. Empty values of @var{newstruct} will not overwrite values in @var{oldstruct}. %# -%# Run +%# For a detailed explanation about valid fields and field values in an OdePkg structure aaray have a look at the @file{odepkg.pdf}, Section 'ODE/DAE/IDE options' or run the command @command{doc odepkg} to open the tutorial. +%# +%# Run examples with the command %# @example %# demo odeset %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}
--- a/main/odepkg/inst/odesx.m Tue Oct 30 17:16:56 2007 +0000 +++ b/main/odepkg/inst/odesx.m Tue Oct 30 17:20:31 2007 +0000 @@ -16,21 +16,22 @@ %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA %# -*- texinfo -*- -%# @deftypefn {Function} odesx (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{sol} =} odesx (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# @deftypefnx {Function} {@var{[t, y, [xe, ye, ie]]} =} odesx (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) +%# @deftypefn {Function File} {[@var{}] =} odesx (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{sol}] =} odesx (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) +%# @deftypefnx {Command} {[@var{t}, @var{y}, [@var{xe}, @var{ye}, @var{ie}]] =} odesx (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}]) %# -%# If called with no return argument, plots the solutions over time in a figure window while solving the set of equations that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} must be the time slot, @var{init} must be the states initial values, @var{opt} can optionally be the options structure that is created with the command @command{odeset} and @var{[P1, P2, @dots{}]} can optionally be all arguments that have to be passed to the function @var{fun}. If an invalid input argument is detected then the function terminates with an error. +%# This function file can be used to solve a set of non--stiff ordinary differential equations (non--stiff ODEs) and non-stiff differential algebraic equations (non-stiff DAEs). This function file is a wrapper to @file{odepkg_mexsolver_seulex.c} that uses Hairer's and Wanner's Fortran solver @file{seulex.f}. %# -%# If called with one return argument, returns the solution structure @var{sol} after solving the set of ordinary differential equations. The solution structure @var{sol} has the fields @var{x} for the steps chosen by the solver, @var{y} for the solver solutions, @var{solver} for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with no return argument then plot the solution over time in a figure window while solving the set of ODEs that are defined in a function and specified by the function handle @var{@@fun}. The second input argument @var{slot} is a double vector that defines the time slot, @var{init} is a double vector that defines the initial values of the states, @var{opt} can optionally be a structure array that keeps the options created with the command @command{odeset} and @var{par1}, @var{par2}, @dots{} can optionally be other input arguments of any type that have to be passed to the function defined by @var{@@fun}. +%# +%# If this function is called with one return argument then return the solution @var{sol} of type structure array after solving the set of ODEs. The solution @var{sol} has the fields @var{x} of type double column vector for the steps chosen by the solver, @var{y} of type double column vector for the solutions at each time step of @var{x}, @var{solver} of type string for the solver name and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector that keep the informations of the event function if an event function handle is set in the option argument @var{opt}. %# -%# If called with more than one return argument, returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if an event property is set in the option argument @var{opt}. See the description for the input arguments before. If an invalid input argument is detected then the function terminates with an error. +%# If this function is called with more than one return argument then return the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{xe}, the extended solution information @var{ye} and the extended index information @var{ie} all of type double column vector. %# -%# Run +%# Run examples with the command %# @example %# demo odesx %# @end example -%# to see an example. %# @end deftypefn %# %# @seealso{odepkg}