Mercurial > octave
view scripts/miscellaneous/mustBeNegative.m @ 29358:0a5b15007766 stable
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2021.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 10 Feb 2021 09:52:15 -0500 |
parents | dd9efd873596 |
children | 7854d5752dd2 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2019-2021 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 {} {} mustBeNegative (@var{x}) ## ## Require that input @var{x} is negative. ## ## Raise an error if any element of the input @var{x} is not negative, as ## determined by @code{@var{x} < 0}. ## ## @seealso{mustBeNonnegative} ## @end deftypefn function mustBeNegative (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 negative; found %d elements that were not: values %s", ... label, numel (bad_idx), mat2str (bad_val)); catch errmsg = sprintf ("%s must be negative; found %d elements that were not: indexes %s", ... label, numel (bad_idx), mat2str (bad_idx)); end_try_catch error (errmsg); endif endfunction %!test %! mustBeNegative ([]); %! mustBeNegative (-42); %! mustBeNegative (-10:-2); %!error <Invalid call> mustBeNegative () %!error <found 1 elements> mustBeNegative ([-1, 42]) %!error <found 6 elements> mustBeNegative (-5:5)