Mercurial > octave
view scripts/miscellaneous/mustBeNonnegative.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 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2019-2020 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} mustBeNonnegative (@var{x}) ## ## Require that input @var{x} is not negative. ## ## Raise an error if any element of the input @var{x} is negative, as ## determined by @code{@var{x} >= 0}. ## ## @seealso{mustBeNonzero, mustBePositive} ## @end deftypefn function mustBeNonnegative (x) if (nargin != 1) print_usage (); endif tf = (x(:) >= 0); if (! all (tf)) label = inputname (1); if (isempty (label)) label = "input"; endif bad_idx = find (! tf); try bad_val = x(bad_idx); errmsg = sprintf ("%s must be non-negative; found %d elements that were not: values %s", ... label, numel (bad_idx), mat2str (bad_val)); catch errmsg = sprintf ("%s must be non-negative; found %d elements that were not: indexes %s", ... label, numel (bad_idx), mat2str (bad_idx)); end_try_catch error (errmsg); endif endfunction %!test %! mustBeNonnegative (0); %! mustBeNonnegative (1); %! mustBeNonnegative (123.456); %! mustBeNonnegative (Inf); %! mustBeNonnegative (0:10); %! mustBeNonnegative (eps); %!error <Invalid call> mustBeNonnegative () %!error <input must be non-negative> mustBeNonnegative (-1) %!error <found 1 elements> mustBeNonnegative ([0 1 2 3 -4]) %!error <input must be non-negative> mustBeNonnegative (-Inf) %!error <must be non-negative> mustBeNonnegative (NaN)