Mercurial > octave

annotate scripts/miscellaneous/mustBeGreaterThanOrEqual.m @ 29359:7854d5752dd2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: merge stable to default.
author John W. Eaton <jwe@octave.org>
date Wed, 10 Feb 2021 10:10:40 -0500
parents f8e925ded48f 0a5b15007766
children 796f54d4ddbf
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 ##
29358
0a5b15007766 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 28723
diff changeset
3 ## Copyright (C) 2019-2021 The Octave Project Developers
27962
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 {} {} mustBeGreaterThanOrEqual (@var{x}, @var{c})
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 greater than or equal to @var{c}.
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 greater than
27962
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
32 ## or equal to @var{c}, as determined by @code{@var{x} >= @var{c}}.
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
33 ##
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
34 ## @seealso{mustBeGreaterThan, mustBeLessThanOrEqual, ge}
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 mustBeGreaterThanOrEqual (x, c)
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
38
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
39 if (nargin != 2)
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 = (x >= c)(:);
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);
27962
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
50 try
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
51 bad_val = x(bad_idx);
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
52 errmsg = sprintf ("%s must be greater than or equal to %f; found %d elements that were not: values %s", ...
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
53 label, c, numel (bad_idx), mat2str (bad_val));
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
54 catch
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
55 errmsg = sprintf ("%s must be greater than or equal to %f; found %d elements that were not: indexes %s", ...
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
56 label, c, numel (bad_idx), mat2str (bad_idx));
27962
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
57 end_try_catch
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
58 error (errmsg);
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
59 endif
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
60
27962
3b8d21ff0ca6 New validator functions implementation (bug #57627).
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
61 endfunction
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
27968
c9dd91b438fd BISTs for new validator functions (Bug #57627).
Andrew Janke <andrew@apjanke.net>
parents: 27962
diff changeset
64 %!test
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
65 %! mustBeGreaterThanOrEqual (42, 0);
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
66 %! mustBeGreaterThanOrEqual (Inf, 9999);
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
67 %! mustBeGreaterThanOrEqual (42, 42);
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
68 %! mustBeGreaterThanOrEqual (Inf, Inf);
27968
c9dd91b438fd BISTs for new validator functions (Bug #57627).
Andrew Janke <andrew@apjanke.net>
parents: 27962
diff changeset
69
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
70 %!error <Invalid call> mustBeGreaterThanOrEqual ()
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
71 %!error <Invalid call> mustBeGreaterThanOrEqual (1)
28730
f8e925ded48f update expected test output for mustBe* functionsb
John W. Eaton <jwe@octave.org>
parents: 28723
diff changeset
72 %!error <called with too many inputs> mustBeGreaterThanOrEqual (1, 2, 3)
28723
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
73 %!error <must be greater than or equal to 2> mustBeGreaterThanOrEqual (1, 2)
dd9efd873596 maint: Use Octave coding conventions in mustBe* functions.
Rik <rik@octave.org>
parents: 28722
diff changeset
74 %!error <must be greater than or equal to 0> mustBeGreaterThanOrEqual (NaN, 0)