octave: scripts/miscellaneous/mustBeInteger.m annotate

annotate scripts/miscellaneous/mustBeInteger.m @ 28723:dd9efd873596 stable

maint: Use Octave coding conventions in mustBe* functions. * mustBeFinite.m, mustBeGreaterThan.m, mustBeGreaterThanOrEqual.m, mustBeInteger.m, mustBeLessThan.m, mustBeLessThanOrEqual.m, mustBeMember.m, mustBeNegative.m, mustBeNonNan.m, mustBeNonempty.m, mustBeNonnegative.m, mustBeNonpositive.m, mustBeNonsparse.m, mustBeNonzero.m, mustBeNumeric.m, mustBeNumericOrLogical.m, mustBePositive.m, mustBeReal.m: Use parentheses around conditional in if statement. Use space between not operator '!' and argument. Use two newlines after "endfunction" before starting BIST tests. Use semicolons in statements within %!test blocks. Don't use semicolons in %!error tests. Add expected string for %!error BIST tests. Add input validation for number of inputs and BIST tests to check validation.

author	Rik <rik@octave.org>
date	Fri, 11 Sep 2020 20:01:56 -0700
parents	a2177e663979
children	de5f2f9a64ff 0a5b15007766

rev	line source
27962 3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	1 ########################################################################
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	2 ##
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	3 ## Copyright (C) 2019-2020 The Octave Project Developers
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	4 ##
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	6 ## distribution or <https://octave.org/copyright/>.
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	7 ##
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	8 ## This file is part of Octave.
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	9 ##
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	11 ## under the terms of the GNU General Public License as published by
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	13 ## (at your option) any later version.
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	14 ##
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	18 ## GNU General Public License for more details.
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	19 ##
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	20 ## You should have received a copy of the GNU General Public License
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	21 ## along with Octave; see the file COPYING. If not, see
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	22 ## <https://www.gnu.org/licenses/>.
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	23 ##
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	24 ########################################################################
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	25
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	26 ## -- texinfo --
27969 a9a8699a3749 Remove argouts from new validator functions (Bug #57627). Andrew Janke <andrew@apjanke.net> parents: 27968 diff changeset	27 ## @deftypefn {} {} mustBeInteger (@var{x})
27962 3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	28 ##
28722 a2177e663979 doc: Use standard verb phrasing in mustBe* functions and add @seealso links. Rik <rik@octave.org> parents: 27969 diff changeset	29 ## Require that input @var{x} is integer-valued (but not necessarily
27962 3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	30 ## integer-typed).
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	31 ##
28722 a2177e663979 doc: Use standard verb phrasing in mustBe* functions and add @seealso links. Rik <rik@octave.org> parents: 27969 diff changeset	32 ## Raise an error if any element of the input @var{x} is not a finite,
27962 3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	33 ## real, integer-valued numeric value, as determined by various checks.
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	34 ##
28722 a2177e663979 doc: Use standard verb phrasing in mustBe* functions and add @seealso links. Rik <rik@octave.org> parents: 27969 diff changeset	35 ## @seealso{mustBeNumeric}
27962 3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	36 ## @end deftypefn
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	37
27969 a9a8699a3749 Remove argouts from new validator functions (Bug #57627). Andrew Janke <andrew@apjanke.net> parents: 27968 diff changeset	38 function mustBeInteger (x)
28723 dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	39
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	40 if (nargin != 1)
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	41 print_usage ();
27962 3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	42 endif
28723 dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	43
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	44 if (isinteger (x) \|\| islogical (x))
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	45 return;
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	46 endif
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	47
27962 3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	48 but = [];
28723 dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	49 if (! isnumeric (x))
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	50 but = sprintf ("it was non-numeric (found a %s)", class (x));
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	51 elseif (! isreal (x))
27962 3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	52 but = "it was complex";
28723 dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	53 elseif (any (! isfinite (x)))
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	54 but = "there were non-finite values";
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	55 elseif (any (x != fix (x)))
27962 3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	56 but = "it had fractional values in some elements";
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	57 end
28723 dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	58
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	59 if (! isempty (but))
27962 3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	60 label = inputname (1);
28723 dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	61 if (isempty (label))
27962 3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	62 label = "input";
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	63 endif
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	64 error ("%s must be integer-valued; but %s", label, but);
3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	65 endif
28723 dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	66
27962 3b8d21ff0ca6 New validator functions implementation (bug #57627). Andrew Janke <andrew@apjanke.net> parents: diff changeset	67 endfunction
27968 c9dd91b438fd BISTs for new validator functions (Bug #57627). Andrew Janke <andrew@apjanke.net> parents: 27962 diff changeset	68
28723 dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	69
27968 c9dd91b438fd BISTs for new validator functions (Bug #57627). Andrew Janke <andrew@apjanke.net> parents: 27962 diff changeset	70 %!test
28723 dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	71 %! mustBeInteger ([]);
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	72 %! mustBeInteger (42);
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	73 %! mustBeInteger (1:1000);
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	74 %! mustBeInteger (int32 (42));
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	75 %! mustBeInteger (true);
27968 c9dd91b438fd BISTs for new validator functions (Bug #57627). Andrew Janke <andrew@apjanke.net> parents: 27962 diff changeset	76
28723 dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	77 %!error <Invalid call> mustBeInteger ()
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	78 %!error <it was non-numeric> mustBeInteger ("Hello World")
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	79 %!error <it was complex> mustBeInteger ([1, 2i])
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	80 %!error <there were non-finite values> mustBeInteger (Inf)
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	81 %!error <there were non-finite values> mustBeInteger (NaN)
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions. Rik <rik@octave.org> parents: 28722 diff changeset	82 %!error <it had fractional values> mustBeInteger ([1 2 3 4.4])

Mercurial > octave

annotate scripts/miscellaneous/mustBeInteger.m @ 28723:dd9efd873596 stable