changeset 27969:a9a8699a3749

Remove argouts from new validator functions (Bug #57627). The argouts are a non-Matlab-compatible extension that got pulled over from Validoozy by mistake.
author Andrew Janke <andrew@apjanke.net>
date Mon, 20 Jan 2020 00:13:21 -0500
parents c9dd91b438fd
children 9e769371fb45
files scripts/miscellaneous/mustBeFinite.m scripts/miscellaneous/mustBeGreaterThan.m scripts/miscellaneous/mustBeGreaterThanOrEqual.m scripts/miscellaneous/mustBeInteger.m scripts/miscellaneous/mustBeLessThan.m scripts/miscellaneous/mustBeLessThanOrEqual.m scripts/miscellaneous/mustBeMember.m scripts/miscellaneous/mustBeNegative.m scripts/miscellaneous/mustBeNonNan.m scripts/miscellaneous/mustBeNonempty.m scripts/miscellaneous/mustBeNonnegative.m scripts/miscellaneous/mustBeNonpositive.m scripts/miscellaneous/mustBeNonsparse.m scripts/miscellaneous/mustBeNonzero.m scripts/miscellaneous/mustBeNumeric.m scripts/miscellaneous/mustBeNumericOrLogical.m scripts/miscellaneous/mustBePositive.m scripts/miscellaneous/mustBeReal.m
diffstat 18 files changed, 36 insertions(+), 36 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/miscellaneous/mustBeFinite.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeFinite.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeFinite (@var{x})
+## @deftypefn {} {} mustBeFinite (@var{x})
 ##
 ## Requires that input @var{x} is finite.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeFinite (x)
+function mustBeFinite (x)
   tf = isfinite (x);
   if ! all (tf)
     label = inputname (1);
--- a/scripts/miscellaneous/mustBeGreaterThan.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeGreaterThan.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeGreaterThan (@var{x}, @var{c})
+## @deftypefn {} {} mustBeGreaterThan (@var{x}, @var{c})
 ##
 ## Requires that input @var{x} is greater than @var{c}.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeGreaterThan (x, c)
+function mustBeGreaterThan (x, c)
   tf = x > c;
   tf = tf(:);
   if ! all (tf)
--- a/scripts/miscellaneous/mustBeGreaterThanOrEqual.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeGreaterThanOrEqual.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeGreaterThanOrEqual (@var{x}, @var{c})
+## @deftypefn {} {} mustBeGreaterThanOrEqual (@var{x}, @var{c})
 ##
 ## Requires that input @var{x} is greater than or equal to @var{c}.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeGreaterThanOrEqual (x, c)
+function mustBeGreaterThanOrEqual (x, c)
   tf = x >= c;
   tf = tf(:);
   if ! all (tf)
--- a/scripts/miscellaneous/mustBeInteger.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeInteger.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeInteger (@var{x})
+## @deftypefn {} {} mustBeInteger (@var{x})
 ##
 ## Requires that input @var{x} is integer-valued (but not necessarily
 ## integer-typed).
@@ -34,7 +34,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeInteger (x)
+function mustBeInteger (x)
   if isinteger (x) || islogical (x)
     return
   endif
--- a/scripts/miscellaneous/mustBeLessThan.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeLessThan.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeLessThan (@var{x}, @var{c})
+## @deftypefn {} {} mustBeLessThan (@var{x}, @var{c})
 ##
 ## Requires that input @var{x} is less than @var{c}.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeLessThan (x, c)
+function mustBeLessThan (x, c)
   tf = x < c;
   tf = tf(:);
   if ! all (tf)
--- a/scripts/miscellaneous/mustBeLessThanOrEqual.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeLessThanOrEqual.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeLessThanOrEqual (@var{x}, @var{c})
+## @deftypefn {} {} mustBeLessThanOrEqual (@var{x}, @var{c})
 ##
 ## Requires that input is less than or equal to a given value.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeLessThanOrEqual (x, c)
+function mustBeLessThanOrEqual (x, c)
   tf = x <= c;
   tf = tf(:);
   if ! all (tf)
--- a/scripts/miscellaneous/mustBeMember.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeMember.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeMember (@var{x}, @var{valid})
+## @deftypefn {} {} mustBeMember (@var{x}, @var{valid})
 ##
 ## Requires that input @var{x} is a member of a set of given valid values.
 ##
@@ -37,7 +37,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeMember (x, valid)
+function mustBeMember (x, valid)
   tf = ismember (x, valid);
   if ! all (tf)
     label = inputname (1);
--- a/scripts/miscellaneous/mustBeNegative.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeNegative.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeNegative (@var{x})
+## @deftypefn {} {} mustBeNegative (@var{x})
 ##
 ## Requires that input @var{x} is negative.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeNegative (x)
+function mustBeNegative (x)
   tf = x < 0;
   tf = tf(:);
   if ! all (tf)
--- a/scripts/miscellaneous/mustBeNonNan.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeNonNan.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeNonNan (@var{x})
+## @deftypefn {} {} mustBeNonNan (@var{x})
 ##
 ## Requires that input @var{x} is non-NaN.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeNonNan (x)
+function mustBeNonNan (x)
   tf = ! isnan (x);
   tf = tf(:);
   if ! all (tf)
--- a/scripts/miscellaneous/mustBeNonempty.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeNonempty.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeNonempty (@var{x})
+## @deftypefn {} {} mustBeNonempty (@var{x})
 ##
 ## Requires that input @var{x} is nonempty.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeNonempty (x)
+function mustBeNonempty (x)
   if isempty (x)
     label = inputname (1);
     if isempty (label)
--- a/scripts/miscellaneous/mustBeNonnegative.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeNonnegative.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeNonnegative (@var{x})
+## @deftypefn {} {} mustBeNonnegative (@var{x})
 ##
 ## Requires that input @var{x} is not negative.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeNonnegative (x)
+function mustBeNonnegative (x)
   tf = x >= 0;
   tf = tf(:);
   if ! all (tf)
--- a/scripts/miscellaneous/mustBeNonpositive.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeNonpositive.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeNonpositive (@var{x})
+## @deftypefn {} {} mustBeNonpositive (@var{x})
 ##
 ## Requires that input @var{x} is not positive.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeNonpositive (x)
+function mustBeNonpositive (x)
   tf = x <= 0;
   tf = tf(:);
   if ! all (tf)
--- a/scripts/miscellaneous/mustBeNonsparse.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeNonsparse.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeNonsparse (@var{x})
+## @deftypefn {} {} mustBeNonsparse (@var{x})
 ##
 ## Requires that input @var{x} is not sparse.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeNonsparse (x)
+function mustBeNonsparse (x)
   if issparse (x)
     label = inputname (1);
     if isempty (label)
--- a/scripts/miscellaneous/mustBeNonzero.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeNonzero.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeNonzero (@var{x})
+## @deftypefn {} {} {mustBeNonzero (@var{x})
 ##
 ## Requires that input @var{x} is not zero.
 ##
@@ -37,7 +37,7 @@
 # but that may not be the spirit of the test. And it's not equal to any non-zero
 # value.
 
-function x = mustBeNonzero (x)
+function mustBeNonzero (x)
   tf = x != 0;
   tf = tf(:);
   if ! all (tf)
--- a/scripts/miscellaneous/mustBeNumeric.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeNumeric.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeNumeric (@var{x})
+## @deftypefn {} {} mustBeNumeric (@var{x})
 ##
 ## Requires that input @var{x} is numeric.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeNumeric (x)
+function mustBeNumeric (x)
   if ! isnumeric (x)
     label = inputname (1);
     if isempty (label)
--- a/scripts/miscellaneous/mustBeNumericOrLogical.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeNumericOrLogical.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeNumericOrLogical (@var{x})
+## @deftypefn {} {} mustBeNumericOrLogical (@var{x})
 ##
 ## Requires that input @var{x} is numeric or logical.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeNumericOrLogical (x)
+function mustBeNumericOrLogical (x)
   if ! (isnumeric (x) || islogical (x))
     label = inputname (1);
     if isempty (label)
--- a/scripts/miscellaneous/mustBePositive.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBePositive.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBePositive (@var{x})
+## @deftypefn {} {} mustBePositive (@var{x})
 ##
 ## Requires that input @var{x} is positive.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBePositive (x)
+function mustBePositive (x)
   tf = x > 0;
   tf = tf(:);
   if ! all (tf)
--- a/scripts/miscellaneous/mustBeReal.m	Mon Jan 20 00:08:43 2020 -0500
+++ b/scripts/miscellaneous/mustBeReal.m	Mon Jan 20 00:13:21 2020 -0500
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{x} =} mustBeReal (@var{x})
+## @deftypefn {} {} mustBeReal (@var{x})
 ##
 ## Requires that input @var{x} is real.
 ##
@@ -33,7 +33,7 @@
 ##
 ## @end deftypefn
 
-function x = mustBeReal (x)
+function mustBeReal (x)
   if ! isreal (x)
     label = inputname (1);
     if isempty (label)