Mercurial > octave
view scripts/miscellaneous/mustBeNegative.m @ 28199:7ac8b3188b27
maint: merge stable to default.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 08 Apr 2020 16:03:51 -0400 |
parents | a9a8699a3749 |
children | a2177e663979 |
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 {} {} mustBeNegative (@var{x}) ## ## Requires that input @var{x} is negative. ## ## Raises an error if any element of the input @var{x} is not negative, as ## determined by @code{@var{x} < 0}. ## ## @end deftypefn function mustBeNegative (x) tf = x < 0; tf = tf(:); if ! all (tf) label = inputname (1); if isempty (label) label = "input"; endif ix_bad = find (! tf); try bad = x(ix_bad); errmsg = sprintf ( ... "%s must be negative; got %d elements that were not: values %s", ... label, numel (ix_bad), mat2str (bad)); catch err errmsg = sprintf ( ... "%s must be negative; got %d elements that were not: indexes %s", ... label, numel (ix_bad), mat2str (ix_bad)); end_try_catch error (errmsg); endif endfunction %!test %! mustBeNegative (-42) %! mustBeNegative ([]) %! mustBeNegative (-10:-2) %!error mustBeNegative () %!error mustBeNegative (42) %!error mustBeNegative (-5:5)