Mercurial > octave
view scripts/miscellaneous/mustBeInteger.m @ 28240:2fb684dc2ec2
axis.m: Implement "fill" option for Matlab compatibility.
* axis.m: Document that "fill" is a synonym for "normal". Place "vis3d" option
in documentation table for modes which affect aspect ratio. Add
strcmpi (opt, "fill") to decode opt and executed the same behavior as "normal".
author | Rik <rik@octave.org> |
---|---|
date | Fri, 24 Apr 2020 13:16:09 -0700 |
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 {} {} mustBeInteger (@var{x}) ## ## Requires that input @var{x} is integer-valued (but not necessarily ## integer-typed). ## ## Raises an error if any element of the input @var{x} is not a finite, ## real, integer-valued numeric value, as determined by various checks. ## ## @end deftypefn function mustBeInteger (x) if isinteger (x) || islogical (x) return endif but = []; if ! isnumeric (x) but = sprintf ("it was non-numeric (got a %s)", class (x)); elseif any (! isfinite (x)) but = "there were Inf values"; elseif ! isreal (x) but = "it was complex"; elseif ! all (floor (x) == x) but = "it had fractional values in some elements"; end if ! isempty (but) label = inputname (1); if isempty (label) label = "input"; endif error ("%s must be integer-valued; but %s", label, but); endif endfunction %!test %! mustBeInteger ([]) %! mustBeInteger (42) %! mustBeInteger (1:1000) %! mustBeInteger (int32(42)) %!error mustBeInteger () %!error mustBeInteger (1.23) %!error mustBeInteger ([1 2 3 4.4]) %!error mustBeInteger (Inf) %!error mustBeInteger (NaN)