annotate scripts/miscellaneous/mustBeFinite.m @ 28891:de5f2f9a64ff

maint: Use same coding style when checking for a minimum of 1 input. * disp.m, __get_properties__.m, disp.m, isplaying.m, pause.m, resume.m, stop.m, __get_properties__.m, disp.m, isrecording.m, pause.m, resume.m, stop.m, mu2lin.m, acosd.m, acot.m, acotd.m, acoth.m, acsc.m, acscd.m, acsch.m, asec.m, asecd.m, asech.m, asind.m, atand.m, cosd.m, cot.m, cotd.m, coth.m, csc.m, cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m, tand.m, cell2mat.m, deg2rad.m, fliplr.m, flipud.m, int2str.m, nextpow2.m, num2str.m, rad2deg.m, subsindex.m, rotx.m, roty.m, rotz.m, voronoin.m, __unimplemented__.m, frame2im.m, hsv2rgb.m, iscolormap.m, __imfinfo__.m, rgb2gray.m, rgb2hsv.m, fileread.m, is_valid_file_id.m, usejava.m, argnames.m, char.m, formula.m, vectorize.m, isdir.m, vectorize.m, condeig.m, duplication_matrix.m, expm.m, isdiag.m, istril.m, istriu.m, normest.m, planerot.m, trace.m, vech.m, fieldnames.m, fileparts.m, grabcode.m, isfile.m, isfolder.m, mustBeFinite.m, mustBeInteger.m, mustBeNegative.m, mustBeNonNan.m, mustBeNonempty.m, mustBeNonnegative.m, mustBeNonpositive.m, mustBeNonsparse.m, mustBeNonzero.m, mustBeNumeric.m, mustBeNumericOrLogical.m, mustBePositive.m, mustBeReal.m, namedargs2cell.m, open.m, run.m, swapbytes.m, pareto.m, allchild.m, colstyle.m, hdl2struct.m, isaxes.m, isfigure.m, ishandle.m, compan.m, poly.m, polyreduce.m, ppjumps.m, roots.m, unmkpp.m, profexplore.m, profile.m, bartlett.m, fftshift.m, hurst.m, ifftshift.m, sinc.m, spencer.m, yulewalker.m, colperm.m, nonzeros.m, spconvert.m, spones.m, sprandsym.m, cosint.m, expint.m, factor.m, factorial.m, isprime.m, perms.m, primes.m, reallog.m, realsqrt.m, sinint.m, gallery.m, hadamard.m, hilb.m, invhilb.m, magic.m, wilkinson.m, center.m, iqr.m, meansq.m, median.m, runlength.m, bin2dec.m, blanks.m, deblank.m, hex2dec.m, isletter.m, isstring.m, str2num.m, strtrim.m, asctime.m, ctime.m: Replace "if (nargin != 1)" formulations with "if (nargin < 1)" to match the rest of Octave.
author Rik <rik@octave.org>
date Sat, 10 Oct 2020 16:32:20 -0700
parents dd9efd873596
children 7854d5752dd2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 {} {} mustBeFinite (@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 finite.
27962
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
30 ##
28722
a2177e663979 doc: Use standard verb phrasing in mustBe* functions and add @seealso links.
Rik <rik@octave.org>
parents: 27969
diff changeset
31 ## Raise an error if any element of the input @var{x} is not finite, as
27962
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
32 ## determined by @code{isfinite (x)}.
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
33 ##
28722
a2177e663979 doc: Use standard verb phrasing in mustBe* functions and add @seealso links.
Rik <rik@octave.org>
parents: 27969
diff changeset
34 ## @seealso{mustBeNonNan, isfinite}
27962
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
35 ## @end deftypefn
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
36
27969
a9a8699a3749 Remove argouts from new validator functions (Bug #57627).
Andrew Janke <andrew@apjanke.net>
parents: 27968
diff changeset
37 function mustBeFinite (x)
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
38
28891
de5f2f9a64ff maint: Use same coding style when checking for a minimum of 1 input.
Rik <rik@octave.org>
parents: 28723
diff changeset
39 if (nargin < 1)
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
40 print_usage ();
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
41 endif
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
42
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
43 tf = isfinite (x(:));
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
44 if (! all (tf))
27962
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
45 label = inputname (1);
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
46 if (isempty (label))
27962
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
47 label = "input";
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
48 endif
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
49 bad_idx = find (! tf);
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
50 error ("%s must be finite; found %d non-finite elements: indexes %s",
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
51 label, numel (bad_idx), mat2str (bad_idx));
27962
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
52 endif
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
53
27962
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
54 endfunction
27968
c9dd91b438fd BISTs for new validator functions (Bug #57627).
Andrew Janke <andrew@apjanke.net>
parents: 27962
diff changeset
55
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
56
27968
c9dd91b438fd BISTs for new validator functions (Bug #57627).
Andrew Janke <andrew@apjanke.net>
parents: 27962
diff changeset
57 %!test
c9dd91b438fd BISTs for new validator functions (Bug #57627).
Andrew Janke <andrew@apjanke.net>
parents: 27962
diff changeset
58 %! mustBeFinite ([]);
c9dd91b438fd BISTs for new validator functions (Bug #57627).
Andrew Janke <andrew@apjanke.net>
parents: 27962
diff changeset
59 %! mustBeFinite (42);
c9dd91b438fd BISTs for new validator functions (Bug #57627).
Andrew Janke <andrew@apjanke.net>
parents: 27962
diff changeset
60 %! mustBeFinite (-100:.1:100);
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
61 %! mustBeFinite (int32 (42));
27968
c9dd91b438fd BISTs for new validator functions (Bug #57627).
Andrew Janke <andrew@apjanke.net>
parents: 27962
diff changeset
62
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
63 %!error <Invalid call> mustBeFinite ()
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
64 %!error <found 1 non-finite> mustBeFinite (Inf)
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
65 %!error <indexes 4> mustBeFinite ([1 2 3 Inf])
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
66 %!error <indexes 1> mustBeFinite ([-Inf -1 0 1])
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
67 %!error <indexes 1> mustBeFinite ([NaN -1])