indicating optional arguments and constraining the number of arguments

The word optional for arguments are not necessary have been included. Explicit constraints to the number of arguments of div, grad, and lap were added.

Author: mdumett

src/matlab/div.m

@@ -7,8 +7,8 @@
 %                k : Order of accuracy
 %                m : Number of cells
 %               dx : Step size
-%               dc : a0 (2x1 vector for left and right vertices, resp.)
-%               nc : b0 (2x1 vector for left and right vertices, resp.)
+%    (optional) dc : a0 (2x1 vector for left and right vertices, resp.)
+%    (optional) nc : b0 (2x1 vector for left and right vertices, resp.)
 %
 % ----------------------------------------------------------------------------
 % SPDX-License-Identifier: GPL-3.0-or-later
@@ -17,8 +17,12 @@
 % ----------------------------------------------------------------------------
 %
 
+    if nargin ~= 3 && nargin ~= 5
+        error('div:InvalidNumArgs', 'div expects 3 or 5 arguments');
+    end
+
     % for legacy code
-    if nargin <= 3
+    if nargin == 3
         D = divNonPeriodic(k, m, dx);
         return;
     end

src/matlab/div2D.m

@@ -9,8 +9,8 @@
 %               dx : Step size
 %                n : Number of cells along y-axis
 %               dy : Step size along y-axis
-%               dc : a0 (4x1 vector for left, right, bottom, top boundaries, resp.)
-%               nc : b0 (4x1 vector for left, right, bottom, top boundaries, resp.)
+%    (optional) dc : a0 (4x1 vector for left, right, bottom, top boundaries, resp.)
+%    (optional) nc : b0 (4x1 vector for left, right, bottom, top boundaries, resp.)
 %
 % ----------------------------------------------------------------------------
 % SPDX-License-Identifier: GPL-3.0-or-later
@@ -19,8 +19,12 @@
 % ----------------------------------------------------------------------------
 %
 
+    if nargin ~= 5 && nargin ~= 7
+        error('div:InvalidNumArgs', 'div expects 5 or 7 arguments');
+    end
+    
     % for legacy code
-    if nargin <= 5
+    if nargin == 5
         D = divNonPeriodic2D(k, m, dx, n, dy);
         return;
     end

src/matlab/div3D.m

@@ -11,8 +11,8 @@
 %               dy : Step size along y-axis
 %                o : Number of cells along z-axis
 %               dz : Step size along z-axis
-%               dc : a0 (6x1 vector for left, right, bottom, top, front, back boundary types, resp.)
-%               nc : b0 (6x1 vector for left, right, bottom, top, front, back boundary types, resp.)
+%    (optional) dc : a0 (6x1 vector for left, right, bottom, top, front, back boundary types, resp.)
+%    (optional) nc : b0 (6x1 vector for left, right, bottom, top, front, back boundary types, resp.)
 %
 % ----------------------------------------------------------------------------
 % SPDX-License-Identifier: GPL-3.0-or-later
@@ -21,8 +21,12 @@
 % ----------------------------------------------------------------------------
 %
 
+    if nargin ~= 7 && nargin ~= 9
+        error('div:InvalidNumArgs', 'div expects 7 or 9 arguments');
+    end
+    
     % for legacy code
-    if nargin <= 7
+    if nargin == 7
         D = divNonPeriodic3D(k, m, dx, n, dy, o, dz);
         return;
     end

src/matlab/grad.m

@@ -7,8 +7,8 @@
 %                k : Order of accuracy
 %                m : Number of cells
 %               dx : Step size
-%               dc : a0 (2x1 vector for left and right vertices, resp.)
-%               nc : b0 (2x1 vector for left and right vertices, resp.)
+%    (optional) dc : a0 (2x1 vector for left and right vertices, resp.)
+%    (optional) nc : b0 (2x1 vector for left and right vertices, resp.)
 %
 % ----------------------------------------------------------------------------
 % SPDX-License-Identifier: GPL-3.0-or-later
@@ -17,8 +17,12 @@
 % ----------------------------------------------------------------------------
 %
 
+    if nargin ~= 3 && nargin ~= 5
+        error('div:InvalidNumArgs', 'div expects 3 or 5 arguments');
+    end
+    
     % for legacy code
-    if nargin <= 3
+    if nargin == 3
         G = gradNonPeriodic(k, m, dx);
         return;
     end

src/matlab/grad2D.m

@@ -9,8 +9,8 @@
 %               dx : Step size
 %                n : Number of cells along y-axis
 %               dy : Step size along y-axis
-%               dc : a0 (4x1 vector for left, right, bottom, top boundaries, resp.)
-%               nc : b0 (4x1 vector for left, right, bottom, top boundaries, resp.)
+%    (optional) dc : a0 (4x1 vector for left, right, bottom, top boundaries, resp.)
+%    (optional) nc : b0 (4x1 vector for left, right, bottom, top boundaries, resp.)
 %
 % ----------------------------------------------------------------------------
 % SPDX-License-Identifier: GPL-3.0-or-later
@@ -19,8 +19,12 @@
 % ----------------------------------------------------------------------------
 %
 
+    if nargin ~= 5 && nargin ~= 7
+        error('div:InvalidNumArgs', 'div expects 5 or 7 arguments');
+    end
+    
     % for legacy code
-    if nargin <= 5
+    if nargin == 5
         G = gradNonPeriodic2D(k, m, dx, n, dy);
         return;
     end

src/matlab/grad3D.m

@@ -11,8 +11,8 @@
 %               dy : Step size along y-axis
 %                o : Number of cells along z-axis
 %               dz : Step size along z-axis
-%               dc : a0 (6x1 vector for left, right, bottom, top, front, back boundary types, resp.)
-%               nc : b0 (6x1 vector for left, right, bottom, top, front, back boundary types, resp.)
+%    (optional) dc : a0 (6x1 vector for left, right, bottom, top, front, back boundary types, resp.)
+%    (optional) nc : b0 (6x1 vector for left, right, bottom, top, front, back boundary types, resp.)
 %
 % ----------------------------------------------------------------------------
 % SPDX-License-Identifier: GPL-3.0-or-later
@@ -21,8 +21,12 @@
 % ----------------------------------------------------------------------------
 %
 
+    if nargin ~= 7 && nargin ~= 9
+        error('div:InvalidNumArgs', 'div expects 7 or 9 arguments');
+    end
+    
     % for legacy code
-    if nargin <= 7
+    if nargin == 7
         G = gradNonPeriodic3D(k, m, dx, n, dy, o, dz);
         return;
     end

src/matlab/lap.m

@@ -7,8 +7,8 @@
 %                k : Order of accuracy
 %                m : Number of cells
 %               dx : Step size
-%               dc : a0 (2x1 vector for left and right vertices, resp.)
-%               nc : b0 (2x1 vector for left and right vertices, resp.)
+%    (optional) dc : a0 (2x1 vector for left and right vertices, resp.)
+%    (optional) nc : b0 (2x1 vector for left and right vertices, resp.)
 %
 % ----------------------------------------------------------------------------
 % SPDX-License-Identifier: GPL-3.0-or-later
@@ -17,8 +17,12 @@
 % ----------------------------------------------------------------------------
 %
 
+    if nargin ~= 3 && nargin ~= 5
+        error('div:InvalidNumArgs', 'div expects 3 or 5 arguments');
+    end
+    
     % for legacy code
-    if nargin <= 3
+    if nargin == 3
         L = lapNonPeriodic(k, m, dx);
         return;
     end

src/matlab/lap2D.m

@@ -9,8 +9,8 @@
 %               dx : Step size along x-axis
 %                n : Number of cells along y-axis
 %               dy : Step size along y-axis
-%               dc : a0 (4x1 vector for left, right, bottom, top boundaries, resp.)
-%               nc : b0 (4x1 vector for left, right, bottom, top boundaries, resp.)
+%    (optional) dc : a0 (4x1 vector for left, right, bottom, top boundaries, resp.)
+%    (optional) nc : b0 (4x1 vector for left, right, bottom, top boundaries, resp.)
 %
 % ----------------------------------------------------------------------------
 % SPDX-License-Identifier: GPL-3.0-or-later
@@ -19,8 +19,12 @@
 % ----------------------------------------------------------------------------
 %
 
+    if nargin ~= 5 && nargin ~= 7
+        error('div:InvalidNumArgs', 'div expects 5 or 7 arguments');
+    end
+    
     % for legacy code
-    if nargin <= 5
+    if nargin == 5
         L = lapNonPeriodic2D(k, m, dx, n, dy);
         return;
     end

src/matlab/lap3D.m

@@ -11,8 +11,8 @@
 %               dy : Step size along y-axis
 %                o : Number of cells along z-axis
 %               dz : Step size along z-axis
-%               dc : a0 (6x1 vector for left, right, bottom, top, front, back boundary types, resp.)
-%               nc : b0 (6x1 vector for left, right, bottom, top, front, back boundary types, resp.)
+%    (optional) dc : a0 (6x1 vector for left, right, bottom, top, front, back boundary types, resp.)
+%    (optional) nc : b0 (6x1 vector for left, right, bottom, top, front, back boundary types, resp.)
 %
 % ----------------------------------------------------------------------------
 % SPDX-License-Identifier: GPL-3.0-or-later
@@ -21,8 +21,12 @@
 % ----------------------------------------------------------------------------
 %
 
+    if nargin ~= 7 && nargin ~= 9
+        error('div:InvalidNumArgs', 'div expects 7 or 9 arguments');
+    end
+    
     % for legacy code
-    if nargin <= 7
+    if nargin == 7
         L = lapNonPeriodic3D(k, m, dx, n, dy, o, dz);
         return;
     end