updated function headers

tamaskis · tamaskis · commit 0bdf58fd104e · 2022-07-06T12:54:23.000-04:00
diff --git a/INSTALL/IVP Solver Toolbox.mltbx b/INSTALL/IVP Solver Toolbox.mltbx
diff --git a/examples/example_brute_force.m b/examples/example_brute_force.m
@@ -4,7 +4,7 @@
 % Example of a "brute force" method for solving IVPs.
 %
 % Copyright © 2021 Tamas Kis
-% Last Update: 2022-06-07
+% Last Update: 2022-07-06
 % Website: https://tamaskis.github.io
 % Contact: tamas.a.kis@outlook.com
 
diff --git a/examples/example_define_ivp.m b/examples/example_define_ivp.m
@@ -4,7 +4,7 @@
 % Example of defining an IVP.
 %
 % Copyright © 2021 Tamas Kis
-% Last Update: 2022-06-07
+% Last Update: 2022-07-06
 % Website: https://tamaskis.github.io
 % Contact: tamas.a.kis@outlook.com
 
diff --git a/examples/example_lorenz.m b/examples/example_lorenz.m
@@ -5,7 +5,7 @@
 % the thumbnail image for the IVP solver toolbox.
 %
 % Copyright © 2021 Tamas Kis
-% Last Update: 2022-06-07
+% Last Update: 2022-07-06
 % Website: https://tamaskis.github.io
 % Contact: tamas.a.kis@outlook.com
 
diff --git a/examples/example_matrix_ode.m b/examples/example_matrix_ode.m
@@ -5,7 +5,7 @@
 % equation).
 %
 % Copyright © 2021 Tamas Kis
-% Last Update: 2022-06-07
+% Last Update: 2022-07-06
 % Website: https://tamaskis.github.io
 % Contact: tamas.a.kis@outlook.com
 
diff --git a/examples/example_pass_extra.m b/examples/example_pass_extra.m
@@ -4,7 +4,7 @@
 % Example of passing extra parameters to functions.
 %
 % Copyright © 2021 Tamas Kis
-% Last Update: 2022-06-07
+% Last Update: 2022-07-06
 % Website: https://tamaskis.github.io
 % Contact: tamas.a.kis@outlook.com
 
diff --git a/examples/example_return_extra.m b/examples/example_return_extra.m
@@ -4,7 +4,7 @@
 % Example of returning extra parameters from an IVP solution.
 %
 % Copyright © 2021 Tamas Kis
-% Last Update: 2022-06-07
+% Last Update: 2022-07-06
 % Website: https://tamaskis.github.io
 % Contact: tamas.a.kis@outlook.com
 
diff --git a/examples/example_waitbar.m b/examples/example_waitbar.m
@@ -4,7 +4,7 @@
 % Examples demonstrating how to use waitbar.
 %
 % Copyright © 2021 Tamas Kis
-% Last Update: 2022-06-07
+% Last Update: 2022-07-06
 % Website: https://tamaskis.github.io
 % Contact: tamas.a.kis@outlook.com
 
diff --git a/toolbox/doc/doc_IVP.m b/toolbox/doc/doc_IVP.m
@@ -7,7 +7,7 @@
 %   doc_IVP tech
 %
 % Copyright © 2021 Tamas Kis
-% Last Update: 2022-06-07
+% Last Update: 2022-07-06
 % Website: https://tamaskis.github.io
 % Contact: tamas.a.kis@outlook.com
 %
diff --git a/toolbox/generatingequations/AB_coefficients.m b/toolbox/generatingequations/AB_coefficients.m
@@ -25,7 +25,7 @@
 % INPUT:
 % ------
 %   m       - (1×1 double) order of Adams-Bashforth predictor
-%   print   - (char) (OPTIONAL) prints coefficients if input as 'print'
+%   print   - (OPTIONAL) (char) prints coefficients if input as 'print'
 %
 % -------
 % OUTPUT:
diff --git a/toolbox/generatingequations/AB_predictor.m b/toolbox/generatingequations/AB_predictor.m
@@ -25,7 +25,7 @@
 % INPUT:
 % ------
 %   m       - (1×1 double) order of Adams-Bashforth predictor
-%   print   - (char) (OPTIONAL) prints coefficients if input as 'print'
+%   print   - (OPTIONAL) (char) prints coefficients if input as 'print'
 %
 % -------
 % OUTPUT:
diff --git a/toolbox/generatingequations/AM_coefficients.m b/toolbox/generatingequations/AM_coefficients.m
@@ -24,7 +24,7 @@
 % INPUT:
 % ------
 %   m       - (1×1 double) order of Adams-Moulton corrector
-%   print   - (char) (OPTIONAL) prints coefficients if input as 'print'
+%   print   - (OPTIONAL) (char) prints coefficients if input as 'print'
 %
 % -------
 % OUTPUT:
diff --git a/toolbox/generatingequations/AM_corrector.m b/toolbox/generatingequations/AM_corrector.m
@@ -24,7 +24,7 @@
 % INPUT:
 % ------
 %   m       - (1×1 double) order of Adams-Moulton corrector
-%   print   - (char) (OPTIONAL) prints coefficients if input as 'print'
+%   print   - (OPTIONAL) (char) prints coefficients if input as 'print'
 %
 % -------
 % OUTPUT:
diff --git a/toolbox/generatingequations/tableau2eqns.m b/toolbox/generatingequations/tableau2eqns.m
@@ -24,8 +24,8 @@
 % INPUT:
 % ------
 %   T       - ((s+1)×(s+1) double) Butcher tableau
-%   name    - (1×1 string) (OPTIONAL) name of the method
-%   type    - (char) (OPTIONAL) print coefficients as 'decimal' or 
+%   name    - (OPTIONAL) (1×1 string) name of the method
+%   type    - (OPTIONAL) (char) print coefficients as 'decimal' or 
 %             'fraction' (defaults to 'fraction')
 %
 % -----
@@ -72,7 +72,7 @@ function tableau2eqns(T,name,type)
     % k terms with coefficients as fractions
     if strcmpi(type,'fraction')
         for i = 1:s
-
+            
             % first half of the argument of f(__,__)
             [nl,dl] = rat(c(i));
             if nl == 0            
@@ -86,7 +86,7 @@ function tableau2eqns(T,name,type)
             elseif (nl ~= 1) && (dl ~= 1)
                 fprintf("k%d = f(t(n) + %dh/%d, y(n)",i,nl,dl);
             end
-
+            
             % second half of the argument of f(__,__)
             for j = 1:s
                 [nr,dr] = rat(A(i,j));
@@ -108,11 +108,11 @@ function tableau2eqns(T,name,type)
             end
             fprintf(")\n");
         end
-    
+        
     % k terms with coefficients as decimals
     else
         for i = 1:s
-
+            
             % first half of the argument of f(__,__)
             if c(i) == 0            
                 fprintf("k%d = f(t(n), y(n)",i);
@@ -121,7 +121,7 @@ function tableau2eqns(T,name,type)
             else
                 fprintf("k%d = f(t(n) + %.8fh, y(n)",i,c(i));
             end
-
+            
             % second half of the argument of f(__,__)
             for j = 1:s
                 if A(i,j) > 0
diff --git a/toolbox/ivpsolver/expand_ivp_arrays.m b/toolbox/ivpsolver/expand_ivp_arrays.m
@@ -39,7 +39,7 @@
 %       have become full.
 %
 %==========================================================================
-function [t_new,y_new] = expand_solution_arrays(t,y)
+function [t_new,y_new] = expand_ivp_arrays(t,y)
     
     % number of subintervals
     N = length(t)-1;
diff --git a/toolbox/ivpsolver/solve_ivp.m b/toolbox/ivpsolver/solve_ivp.m
@@ -32,12 +32,12 @@
 %                             (C : ℝ×ℝᵖ → B)
 %   y0      - (p×1 double) initial condition, y₀ = y(t₀)
 %   h       - (1×1 double) step size
-%   method  - (char) (OPTIONAL) integration method --> 'Euler', 'RK2', 
+%   method  - (OPTIONAL) (char) integration method --> 'Euler', 'RK2', 
 %             'RK2 Heun', 'RK2 Ralston', 'RK3', 'RK3 Heun', 'RK3 Ralston', 
 %             'SSPRK3', 'RK4', 'RK4 Ralston', 'RK4 3/8', 'AB2', 'AB3', 
 %             'AB4', 'AB5', 'AB6', 'AB7', 'AB8', 'ABM2', 'ABM3', 'ABM4', 
 %             'ABM5', 'ABM6', 'ABM7', 'ABM8' (defaults to 'RK4')
-%   wb      - (1×1 logical or char) (OPTIONAL) waitbar parameters
+%   wb      - (OPTIONAL) (1×1 logical or char) waitbar parameters
 %               --> input as "true" if you want waitbar with default 
 %                   message displayed
 %               --> input as a char array storing a message if you want a
diff --git a/toolbox/matrixivp/ivpsol_vec2mat.m b/toolbox/matrixivp/ivpsol_vec2mat.m
@@ -25,7 +25,7 @@
 % INPUT:
 % ------
 %   y       - ((N+1)×pr double) matrix storing time history of state vector
-%   p       - (1×1 double) (OPTIONAL) number of rows of state matrix
+%   p       - (OPTIONAL) (1×1 double) number of rows of state matrix
 %
 % -------
 % OUTPUT:
diff --git a/toolbox/matrixivp/odefun_mat2vec.m b/toolbox/matrixivp/odefun_mat2vec.m
@@ -26,7 +26,7 @@
 %   F       - (1×1 function_handle) dM/dt = F(t,M) --> multivariate, 
 %             matrix-valued function (F : ℝ×ℝᵖˣʳ → ℝᵖˣʳ) defining
 %             matrix-valued ODE
-%   p       - (1×1 double) (OPTIONAL) number of rows of state matrix
+%   p       - (OPTIONAL) (1×1 double) number of rows of state matrix
 %
 % -------
 % OUTPUT:

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`% Example of a "brute force" method for solving IVPs.`
`5`	`5`	`%`
`6`	`6`	`% Copyright © 2021 Tamas Kis`
`7`		`-% Last Update: 2022-06-07`
	`7`	`+% Last Update: 2022-07-06`
`8`	`8`	`% Website: https://tamaskis.github.io`
`9`	`9`	`% Contact: tamas.a.kis@outlook.com`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`% Example of defining an IVP.`
`5`	`5`	`%`
`6`	`6`	`% Copyright © 2021 Tamas Kis`
`7`		`-% Last Update: 2022-06-07`
	`7`	`+% Last Update: 2022-07-06`
`8`	`8`	`% Website: https://tamaskis.github.io`
`9`	`9`	`% Contact: tamas.a.kis@outlook.com`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`% the thumbnail image for the IVP solver toolbox.`
`6`	`6`	`%`
`7`	`7`	`% Copyright © 2021 Tamas Kis`
`8`		`-% Last Update: 2022-06-07`
	`8`	`+% Last Update: 2022-07-06`
`9`	`9`	`% Website: https://tamaskis.github.io`
`10`	`10`	`% Contact: tamas.a.kis@outlook.com`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`% equation).`
`6`	`6`	`%`
`7`	`7`	`% Copyright © 2021 Tamas Kis`
`8`		`-% Last Update: 2022-06-07`
	`8`	`+% Last Update: 2022-07-06`
`9`	`9`	`% Website: https://tamaskis.github.io`
`10`	`10`	`% Contact: tamas.a.kis@outlook.com`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`% Example of passing extra parameters to functions.`
`5`	`5`	`%`
`6`	`6`	`% Copyright © 2021 Tamas Kis`
`7`		`-% Last Update: 2022-06-07`
	`7`	`+% Last Update: 2022-07-06`
`8`	`8`	`% Website: https://tamaskis.github.io`
`9`	`9`	`% Contact: tamas.a.kis@outlook.com`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`% Example of returning extra parameters from an IVP solution.`
`5`	`5`	`%`
`6`	`6`	`% Copyright © 2021 Tamas Kis`
`7`		`-% Last Update: 2022-06-07`
	`7`	`+% Last Update: 2022-07-06`
`8`	`8`	`% Website: https://tamaskis.github.io`
`9`	`9`	`% Contact: tamas.a.kis@outlook.com`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`% Examples demonstrating how to use waitbar.`
`5`	`5`	`%`
`6`	`6`	`% Copyright © 2021 Tamas Kis`
`7`		`-% Last Update: 2022-06-07`
	`7`	`+% Last Update: 2022-07-06`
`8`	`8`	`% Website: https://tamaskis.github.io`
`9`	`9`	`% Contact: tamas.a.kis@outlook.com`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`% doc_IVP tech`
`8`	`8`	`%`
`9`	`9`	`% Copyright © 2021 Tamas Kis`
`10`		`-% Last Update: 2022-06-07`
	`10`	`+% Last Update: 2022-07-06`
`11`	`11`	`% Website: https://tamaskis.github.io`
`12`	`12`	`% Contact: tamas.a.kis@outlook.com`
`13`	`13`	`%`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`% INPUT:`
`26`	`26`	`% ------`
`27`	`27`	`% m - (1×1 double) order of Adams-Bashforth predictor`
`28`		`-% print - (char) (OPTIONAL) prints coefficients if input as 'print'`
	`28`	`+% print - (OPTIONAL) (char) prints coefficients if input as 'print'`
`29`	`29`	`%`
`30`	`30`	`% -------`
`31`	`31`	`% OUTPUT:`