Mercurial > octave-nkf
changeset 20570:6256f6e366ac
Fix copyright text in private ode functions
* script/ode/private/*.m: Fox the copyright text.
| author | Carlo de Falco <carlo.defalco@polimi.it> |
|---|---|
| date | Fri, 02 Oct 2015 05:50:43 +0200 |
| parents | b70cc4bd8109 |
| children | d0f886a030b7 |
| files | scripts/ode/private/AbsRel_Norm.m scripts/ode/private/hermite_quartic_interpolation.m scripts/ode/private/integrate_adaptive.m scripts/ode/private/integrate_const.m scripts/ode/private/integrate_n_steps.m scripts/ode/private/kahan.m scripts/ode/private/ode_struct_value_check.m scripts/ode/private/odepkg_event_handle.m scripts/ode/private/runge_kutta_45_dorpri.m scripts/ode/private/starting_stepsize.m |
| diffstat | 10 files changed, 180 insertions(+), 156 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/ode/private/AbsRel_Norm.m Thu Oct 01 16:18:19 2015 -0400 +++ b/scripts/ode/private/AbsRel_Norm.m Fri Oct 02 05:50:43 2015 +0200 @@ -1,3 +1,23 @@ +## Copyright (C) 2013, Roberto Porcu' <roberto.porcu@polimi.it> +## Copyright (C) 2014, Jacopo Corno <jacopo.corno@gmail.com> +## +## This file is part of Octave. +## +## Octave is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. +## +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with Octave; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. + + function res = AbsRel_Norm (x, x_old, AbsTol, RelTol, normcontrol, y) n = length (x);
--- a/scripts/ode/private/hermite_quartic_interpolation.m Thu Oct 01 16:18:19 2015 -0400 +++ b/scripts/ode/private/hermite_quartic_interpolation.m Fri Oct 02 05:50:43 2015 +0200 @@ -1,18 +1,20 @@ -## Copyright (C) 2014, Jacopo Corno <jacopo.corno@gmail.com> -## OdePkg - A package for solving ordinary differential equations and more +## Copyright (C) 2015 Jacopo Corno <jacopo.corno@gmail.com> +## +## This file is part of Octave. ## -## This program is free software; you can redistribute it and/or modify -## it under the terms of the GNU General Public License as published by -## the Free Software Foundation; either version 2 of the License, or -## (at your option) any later version. +## Octave is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. ## -## This program is distributed in the hope that it will be useful, -## but WITHOUT ANY WARRANTY; without even the implied warranty of -## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -## GNU General Public License for more details. +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. ## ## You should have received a copy of the GNU General Public License -## along with this program; If not, see <http://www.gnu.org/licenses/>. +## along with Octave; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. ## -*- texinfo -*-
--- a/scripts/ode/private/integrate_adaptive.m Thu Oct 01 16:18:19 2015 -0400 +++ b/scripts/ode/private/integrate_adaptive.m Fri Oct 02 05:50:43 2015 +0200 @@ -1,18 +1,20 @@ ## Copyright (C) 2013, Roberto Porcu' <roberto.porcu@polimi.it> -## OdePkg - A package for solving ordinary differential equations and more +## +## This file is part of Octave. ## -## This program is free software; you can redistribute it and/or modify -## it under the terms of the GNU General Public License as published by -## the Free Software Foundation; either version 2 of the License, or -## (at your option) any later version. +## Octave is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. ## -## This program is distributed in the hope that it will be useful, -## but WITHOUT ANY WARRANTY; without even the implied warranty of -## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -## GNU General Public License for more details. +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. ## ## You should have received a copy of the GNU General Public License -## along with this program; If not, see <http://www.gnu.org/licenses/>. +## along with Octave; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. ## -*- texinfo -*-
--- a/scripts/ode/private/integrate_const.m Thu Oct 01 16:18:19 2015 -0400 +++ b/scripts/ode/private/integrate_const.m Fri Oct 02 05:50:43 2015 +0200 @@ -1,19 +1,20 @@ ## Copyright (C) 2013, Roberto Porcu' <roberto.porcu@polimi.it> -## OdePkg - A package for solving ordinary differential equations and more +## +## This file is part of Octave. ## -## This program is free software; you can redistribute it and/or modify -## it under the terms of the GNU General Public License as published by -## the Free Software Foundation; either version 2 of the License, or -## (at your option) any later version. +## Octave is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. ## -## This program is distributed in the hope that it will be useful, -## but WITHOUT ANY WARRANTY; without even the implied warranty of -## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -## GNU General Public License for more details. +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. ## ## You should have received a copy of the GNU General Public License -## along with this program; If not, see <http://www.gnu.org/licenses/>. - +## along with Octave; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Command} {[@var{t}, @var{y}] =} integrate_const (@var{@@stepper},
--- a/scripts/ode/private/integrate_n_steps.m Thu Oct 01 16:18:19 2015 -0400 +++ b/scripts/ode/private/integrate_n_steps.m Fri Oct 02 05:50:43 2015 +0200 @@ -1,19 +1,20 @@ ## Copyright (C) 2013, Roberto Porcu' <roberto.porcu@polimi.it> -## OdePkg - A package for solving ordinary differential equations and more +## +## This file is part of Octave. ## -## This program is free software; you can redistribute it and/or modify -## it under the terms of the GNU General Public License as published by -## the Free Software Foundation; either version 2 of the License, or -## (at your option) any later version. +## Octave is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. ## -## This program is distributed in the hope that it will be useful, -## but WITHOUT ANY WARRANTY; without even the implied warranty of -## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -## GNU General Public License for more details. +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. ## ## You should have received a copy of the GNU General Public License -## along with this program; If not, see <http://www.gnu.org/licenses/>. - +## along with Octave; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Command} {[@var{t}, @var{y}] =} integrate_n_steps
--- a/scripts/ode/private/kahan.m Thu Oct 01 16:18:19 2015 -0400 +++ b/scripts/ode/private/kahan.m Fri Oct 02 05:50:43 2015 +0200 @@ -1,19 +1,20 @@ ## Copyright (C) 2013, Roberto Porcu' <roberto.porcu@polimi.it> -## OdePkg - A package for solving ordinary differential equations and more +## +## This file is part of Octave. ## -## This program is free software; you can redistribute it and/or modify -## it under the terms of the GNU General Public License as published by -## the Free Software Foundation; either version 2 of the License, or -## (at your option) any later version. +## Octave is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. ## -## This program is distributed in the hope that it will be useful, -## but WITHOUT ANY WARRANTY; without even the implied warranty of -## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -## GNU General Public License for more details. +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. ## ## You should have received a copy of the GNU General Public License -## along with this program; If not, see <http://www.gnu.org/licenses/>. - +## along with Octave; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Command} {[@var{sum}] =} kahan (@var{sum},
--- a/scripts/ode/private/ode_struct_value_check.m Thu Oct 01 16:18:19 2015 -0400 +++ b/scripts/ode/private/ode_struct_value_check.m Fri Oct 02 05:50:43 2015 +0200 @@ -1,6 +1,5 @@ ## Copyright (C) 2006-2012, Thomas Treichl <treichl@users.sourceforge.net> ## Copyright (C) 2013, Roberto Porcu' <roberto.porcu@polimi.it> -## OdePkg - A package for solving ordinary differential equations and more ## ## This file is part of Octave. ## @@ -18,7 +17,6 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. - ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{}] =} ## ode_struct_value_check (@var{arg}, [@var{"solver"}])
--- a/scripts/ode/private/odepkg_event_handle.m Thu Oct 01 16:18:19 2015 -0400 +++ b/scripts/ode/private/odepkg_event_handle.m Fri Oct 02 05:50:43 2015 +0200 @@ -1,136 +1,134 @@ -%# Copyright (C) 2006-2012, Thomas Treichl <treichl@users.sourceforge.net> -%# OdePkg - A package for solving ordinary differential equations and more -%# -%# This program is free software; you can redistribute it and/or modify -%# it under the terms of the GNU General Public License as published by -%# the Free Software Foundation; either version 2 of the License, or -%# (at your option) any later version. -%# -%# This program is distributed in the hope that it will be useful, -%# but WITHOUT ANY WARRANTY; without even the implied warranty of -%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -%# GNU General Public License for more details. -%# -%# You should have received a copy of the GNU General Public License -%# along with this program; If not, see <http://www.gnu.org/licenses/>. +## Copyright (C) 2006-2012, Thomas Treichl <treichl@users.sourceforge.net> +## +## This file is part of Octave. +## +## Octave is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. +## +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with Octave; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. -%# -*- texinfo -*- -%# @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} either is of type double column vector (for ODEs and DAEs) and specifies the solutions or is of type cell array (for IDEs and DDEs) and specifies the derivatives or the history values, the third input argument @var{flag} is of type string and can be of the form -%# @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} +## -*- texinfo -*- +## @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} either is of type double column vector (for ODEs and DAEs) and specifies the solutions or is of type cell array (for IDEs and DDEs) and specifies the derivatives or the history values, the third input argument @var{flag} is of type string and can be of the form +## @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. + ## 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 - %# vretval{4} is the line by line result information matrix + ## 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 + ## vretval{4} is the line by line result information matrix - %# These persistent variables are needed to store the results and the - %# time value from the processing in the time stamp before, veveold - %# are the results from the event function, vtold the time stamp, - %# vretcell the return values cell array, vyold the result of the ode - %# and vevecnt the counter for how often this event handling - %# has been called + ## These persistent variables are needed to store the results and the + ## time value from the processing in the time stamp before, veveold + ## are the results from the event function, vtold the time stamp, + ## vretcell the return values cell array, vyold the result of the ode + ## and vevecnt the counter for how often this event handling + ## has been called persistent veveold; persistent vtold; persistent vretcell; persistent vyold; persistent vevecnt; - %# Call the event function if an event function has been defined to - %# initialize the internal variables of the event function an to get - %# a value for veveold + ## Call the event function if an event function has been defined to + ## initialize the internal variables of the event function an to get + ## a value for veveold if (strcmp (vflag, 'init')) if (~iscell (vy)) vinpargs = {vevefun, vt, vy}; else vinpargs = {vevefun, vt, vy{1}, vy{2}}; - vy = vy{1}; %# Delete cell element 2 + vy = vy{1}; ## Delete cell element 2 end if (nargin > 4) vinpargs = {vinpargs{:}, varargin{:}}; end [veveold, vterm, vdir] = feval (vinpargs{:}); - %# We assume that all return values must be column vectors + ## We assume that all return values must be column vectors veveold = veveold(:)'; vterm = vterm(:)'; vdir = vdir(:)'; vtold = vt; vyold = vy; vevecnt = 1; vretcell = cell (1,4); - %# Process the event, find the zero crossings either for a rising - %# or for a falling edge + ## Process the event, find the zero crossings either for a rising + ## or for a falling edge elseif (isempty (vflag)) if (~iscell (vy)) vinpargs = {vevefun, vt, vy}; else vinpargs = {vevefun, vt, vy{1}, vy{2}}; - vy = vy{1}; %# Delete cell element 2 + vy = vy{1}; ## Delete cell element 2 end if (nargin > 4) vinpargs = {vinpargs{:}, varargin{:}}; end [veve, vterm, vdir] = feval (vinpargs{:}); - %# We assume that all return values must be column vectors + ## We assume that all return values must be column vectors veve = veve(:)'; vterm = vterm(:)'; vdir = vdir(:)'; - %# Check if one or more signs of the event has changed + ## Check if one or more signs of the event has changed vsignum = (sign (veveold) ~= sign (veve)); - if (any (vsignum)) %# One or more values have changed - vindex = find (vsignum); %# Get the index of the changed values + if (any (vsignum)) ## One or more values have changed + vindex = find (vsignum); ## Get the index of the changed values if (any (vdir(vindex) == 0)) - %# Rising or falling (both are possible) - %# Don't change anything, keep the index + ## Rising or falling (both are possible) + ## Don't change anything, keep the index elseif (any (vdir(vindex) == sign (veve(vindex)))) - %# Detected rising or falling, need a new index + ## Detected rising or falling, need a new index vindex = find (vdir == sign (veve)); else - %# Found a zero crossing but must not be notified + ## Found a zero crossing but must not be notified vindex = []; end - %# Create new output values if a valid index has been found + ## Create new output values if a valid index has been found if (~isempty (vindex)) - %# Change the persistent result cell array - vretcell{1} = any (vterm(vindex)); %# Stop integration or not - vretcell{2}(vevecnt,1) = vindex(1,1); %# Take first event found - %# Calculate the time stamp when the event function returned 0 and - %# calculate new values for the integration results, we do both by - %# a linear interpolation + ## Change the persistent result cell array + vretcell{1} = any (vterm(vindex)); ## Stop integration or not + vretcell{2}(vevecnt,1) = vindex(1,1); ## Take first event found + ## Calculate the time stamp when the event function returned 0 and + ## calculate new values for the integration results, we do both by + ## a linear interpolation vtnew = vt - veve(1,vindex) * (vt - vtold) / (veve(1,vindex) - veveold(1,vindex)); vynew = (vy - (vt - vtnew) * (vy - vyold) / (vt - vtold))'; vretcell{3}(vevecnt,1) = vtnew; vretcell{4}(vevecnt,:) = vynew; vevecnt = vevecnt + 1; - end %# if (~isempty (vindex)) + end ## if (~isempty (vindex)) - end %# Check for one or more signs ... + end ## Check for one or more signs ... veveold = veve; vtold = vt; vretval = vretcell; vyold = vy; - elseif (strcmp (vflag, 'done')) %# Clear this event handling function + elseif (strcmp (vflag, 'done')) ## Clear this event handling function clear ('veveold', 'vtold', 'vretcell', 'vyold', 'vevecnt'); vretcell = cell (1,4); end - -%# Local Variables: *** -%# mode: octave *** -%# End: ***
--- a/scripts/ode/private/runge_kutta_45_dorpri.m Thu Oct 01 16:18:19 2015 -0400 +++ b/scripts/ode/private/runge_kutta_45_dorpri.m Fri Oct 02 05:50:43 2015 +0200 @@ -1,18 +1,20 @@ ## Copyright (C) 2013, Roberto Porcu' <roberto.porcu@polimi.it> -## OdePkg - A package for solving ordinary differential equations and more +## +## This file is part of Octave. ## -## This program is free software; you can redistribute it and/or modify -## it under the terms of the GNU General Public License as published by -## the Free Software Foundation; either version 2 of the License, or -## (at your option) any later version. +## Octave is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. ## -## This program is distributed in the hope that it will be useful, -## but WITHOUT ANY WARRANTY; without even the implied warranty of -## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -## GNU General Public License for more details. +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. ## ## You should have received a copy of the GNU General Public License -## along with this program; If not, see <http://www.gnu.org/licenses/>. +## along with Octave; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Command} {[@var{t_next}, @var{x_next}] =} @@ -63,13 +65,14 @@ function varargout = runge_kutta_45_dorpri (f, t, x, dt, varargin) options = varargin{1}; - k = zeros (size (x, 1), 4); + k = zeros (rows (x), 6); if (nargin == 5) # only the options are passed k(:,1) = feval (f, t , x, options.vfunarguments{:}); elseif (nargin == 6) # both the options and the k values are passed k(:,1) = varargin{2}(:,end); # FSAL property endif + k(:,1) = feval (f, t, x, options.vfunarguments{:}); k(:,2) = feval (f, t + (1/5)*dt, ... x + dt * (1/5)*k(:,1), ... @@ -112,6 +115,3 @@ endfunction -## Local Variables: *** -## mode: octave *** -## End: ***
--- a/scripts/ode/private/starting_stepsize.m Thu Oct 01 16:18:19 2015 -0400 +++ b/scripts/ode/private/starting_stepsize.m Fri Oct 02 05:50:43 2015 +0200 @@ -1,19 +1,20 @@ ## Copyright (C) 2013, Roberto Porcu' <roberto.porcu@polimi.it> -## OdePkg - A package for solving ordinary differential equations and more +## +## This file is part of Octave. ## -## This program is free software; you can redistribute it and/or modify -## it under the terms of the GNU General Public License as published by -## the Free Software Foundation; either version 2 of the License, or -## (at your option) any later version. +## Octave is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. ## -## This program is distributed in the hope that it will be useful, -## but WITHOUT ANY WARRANTY; without even the implied warranty of -## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -## GNU General Public License for more details. +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. ## ## You should have received a copy of the GNU General Public License -## along with this program; If not, see <http://www.gnu.org/licenses/>. - +## along with Octave; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Command} {[@var{h}] =} starting_stepsize (@var{order},