Mercurial > forge
changeset 2721:409ae45aa47e octave-forge
deftypefnx should come at the top of the file so that the makeinfo build for web documentation formats correctly
author | adb014 |
---|---|
date | Wed, 18 Oct 2006 18:51:59 +0000 |
parents | d0b400de8b3f |
children | 94cf5713a2d6 |
files | main/odepkg/inst/ode23.m main/odepkg/inst/ode45.m main/odepkg/inst/ode54.m main/odepkg/inst/ode78.m main/odepkg/inst/odeget.m main/odepkg/inst/odeset.m |
diffstat | 6 files changed, 115 insertions(+), 48 deletions(-) [+] |
line wrap: on
line diff
--- a/main/odepkg/inst/ode23.m Tue Oct 17 22:54:51 2006 +0000 +++ b/main/odepkg/inst/ode23.m Wed Oct 18 18:51:59 2006 +0000 @@ -16,14 +16,26 @@ %# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA %# -*- texinfo -*- -%# @deftypefn {Function} ode23 () -%# Displays the help text of the function and terminates with an error. +%# @deftypefn {Function} {@var{[sol]} =} ode23 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) +%# @deftypefnx {Function} {@var{[t, y, [te, ye, ie]]} =} ode23 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) %# -%# @deftypefnx {Function} {@var{[sol]} =} ode23 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# Returns the solution structure @var{sol} after solving the set of ordinary differential equations defined in a function and specified by the function handle @var{@@fun}. The first 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. +%# Returns the solution structure @var{sol} after solving the set of +%# ordinary differential equations defined in a function and specified +%# by the function handle @var{@@fun}. The first 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. %# -%# @deftypefnx {Function} {@var{[t, y, [te, ye, ie]]} =} ode23 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# Returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{te}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if any 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 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{te}, the extended solution information @var{ye} +%# and the extended index information @var{ie} of the event function if +%# any 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. %# %# Run %# @example @@ -441,4 +453,4 @@ %# Local Variables: *** %# mode: octave *** -%# End: *** \ No newline at end of file +%# End: ***
--- a/main/odepkg/inst/ode45.m Tue Oct 17 22:54:51 2006 +0000 +++ b/main/odepkg/inst/ode45.m Wed Oct 18 18:51:59 2006 +0000 @@ -16,14 +16,26 @@ %# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA %# -*- texinfo -*- -%# @deftypefn {Function} ode45 () -%# Displays the help text of the function and terminates with an error. +%# @deftypefn {Function} {@var{[sol]} =} ode45 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) +%# @deftypefnx {Function} {@var{[t, y, [te, ye, ie]]} =} ode45 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) %# -%# @deftypefnx {Function} {@var{[sol]} =} ode45 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# Returns the solution structure @var{sol} after solving the set of ordinary differential equations defined in a function and specified by the function handle @var{@@fun}. The first 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. +%# Returns the solution structure @var{sol} after solving the set of +%# ordinary differential equations defined in a function and specified +%# by the function handle @var{@@fun}. The first 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. %# -%# @deftypefnx {Function} {@var{[t, y, [te, ye, ie]]} =} ode45 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# Returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{te}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if any 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 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{te}, the extended solution information @var{ye} +%# and the extended index information @var{ie} of the event function if +%# any 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. %# %# Run %# @example @@ -451,4 +463,4 @@ %# Local Variables: *** %# mode: octave *** -%# End: *** \ No newline at end of file +%# End: ***
--- a/main/odepkg/inst/ode54.m Tue Oct 17 22:54:51 2006 +0000 +++ b/main/odepkg/inst/ode54.m Wed Oct 18 18:51:59 2006 +0000 @@ -16,14 +16,26 @@ %# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA %# -*- texinfo -*- -%# @deftypefn {Function} ode54 () -%# Displays the help text of the function and terminates with an error. +%# @deftypefnx {Function} {@var{[sol]} =} ode54 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) +%# @deftypefnx {Function} {@var{[t, y, [te, ye, ie]]} =} ode54 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) %# -%# @deftypefnx {Function} {@var{[sol]} =} ode54 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# Returns the solution structure @var{sol} after solving the set of ordinary differential equations defined in a function and specified by the function handle @var{@@fun}. The first 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. +%# Returns the solution structure @var{sol} after solving the set of +%# ordinary differential equations defined in a function and specified +%# by the function handle @var{@@fun}. The first 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. %# -%# @deftypefnx {Function} {@var{[t, y, [te, ye, ie]]} =} ode54 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# Returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{te}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if any 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 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{te}, the extended solution information @var{ye} +%# and the extended index information @var{ie} of the event function if +%# any 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. %# %# Run %# @example @@ -445,4 +457,4 @@ %# Local Variables: *** %# mode: octave *** -%# End: *** \ No newline at end of file +%# End: ***
--- a/main/odepkg/inst/ode78.m Tue Oct 17 22:54:51 2006 +0000 +++ b/main/odepkg/inst/ode78.m Wed Oct 18 18:51:59 2006 +0000 @@ -16,14 +16,26 @@ %# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA %# -*- texinfo -*- -%# @deftypefn {Function} ode78 () -%# Displays the help text of the function and terminates with an error. +%# @deftypefnx {Function} {@var{[sol]} =} ode78 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) +%# @deftypefnx {Function} {@var{[t, y, [te, ye, ie]]} =} ode78 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) %# -%# @deftypefnx {Function} {@var{[sol]} =} ode78 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# Returns the solution structure @var{sol} after solving the set of ordinary differential equations defined in a function and specified by the function handle @var{@@fun}. The first 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. +%# Returns the solution structure @var{sol} after solving the set of +%# ordinary differential equations defined in a function and specified +%# by the function handle @var{@@fun}. The first 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. %# -%# @deftypefnx {Function} {@var{[t, y, [te, ye, ie]]} =} ode78 (@var{@@fun, slot, init, [opt], [P1, P2, @dots{}]}) -%# Returns the time stamps @var{t}, the solution values @var{y} and optionally the extended time stamp information @var{te}, the extended solution information @var{ye} and the extended index information @var{ie} of the event function if any 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 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{te}, the extended solution information @var{ye} +%# and the extended index information @var{ie} of the event function if +%# any 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. %# %# Run %# @example @@ -468,4 +480,4 @@ %# Local Variables: *** %# mode: octave *** -%# End: *** \ No newline at end of file +%# End: ***
--- a/main/odepkg/inst/odeget.m Tue Oct 17 22:54:51 2006 +0000 +++ b/main/odepkg/inst/odeget.m Wed Oct 18 18:51:59 2006 +0000 @@ -16,14 +16,21 @@ %# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA %# -*- texinfo -*- -%# @deftypefn {Function} odeget () -%# Displays the help text of the function and terminates with an error. +%# @deftypefn {Function} {@var{[vret]} =} odeget (@var{vodestruct}, @var{vname}, @var{[vdefault]}) +%# @deftypefnx {Function} {@var{[vret]} =} odeget (@var{vodestruct}, @var{@{vnames@}}, @var{[@{vdefaults@}]}) %# -%# @deftypefnx {Function} {@var{[vret]} =} odeget (@var{vodestruct}, @var{vname}, @var{[vdefault]}) -%# Returns the option value @var{vret} that is specified by the option name @var{vname} from the odepkg option structure @var{vodestruct}. Optionally the default value @var{vdefault} is returned if no option was set in @var{vodestruct} manually by the user. If an invalid input argument is detected then the function terminates with an error. +%# Returns the option value @var{vret} that is specified by the option name +%# @var{vname} from the odepkg option structure @var{vodestruct}. Optionally +%# the default value @var{vdefault} is returned if no option was set in +%# @var{vodestruct} manually by the user. If an invalid input argument is +%# detected then the function terminates with an error. %# -%# @deftypefnx {Function} {@var{[vret]} =} odeget (@var{vodestruct}, @var{@{vnames@}}, @var{[@{vdefaults@}]}) -%# Returns the option values as a cell array @var{vret} that is specified by the cell array of option names @var{@{vnames@}} from the odepkg option structure @var{vodestruct}. Optionally the default value of @var{[@{vdefaults@}]} is returned if no option was set in @var{vodestruct} manually by the user. If an invalid input argument is detected then the function terminates with an error. +%# The second form, returns the option values as a cell array @var{vret} that +%# is specified by the cell array of option names @var{@{vnames@}} from the +%# odepkg option structure @var{vodestruct}. Optionally the default value of +%# @var{[@{vdefaults@}]} is returned if no option was set in @var{vodestruct} +%# manually by the user. If an invalid input argument is detected then the +%# function terminates with an error. %# %# Run %# @example @@ -113,4 +120,4 @@ %# Local Variables: *** %# mode: octave *** -%# End: *** \ No newline at end of file +%# End: ***
--- a/main/odepkg/inst/odeset.m Tue Oct 17 22:54:51 2006 +0000 +++ b/main/odepkg/inst/odeset.m Wed Oct 18 18:51:59 2006 +0000 @@ -16,27 +16,37 @@ %# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA %# -*- texinfo -*- -%# @deftypefn {Function} odeset () -%# Displays the help text of the function and terminates with an error. -%# -%# @deftypefnx {Function} {@var{[odestruct]} =} odeset () -%# Creates a new ode options structure with all necessary fields and sets the values of all fields to the defaults. -%# +%# @deftypefn {Function} {@var{[odestruct]} =} odeset () %# @deftypefnx {Function} {@var{[odestruct]} =} odeset (@var{"field1"}, @var{value1}, @dots{}) -%# Creates a new ode 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 an unknown option field or an invalid option value is detected then the function terminates with an error. +%# @deftypefnx {Function} {@var{[odestruct]} =} odeset (@var{oldstruct}, @var{"field1"}, @var{value1}, @dots{}) +%# @deftypefnx {Function} {@var{[odestruct]} =} odeset (@var{oldstruct}, @var{newstruct}) +%# +%# Called without arguments, creates a new ode options structure with all +%# necessary fields and sets the values of all fields to the defaults. +%# +%# Called with only string arguments, creates a new ode 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 an +%# unknown option field or an invalid option value is detected then the +%#function terminates with an error. %# -%# @deftypefnx {Function} {@var{[odestruct]} =} odeset (@var{oldstruct}, @var{"field1"}, @var{value1}, @dots{}) -%# Overwrites all values of the structure @var{oldstruct} in the fields @var{field1}, @var{field2}, etc. with new values @var{value1}, @var{value2}, etc. If an unknown option field or an invalid option value is detected then the function terminates with an error. +%# Called with the first argument being a structure returned by @code{odeset}, +%# overwrites all values of the structure @var{oldstruct} in the fields +%# @var{field1}, @var{field2}, etc. with new values @var{value1}, +%# @var{value2}, etc. If an unknown option field or an invalid option value +%# is detected then the function terminates with an error. %# -%# @deftypefnx {Function} {@var{[odestruct]} =} odeset (@var{oldstruct}, @var{newstruct}) -%# Overwrites all values in the fields from the structure @var{oldstruct} with new values of the fields from the structure @var{newstruct}. Any empty matrix values from @var{newstruct} are not treated. If an unknown option field or an invalid option value is detected then the function terminates with an error. +%# Called with two structures, overwrites all values in the fields from the +%# structure @var{oldstruct} with new values of the fields from the structure +%# @var{newstruct}. Any empty matrix values from @var{newstruct} are not +%# treated. If an unknown option field or an invalid option value is detected +%# then the function terminates with an error. %# %# Run %# @example %# demo odeset %# @end example %# to see an example. -%# @end deftypefn %# %# @unnumberedsubsec Valid field names of the odepkg options structure %# The odepkg options structure may contain the following fields and default values if calling @command{odeset} @@ -65,6 +75,8 @@ %# @item "BDF" must be "on" or "off" (default "off") %# @end itemize %# +%# @end deftypefn +%# %# @seealso{odepkg} %# Maintainer: Thomas Treichl @@ -192,4 +204,4 @@ %# Local Variables: *** %# mode: octave *** -%# End: *** \ No newline at end of file +%# End: ***