1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
|
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Validating the type of Arguments (GNU Octave (version 10.3.0))</title>
<meta name="description" content="Validating the type of Arguments (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Validating the type of Arguments (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Validating-Arguments.html" rel="up" title="Validating Arguments">
<link href="Parsing-Arguments.html" rel="next" title="Parsing Arguments">
<link href="Validating-the-number-of-Arguments.html" rel="prev" title="Validating the number of Arguments">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="subsection-level-extent" id="Validating-the-type-of-Arguments">
<div class="nav-panel">
<p>
Next: <a href="Parsing-Arguments.html" accesskey="n" rel="next">Parsing Arguments</a>, Previous: <a href="Validating-the-number-of-Arguments.html" accesskey="p" rel="prev">Validating the number of Arguments</a>, Up: <a href="Validating-Arguments.html" accesskey="u" rel="up">Validating Arguments</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsection" id="Validating-the-type-of-Arguments-1"><span>11.9.2 Validating the type of Arguments<a class="copiable-link" href="#Validating-the-type-of-Arguments-1"> ¶</a></span></h4>
<p>Besides the number of arguments, inputs can be checked for various
properties. <code class="code">validatestring</code> is used for string arguments and
<code class="code">validateattributes</code> for numeric arguments.
</p>
<a class="anchor" id="XREFvalidatestring"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-validatestring"><span><code class="def-type"><var class="var">validstr</var> =</code> <strong class="def-name">validatestring</strong> <code class="def-code-arguments">(<var class="var">str</var>, <var class="var">strarray</var>)</code><a class="copiable-link" href="#index-validatestring"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-validatestring-1"><span><code class="def-type"><var class="var">validstr</var> =</code> <strong class="def-name">validatestring</strong> <code class="def-code-arguments">(<var class="var">str</var>, <var class="var">strarray</var>, <var class="var">funcname</var>)</code><a class="copiable-link" href="#index-validatestring-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-validatestring-2"><span><code class="def-type"><var class="var">validstr</var> =</code> <strong class="def-name">validatestring</strong> <code class="def-code-arguments">(<var class="var">str</var>, <var class="var">strarray</var>, <var class="var">funcname</var>, <var class="var">varname</var>)</code><a class="copiable-link" href="#index-validatestring-2"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-validatestring-3"><span><code class="def-type"><var class="var">validstr</var> =</code> <strong class="def-name">validatestring</strong> <code class="def-code-arguments">(…, <var class="var">position</var>)</code><a class="copiable-link" href="#index-validatestring-3"> ¶</a></span></dt>
<dd><p>Verify that <var class="var">str</var> is an element, or substring of an element, in
<var class="var">strarray</var>.
</p>
<p>When <var class="var">str</var> is a character string to be tested, and <var class="var">strarray</var> is a
cell array of strings of valid values, then <var class="var">validstr</var> will be the
validated form of <var class="var">str</var> where validation is defined as <var class="var">str</var> being
a member or substring of <var class="var">validstr</var>. This is useful for both verifying
and expanding short options, such as <code class="code">"r"</code>, to their longer forms,
such as <code class="code">"red"</code>. If <var class="var">str</var> is a substring of <var class="var">validstr</var>,
and there are multiple matches, the shortest match will be returned if
all matches are substrings of each other. Otherwise, an error will be
raised because the expansion of <var class="var">str</var> is ambiguous. All comparisons
are case insensitive.
</p>
<p>The additional inputs <var class="var">funcname</var>, <var class="var">varname</var>, and <var class="var">position</var>
are optional and will make any generated validation error message more
specific.
</p>
<p>Examples:
</p>
<div class="example smallexample">
<div class="group"><pre class="example-preformatted">validatestring ("r", {"red", "green", "blue"})
⇒ "red"
validatestring ("b", {"red", "green", "blue", "black"})
⇒ error: validatestring: multiple unique matches were found for 'b':
blue, black
</pre></div></div>
<p><strong class="strong">See also:</strong> <a class="ref" href="Searching-in-Strings.html#XREFstrcmp">strcmp</a>, <a class="ref" href="Searching-in-Strings.html#XREFstrcmpi">strcmpi</a>, <a class="ref" href="#XREFvalidateattributes">validateattributes</a>, <a class="ref" href="Parsing-Arguments.html#XREFinputParser">inputParser</a>.
</p></dd></dl>
<a class="anchor" id="XREFvalidateattributes"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-validateattributes"><span><strong class="def-name">validateattributes</strong> <code class="def-code-arguments">(<var class="var">A</var>, <var class="var">classes</var>, <var class="var">attributes</var>)</code><a class="copiable-link" href="#index-validateattributes"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-validateattributes-1"><span><strong class="def-name">validateattributes</strong> <code class="def-code-arguments">(<var class="var">A</var>, <var class="var">classes</var>, <var class="var">attributes</var>, <var class="var">arg_idx</var>)</code><a class="copiable-link" href="#index-validateattributes-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-validateattributes-2"><span><strong class="def-name">validateattributes</strong> <code class="def-code-arguments">(<var class="var">A</var>, <var class="var">classes</var>, <var class="var">attributes</var>, <var class="var">func_name</var>)</code><a class="copiable-link" href="#index-validateattributes-2"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-validateattributes-3"><span><strong class="def-name">validateattributes</strong> <code class="def-code-arguments">(<var class="var">A</var>, <var class="var">classes</var>, <var class="var">attributes</var>, <var class="var">func_name</var>, <var class="var">arg_name</var>)</code><a class="copiable-link" href="#index-validateattributes-3"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-validateattributes-4"><span><strong class="def-name">validateattributes</strong> <code class="def-code-arguments">(<var class="var">A</var>, <var class="var">classes</var>, <var class="var">attributes</var>, <var class="var">func_name</var>, <var class="var">arg_name</var>, <var class="var">arg_idx</var>)</code><a class="copiable-link" href="#index-validateattributes-4"> ¶</a></span></dt>
<dd><p>Check validity of input argument.
</p>
<p>Confirms that the argument <var class="var">A</var> is valid by belonging to one of
<var class="var">classes</var>, and holding all of the <var class="var">attributes</var>. If it does not,
an error is thrown, with a message formatted accordingly. The error
message can be made further complete by the function name <var class="var">fun_name</var>,
the argument name <var class="var">arg_name</var>, and its position in the input
<var class="var">arg_idx</var>.
</p>
<p><var class="var">classes</var> must be a cell array of strings (an empty cell array is
allowed) with the name of classes (remember that a class name is case
sensitive). In addition to the class name, the following categories
names are also valid:
</p>
<dl class="table">
<dt><code class="code">"float"</code></dt>
<dd><p>Floating point value comprising classes <code class="code">"double"</code> and
<code class="code">"single"</code>.
</p>
</dd>
<dt><code class="code">"integer"</code></dt>
<dd><p>Integer value comprising classes (u)int8, (u)int16, (u)int32, (u)int64.
</p>
</dd>
<dt><code class="code">"numeric"</code></dt>
<dd><p>Numeric value comprising either a floating point or integer value.
</p>
</dd>
</dl>
<p><var class="var">attributes</var> must be a cell array with names of checks for <var class="var">A</var>.
Some of them require an additional value to be supplied right after the
name (see details for each below).
</p>
<dl class="table">
<dt><code class="code">"<="</code></dt>
<dd><p>All values are less than or equal to the following value in
<var class="var">attributes</var>.
</p>
</dd>
<dt><code class="code">"<"</code></dt>
<dd><p>All values are less than the following value in <var class="var">attributes</var>.
</p>
</dd>
<dt><code class="code">">="</code></dt>
<dd><p>All values are greater than or equal to the following value in
<var class="var">attributes</var>.
</p>
</dd>
<dt><code class="code">">"</code></dt>
<dd><p>All values are greater than the following value in <var class="var">attributes</var>.
</p>
</dd>
<dt><code class="code">"2d"</code></dt>
<dd><p>A 2-dimensional matrix. Note that vectors and empty matrices have
2 dimensions, one of them being of length 1, or both length 0.
</p>
</dd>
<dt><code class="code">"3d"</code></dt>
<dd><p>Has no more than 3 dimensions. A 2-dimensional matrix is a 3-D matrix
whose 3rd dimension is of length 1.
</p>
</dd>
<dt><code class="code">"binary"</code></dt>
<dd><p>All values are either 1 or 0.
</p>
</dd>
<dt><code class="code">"column"</code></dt>
<dd><p>Values are arranged in a single column.
</p>
</dd>
<dt><code class="code">"decreasing"</code></dt>
<dd><p>No value is <var class="var">NaN</var>, and each is less than the preceding one.
</p>
</dd>
<dt><code class="code">"diag"</code></dt>
<dd><p>Value is a diagonal matrix.
</p>
</dd>
<dt><code class="code">"even"</code></dt>
<dd><p>All values are even numbers.
</p>
</dd>
<dt><code class="code">"finite"</code></dt>
<dd><p>All values are finite.
</p>
</dd>
<dt><code class="code">"increasing"</code></dt>
<dd><p>No value is <var class="var">NaN</var>, and each is greater than the preceding one.
</p>
</dd>
<dt><code class="code">"integer"</code></dt>
<dd><p>All values are integer. This is different than using <code class="code">isinteger</code>
which only checks its an integer type. This checks that each value in
<var class="var">A</var> is an integer value, i.e., it has no decimal part.
</p>
</dd>
<dt><code class="code">"ncols"</code></dt>
<dd><p>Has exactly as many columns as the next value in <var class="var">attributes</var>.
</p>
</dd>
<dt><code class="code">"ndims"</code></dt>
<dd><p>Has exactly as many dimensions as the next value in <var class="var">attributes</var>.
</p>
</dd>
<dt><code class="code">"nondecreasing"</code></dt>
<dd><p>No value is <var class="var">NaN</var>, and each is greater than or equal to the preceding
one.
</p>
</dd>
<dt><code class="code">"nonempty"</code></dt>
<dd><p>It is not empty.
</p>
</dd>
<dt><code class="code">"nonincreasing"</code></dt>
<dd><p>No value is <var class="var">NaN</var>, and each is less than or equal to the preceding one.
</p>
</dd>
<dt><code class="code">"nonnan"</code></dt>
<dd><p>No value is a <code class="code">NaN</code>.
</p>
</dd>
<dt><code class="code">"nonnegative"</code></dt>
<dd><p>All values are non negative.
</p>
</dd>
<dt><code class="code">"nonsparse"</code></dt>
<dd><p>It is not a sparse matrix.
</p>
</dd>
<dt><code class="code">"nonzero"</code></dt>
<dd><p>No value is zero.
</p>
</dd>
<dt><code class="code">"nrows"</code></dt>
<dd><p>Has exactly as many rows as the next value in <var class="var">attributes</var>.
</p>
</dd>
<dt><code class="code">"numel"</code></dt>
<dd><p>Has exactly as many elements as the next value in <var class="var">attributes</var>.
</p>
</dd>
<dt><code class="code">"odd"</code></dt>
<dd><p>All values are odd numbers.
</p>
</dd>
<dt><code class="code">"positive"</code></dt>
<dd><p>All values are positive.
</p>
</dd>
<dt><code class="code">"real"</code></dt>
<dd><p>It is a non-complex matrix.
</p>
</dd>
<dt><code class="code">"row"</code></dt>
<dd><p>Values are arranged in a single row.
</p>
</dd>
<dt><code class="code">"scalar"</code></dt>
<dd><p>It is a scalar.
</p>
</dd>
<dt><code class="code">"size"</code></dt>
<dd><p>Its size has length equal to the values of the next in <var class="var">attributes</var>.
The next value must is an array with the length for each dimension. To
ignore the check for a certain dimension, the value of <code class="code">NaN</code> can be
used.
</p>
</dd>
<dt><code class="code">"square"</code></dt>
<dd><p>Is a square matrix.
</p>
</dd>
<dt><code class="code">"vector"</code></dt>
<dd><p>Values are arranged in a single vector (column or vector).
</p>
</dd>
</dl>
<p><strong class="strong">See also:</strong> <a class="ref" href="Built_002din-Data-Types.html#XREFisa">isa</a>, <a class="ref" href="#XREFvalidatestring">validatestring</a>, <a class="ref" href="Parsing-Arguments.html#XREFinputParser">inputParser</a>.
</p></dd></dl>
<p>As alternatives to <code class="code">validateattributes</code> there are several shorter
convenience functions to check for individual properties.
</p>
<a class="anchor" id="XREFmustBeFinite"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeFinite"><span><strong class="def-name">mustBeFinite</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-mustBeFinite"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is finite.
</p>
<p>Raise an error if any element of the input <var class="var">x</var> is not finite, as
determined by <code class="code">isfinite (x)</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeNonNan">mustBeNonNan</a>, <a class="ref" href="Finding-Elements-and-Checking-Conditions.html#XREFisfinite">isfinite</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeGreaterThan"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeGreaterThan"><span><strong class="def-name">mustBeGreaterThan</strong> <code class="def-code-arguments">(<var class="var">x</var>, <var class="var">c</var>)</code><a class="copiable-link" href="#index-mustBeGreaterThan"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is greater than <var class="var">c</var>.
</p>
<p>Raise an error if any element of the input <var class="var">x</var> is not greater than
<var class="var">c</var>, as determined by <code class="code"><var class="var">x</var> > <var class="var">c</var></code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeGreaterThanOrEqual">mustBeGreaterThanOrEqual</a>, <a class="ref" href="#XREFmustBeLessThan">mustBeLessThan</a>, <a class="ref" href="Comparison-Ops.html#XREFgt">gt</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeGreaterThanOrEqual"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeGreaterThanOrEqual"><span><strong class="def-name">mustBeGreaterThanOrEqual</strong> <code class="def-code-arguments">(<var class="var">x</var>, <var class="var">c</var>)</code><a class="copiable-link" href="#index-mustBeGreaterThanOrEqual"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is greater than or equal to <var class="var">c</var>.
</p>
<p>Raise an error if any element of the input <var class="var">x</var> is not greater than
or equal to <var class="var">c</var>, as determined by <code class="code"><var class="var">x</var> >= <var class="var">c</var></code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeGreaterThan">mustBeGreaterThan</a>, <a class="ref" href="#XREFmustBeLessThanOrEqual">mustBeLessThanOrEqual</a>, <a class="ref" href="Comparison-Ops.html#XREFge">ge</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeInteger"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeInteger"><span><strong class="def-name">mustBeInteger</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-mustBeInteger"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is integer-valued (but not necessarily
integer-typed).
</p>
<p>Raise an error if any element of the input <var class="var">x</var> is not a finite,
real, integer-valued numeric value, as determined by various checks.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeNumeric">mustBeNumeric</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeLessThan"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeLessThan"><span><strong class="def-name">mustBeLessThan</strong> <code class="def-code-arguments">(<var class="var">x</var>, <var class="var">c</var>)</code><a class="copiable-link" href="#index-mustBeLessThan"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is less than <var class="var">c</var>.
</p>
<p>Raise an error if any element of the input <var class="var">x</var> is not less than
<var class="var">c</var>, as determined by <code class="code"><var class="var">x</var> < <var class="var">c</var></code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeLessThanOrEqual">mustBeLessThanOrEqual</a>, <a class="ref" href="#XREFmustBeGreaterThan">mustBeGreaterThan</a>, <a class="ref" href="Comparison-Ops.html#XREFlt">lt</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeLessThanOrEqual"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeLessThanOrEqual"><span><strong class="def-name">mustBeLessThanOrEqual</strong> <code class="def-code-arguments">(<var class="var">x</var>, <var class="var">c</var>)</code><a class="copiable-link" href="#index-mustBeLessThanOrEqual"> ¶</a></span></dt>
<dd>
<p>Require that input is less than or equal to a given value.
</p>
<p>Raise an error if any element of the input <var class="var">x</var> is not less than
or equal to <var class="var">c</var>, as determined by <code class="code"><var class="var">x</var> <= <var class="var">c</var></code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeLessThan">mustBeLessThan</a>, <a class="ref" href="#XREFmustBeGreaterThanOrEqual">mustBeGreaterThanOrEqual</a>, <a class="ref" href="Comparison-Ops.html#XREFle">le</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeMember"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeMember"><span><strong class="def-name">mustBeMember</strong> <code class="def-code-arguments">(<var class="var">x</var>, <var class="var">valid</var>)</code><a class="copiable-link" href="#index-mustBeMember"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is a member of a set of given valid values.
</p>
<p>Raise an error if any element of the input <var class="var">x</var> is not a member
of the set <var class="var">valid</var>, as determined by <code class="code">ismember (<var class="var">x</var>)</code>.
</p>
<p>Programming Note: char inputs may behave strangely because of the
interaction between chars and cellstrings when calling <code class="code">ismember</code> on
them. But it will probably "do what you mean" if you just use it naturally.
To guarantee operation, convert all char arrays to cellstrings with
<code class="code">cellstr</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeNonempty">mustBeNonempty</a>, <a class="ref" href="Set-Operations.html#XREFismember">ismember</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeNegative"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeNegative"><span><strong class="def-name">mustBeNegative</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-mustBeNegative"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is negative.
</p>
<p>Raise an error if any element of the input <var class="var">x</var> is not negative, as
determined by <code class="code"><var class="var">x</var> < 0</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeNonnegative">mustBeNonnegative</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeNonempty"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeNonempty"><span><strong class="def-name">mustBeNonempty</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-mustBeNonempty"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is nonempty.
</p>
<p>Raise an error if the input <var class="var">x</var> is empty, as determined by
<code class="code">isempty (<var class="var">x</var>)</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeMember">mustBeMember</a>, <a class="ref" href="#XREFmustBeNonzero">mustBeNonzero</a>, <a class="ref" href="Object-Sizes.html#XREFisempty">isempty</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeNonNan"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeNonNan"><span><strong class="def-name">mustBeNonNan</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-mustBeNonNan"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is non-<code class="code">NaN</code>.
</p>
<p>Raise an error if any element of the input <var class="var">x</var> is <code class="code">NaN</code>, as
determined by <code class="code">isnan (<var class="var">x</var>)</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeFinite">mustBeFinite</a>, <a class="ref" href="#XREFmustBeNonempty">mustBeNonempty</a>, <a class="ref" href="Finding-Elements-and-Checking-Conditions.html#XREFisnan">isnan</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeNonnegative"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeNonnegative"><span><strong class="def-name">mustBeNonnegative</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-mustBeNonnegative"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is not negative.
</p>
<p>Raise an error if any element of the input <var class="var">x</var> is negative, as
determined by <code class="code"><var class="var">x</var> >= 0</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeNonzero">mustBeNonzero</a>, <a class="ref" href="#XREFmustBePositive">mustBePositive</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeNonpositive"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeNonpositive"><span><strong class="def-name">mustBeNonpositive</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-mustBeNonpositive"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is not positive.
</p>
<p>Raise an error if any element of the input <var class="var">x</var> is positive, as
determined by <code class="code"><var class="var">x</var> <= 0</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeNegative">mustBeNegative</a>, <a class="ref" href="#XREFmustBeNonzero">mustBeNonzero</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeNonsparse"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeNonsparse"><span><strong class="def-name">mustBeNonsparse</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-mustBeNonsparse"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is not sparse.
</p>
<p>Raise an error if the input <var class="var">x</var> is sparse, as determined by
<code class="code">issparse (<var class="var">x</var>)</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="Information.html#XREFissparse">issparse</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeNonzero"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeNonzero"><span><strong class="def-name">mustBeNonzero</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-mustBeNonzero"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is not zero.
</p>
<p>Raise an error if any element of the input <var class="var">x</var> is zero, as determined
by <code class="code"><var class="var">x</var> == 0</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeNonnegative">mustBeNonnegative</a>, <a class="ref" href="#XREFmustBePositive">mustBePositive</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeNumeric"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeNumeric"><span><strong class="def-name">mustBeNumeric</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-mustBeNumeric"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is numeric.
</p>
<p>Raise an error if the input <var class="var">x</var> is not numeric, as determined by
<code class="code">isnumeric (<var class="var">x</var>)</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeNumericOrLogical">mustBeNumericOrLogical</a>, <a class="ref" href="Predicates-for-Numeric-Objects.html#XREFisnumeric">isnumeric</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeNumericOrLogical"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeNumericOrLogical"><span><strong class="def-name">mustBeNumericOrLogical</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-mustBeNumericOrLogical"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is numeric or logical.
</p>
<p>Raise an error if the input <var class="var">x</var> is not numeric or logical, as
determined by <code class="code">isnumeric (<var class="var">x</var>) || islogical (<var class="var">x</var>)</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeNumeric">mustBeNumeric</a>, <a class="ref" href="Predicates-for-Numeric-Objects.html#XREFisnumeric">isnumeric</a>, <a class="ref" href="Predicates-for-Numeric-Objects.html#XREFislogical">islogical</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBePositive"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBePositive"><span><strong class="def-name">mustBePositive</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-mustBePositive"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is positive.
</p>
<p>Raise an error if any element of the input <var class="var">x</var> is not positive, as
determined by <code class="code"><var class="var">x</var> > 0</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeNonnegative">mustBeNonnegative</a>, <a class="ref" href="#XREFmustBeNonzero">mustBeNonzero</a>.
</p></dd></dl>
<a class="anchor" id="XREFmustBeReal"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mustBeReal"><span><strong class="def-name">mustBeReal</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-mustBeReal"> ¶</a></span></dt>
<dd>
<p>Require that input <var class="var">x</var> is real.
</p>
<p>Raise an error if the input <var class="var">x</var> is not real, as determined by
<code class="code">isreal (<var class="var">x</var>)</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFmustBeFinite">mustBeFinite</a>, <a class="ref" href="#XREFmustBeNonNan">mustBeNonNan</a>, <a class="ref" href="Predicates-for-Numeric-Objects.html#XREFisreal">isreal</a>.
</p></dd></dl>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Parsing-Arguments.html">Parsing Arguments</a>, Previous: <a href="Validating-the-number-of-Arguments.html">Validating the number of Arguments</a>, Up: <a href="Validating-Arguments.html">Validating Arguments</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
