|
6778
|
1 @c Copyright (C) 1996, 1997, 2007 John W. Eaton |
|
3294
|
2 @c This is part of the Octave manual. |
|
|
3 @c For copying conditions, see the file gpl.texi. |
|
|
4 |
|
4167
|
5 @node Numeric Data Types |
|
3294
|
6 @chapter Numeric Data Types |
|
|
7 @cindex numeric constant |
|
|
8 @cindex numeric value |
|
|
9 |
|
|
10 A @dfn{numeric constant} may be a scalar, a vector, or a matrix, and it |
|
|
11 may contain complex values. |
|
|
12 |
|
|
13 The simplest form of a numeric constant, a scalar, is a single number |
|
|
14 that can be an integer, a decimal fraction, a number in scientific |
|
6620
|
15 (exponential) notation, or a complex number. Note that by default numeric |
|
3294
|
16 constants are represented within Octave in double-precision floating |
|
|
17 point format (complex constants are stored as pairs of double-precision |
|
6620
|
18 floating point values). It is however possible to represent real |
|
|
19 integers as described in @ref{Integer Data Types}. Here are some examples |
|
|
20 of real-valued numeric constants, which all have the same value: |
|
3294
|
21 |
|
|
22 @example |
|
|
23 @group |
|
|
24 105 |
|
|
25 1.05e+2 |
|
|
26 1050e-1 |
|
|
27 @end group |
|
|
28 @end example |
|
|
29 |
|
|
30 To specify complex constants, you can write an expression of the form |
|
|
31 |
|
|
32 @example |
|
|
33 @group |
|
|
34 3 + 4i |
|
|
35 3.0 + 4.0i |
|
|
36 0.3e1 + 40e-1i |
|
|
37 @end group |
|
|
38 @end example |
|
|
39 |
|
6620
|
40 @noindent |
|
3294
|
41 all of which are equivalent. The letter @samp{i} in the previous example |
|
|
42 stands for the pure imaginary constant, defined as |
|
|
43 @iftex |
|
|
44 @tex |
|
|
45 $\sqrt{-1}$. |
|
|
46 @end tex |
|
|
47 @end iftex |
|
6620
|
48 @ifnottex |
|
3294
|
49 @code{sqrt (-1)}. |
|
6620
|
50 @end ifnottex |
|
3294
|
51 |
|
|
52 For Octave to recognize a value as the imaginary part of a complex |
|
|
53 constant, a space must not appear between the number and the @samp{i}. |
|
|
54 If it does, Octave will print an error message, like this: |
|
|
55 |
|
|
56 @example |
|
|
57 @group |
|
|
58 octave:13> 3 + 4 i |
|
|
59 |
|
|
60 parse error: |
|
|
61 |
|
|
62 3 + 4 i |
|
|
63 ^ |
|
|
64 @end group |
|
|
65 @end example |
|
|
66 |
|
6620
|
67 @noindent |
|
3294
|
68 You may also use @samp{j}, @samp{I}, or @samp{J} in place of the |
|
|
69 @samp{i} above. All four forms are equivalent. |
|
|
70 |
|
6549
|
71 @DOCSTRING(double) |
|
|
72 |
|
|
73 @DOCSTRING(single) |
|
|
74 |
|
|
75 @DOCSTRING(complex) |
|
|
76 |
|
3294
|
77 @menu |
|
|
78 * Matrices:: |
|
|
79 * Ranges:: |
|
6549
|
80 * Integer Data Types:: |
|
6781
|
81 * Bit Manipulations:: |
|
3428
|
82 * Logical Values:: |
|
3294
|
83 * Predicates for Numeric Objects:: |
|
|
84 @end menu |
|
|
85 |
|
4167
|
86 @node Matrices |
|
3294
|
87 @section Matrices |
|
|
88 @cindex matrices |
|
|
89 |
|
|
90 @opindex [ |
|
|
91 @opindex ] |
|
|
92 @opindex ; |
|
|
93 @opindex , |
|
|
94 |
|
|
95 It is easy to define a matrix of values in Octave. The size of the |
|
|
96 matrix is determined automatically, so it is not necessary to explicitly |
|
|
97 state the dimensions. The expression |
|
|
98 |
|
|
99 @example |
|
|
100 a = [1, 2; 3, 4] |
|
|
101 @end example |
|
|
102 |
|
|
103 @noindent |
|
|
104 results in the matrix |
|
|
105 @iftex |
|
|
106 @tex |
|
|
107 $$ a = \left[ \matrix{ 1 & 2 \cr 3 & 4 } \right] $$ |
|
|
108 @end tex |
|
|
109 @end iftex |
|
6620
|
110 @ifnottex |
|
3294
|
111 |
|
|
112 @example |
|
|
113 @group |
|
|
114 |
|
|
115 / \ |
|
|
116 | 1 2 | |
|
|
117 a = | | |
|
|
118 | 3 4 | |
|
|
119 \ / |
|
|
120 |
|
|
121 @end group |
|
|
122 @end example |
|
6620
|
123 @end ifnottex |
|
3294
|
124 |
|
|
125 Elements of a matrix may be arbitrary expressions, provided that the |
|
|
126 dimensions all make sense when combining the various pieces. For |
|
|
127 example, given the above matrix, the expression |
|
|
128 |
|
|
129 @example |
|
|
130 [ a, a ] |
|
|
131 @end example |
|
|
132 |
|
|
133 @noindent |
|
|
134 produces the matrix |
|
|
135 |
|
|
136 @example |
|
|
137 @group |
|
|
138 ans = |
|
|
139 |
|
|
140 1 2 1 2 |
|
|
141 3 4 3 4 |
|
|
142 @end group |
|
|
143 @end example |
|
|
144 |
|
|
145 @noindent |
|
|
146 but the expression |
|
|
147 |
|
|
148 @example |
|
|
149 [ a, 1 ] |
|
|
150 @end example |
|
|
151 |
|
|
152 @noindent |
|
|
153 produces the error |
|
|
154 |
|
|
155 @example |
|
|
156 error: number of rows must match near line 13, column 6 |
|
|
157 @end example |
|
|
158 |
|
|
159 @noindent |
|
|
160 (assuming that this expression was entered as the first thing on line |
|
|
161 13, of course). |
|
|
162 |
|
|
163 Inside the square brackets that delimit a matrix expression, Octave |
|
|
164 looks at the surrounding context to determine whether spaces and newline |
|
|
165 characters should be converted into element and row separators, or |
|
4476
|
166 simply ignored, so an expression like |
|
3294
|
167 |
|
|
168 @example |
|
|
169 @group |
|
|
170 a = [ 1 2 |
|
|
171 3 4 ] |
|
|
172 @end group |
|
|
173 @end example |
|
|
174 |
|
|
175 @noindent |
|
|
176 will work. However, some possible sources of confusion remain. For |
|
|
177 example, in the expression |
|
|
178 |
|
|
179 @example |
|
|
180 [ 1 - 1 ] |
|
|
181 @end example |
|
|
182 |
|
|
183 @noindent |
|
|
184 the @samp{-} is treated as a binary operator and the result is the |
|
|
185 scalar 0, but in the expression |
|
|
186 |
|
|
187 @example |
|
|
188 [ 1 -1 ] |
|
|
189 @end example |
|
|
190 |
|
|
191 @noindent |
|
|
192 the @samp{-} is treated as a unary operator and the result is the |
|
4476
|
193 vector @code{[ 1, -1 ]}. Similarly, the expression |
|
|
194 |
|
|
195 @example |
|
|
196 [ sin (pi) ] |
|
|
197 @end example |
|
|
198 |
|
|
199 @noindent |
|
|
200 will be parsed as |
|
|
201 |
|
|
202 @example |
|
|
203 [ sin, (pi) ] |
|
|
204 @end example |
|
3294
|
205 |
|
4476
|
206 @noindent |
|
|
207 and will result in an error since the @code{sin} function will be |
|
|
208 called with no arguments. To get around this, you must omit the space |
|
|
209 between @code{sin} and the opening parenthesis, or enclose the |
|
|
210 expression in a set of parentheses: |
|
|
211 |
|
|
212 @example |
|
|
213 [ (sin (pi)) ] |
|
|
214 @end example |
|
|
215 |
|
|
216 Whitespace surrounding the single quote character (@samp{'}, used as a |
|
|
217 transpose operator and for delimiting character strings) can also cause |
|
|
218 confusion. Given @code{a = 1}, the expression |
|
3294
|
219 |
|
|
220 @example |
|
|
221 [ 1 a' ] |
|
|
222 @end example |
|
|
223 |
|
|
224 @noindent |
|
4476
|
225 results in the single quote character being treated as a |
|
3294
|
226 transpose operator and the result is the vector @code{[ 1, 1 ]}, but the |
|
|
227 expression |
|
|
228 |
|
|
229 @example |
|
|
230 [ 1 a ' ] |
|
|
231 @end example |
|
|
232 |
|
|
233 @noindent |
|
|
234 produces the error message |
|
|
235 |
|
|
236 @example |
|
|
237 error: unterminated string constant |
|
|
238 @end example |
|
|
239 |
|
|
240 @noindent |
|
6620
|
241 because not doing so would cause trouble when parsing the valid expression |
|
3294
|
242 |
|
|
243 @example |
|
|
244 [ a 'foo' ] |
|
|
245 @end example |
|
|
246 |
|
|
247 For clarity, it is probably best to always use commas and semicolons to |
|
4476
|
248 separate matrix elements and rows. |
|
3294
|
249 |
|
|
250 When you type a matrix or the name of a variable whose value is a |
|
|
251 matrix, Octave responds by printing the matrix in with neatly aligned |
|
|
252 rows and columns. If the rows of the matrix are too large to fit on the |
|
|
253 screen, Octave splits the matrix and displays a header before each |
|
|
254 section to indicate which columns are being displayed. You can use the |
|
|
255 following variables to control the format of the output. |
|
|
256 |
|
3321
|
257 @DOCSTRING(output_max_field_width) |
|
3294
|
258 |
|
3321
|
259 @DOCSTRING(output_precision) |
|
3294
|
260 |
|
|
261 It is possible to achieve a wide range of output styles by using |
|
|
262 different values of @code{output_precision} and |
|
|
263 @code{output_max_field_width}. Reasonable combinations can be set using |
|
|
264 the @code{format} function. @xref{Basic Input and Output}. |
|
|
265 |
|
3321
|
266 @DOCSTRING(split_long_rows) |
|
3294
|
267 |
|
|
268 Octave automatically switches to scientific notation when values become |
|
|
269 very large or very small. This guarantees that you will see several |
|
|
270 significant figures for every value in a matrix. If you would prefer to |
|
|
271 see all values in a matrix printed in a fixed point format, you can set |
|
|
272 the built-in variable @code{fixed_point_format} to a nonzero value. But |
|
|
273 doing so is not recommended, because it can produce output that can |
|
|
274 easily be misinterpreted. |
|
|
275 |
|
3321
|
276 @DOCSTRING(fixed_point_format) |
|
3294
|
277 |
|
|
278 @menu |
|
|
279 * Empty Matrices:: |
|
|
280 @end menu |
|
|
281 |
|
4167
|
282 @node Empty Matrices |
|
3294
|
283 @subsection Empty Matrices |
|
|
284 |
|
|
285 A matrix may have one or both dimensions zero, and operations on empty |
|
|
286 matrices are handled as described by Carl de Boor in @cite{An Empty |
|
|
287 Exercise}, SIGNUM, Volume 25, pages 2--6, 1990 and C. N. Nett and W. M. |
|
|
288 Haddad, in @cite{A System-Theoretic Appropriate Realization of the Empty |
|
|
289 Matrix Concept}, IEEE Transactions on Automatic Control, Volume 38, |
|
|
290 Number 5, May 1993. |
|
|
291 @iftex |
|
|
292 @tex |
|
|
293 Briefly, given a scalar $s$, an $m\times n$ matrix $M_{m\times n}$, |
|
|
294 and an $m\times n$ empty matrix $[\,]_{m\times n}$ (with either one or |
|
|
295 both dimensions equal to zero), the following are true: |
|
|
296 $$ |
|
|
297 \eqalign{% |
|
|
298 s \cdot [\,]_{m\times n} = [\,]_{m\times n} \cdot s &= [\,]_{m\times n}\cr |
|
|
299 [\,]_{m\times n} + [\,]_{m\times n} &= [\,]_{m\times n}\cr |
|
|
300 [\,]_{0\times m} \cdot M_{m\times n} &= [\,]_{0\times n}\cr |
|
|
301 M_{m\times n} \cdot [\,]_{n\times 0} &= [\,]_{m\times 0}\cr |
|
|
302 [\,]_{m\times 0} \cdot [\,]_{0\times n} &= 0_{m\times n}} |
|
|
303 $$ |
|
|
304 @end tex |
|
|
305 @end iftex |
|
6620
|
306 @ifnottex |
|
3294
|
307 Briefly, given a scalar @var{s}, an @var{m} by |
|
|
308 @var{n} matrix @code{M(mxn)}, and an @var{m} by @var{n} empty matrix |
|
|
309 @code{[](mxn)} (with either one or both dimensions equal to zero), the |
|
|
310 following are true: |
|
|
311 |
|
|
312 @example |
|
|
313 @group |
|
|
314 s * [](mxn) = [](mxn) * s = [](mxn) |
|
|
315 |
|
|
316 [](mxn) + [](mxn) = [](mxn) |
|
|
317 |
|
|
318 [](0xm) * M(mxn) = [](0xn) |
|
|
319 |
|
|
320 M(mxn) * [](nx0) = [](mx0) |
|
|
321 |
|
|
322 [](mx0) * [](0xn) = 0(mxn) |
|
|
323 @end group |
|
|
324 @end example |
|
6620
|
325 @end ifnottex |
|
3294
|
326 |
|
|
327 By default, dimensions of the empty matrix are printed along with the |
|
|
328 empty matrix symbol, @samp{[]}. The built-in variable |
|
|
329 @code{print_empty_dimensions} controls this behavior. |
|
|
330 |
|
3321
|
331 @DOCSTRING(print_empty_dimensions) |
|
3294
|
332 |
|
|
333 Empty matrices may also be used in assignment statements as a convenient |
|
|
334 way to delete rows or columns of matrices. |
|
|
335 @xref{Assignment Ops, ,Assignment Expressions}. |
|
|
336 |
|
|
337 When Octave parses a matrix expression, it examines the elements of the |
|
|
338 list to determine whether they are all constants. If they are, it |
|
|
339 replaces the list with a single matrix constant. |
|
|
340 |
|
4167
|
341 @node Ranges |
|
3294
|
342 @section Ranges |
|
|
343 @cindex range expressions |
|
|
344 @cindex expression, range |
|
|
345 |
|
3920
|
346 @opindex colon |
|
3294
|
347 |
|
|
348 A @dfn{range} is a convenient way to write a row vector with evenly |
|
|
349 spaced elements. A range expression is defined by the value of the first |
|
|
350 element in the range, an optional value for the increment between |
|
|
351 elements, and a maximum value which the elements of the range will not |
|
|
352 exceed. The base, increment, and limit are separated by colons (the |
|
|
353 @samp{:} character) and may contain any arithmetic expressions and |
|
|
354 function calls. If the increment is omitted, it is assumed to be 1. |
|
|
355 For example, the range |
|
|
356 |
|
|
357 @example |
|
|
358 1 : 5 |
|
|
359 @end example |
|
|
360 |
|
|
361 @noindent |
|
|
362 defines the set of values @samp{[ 1, 2, 3, 4, 5 ]}, and the range |
|
|
363 |
|
|
364 @example |
|
|
365 1 : 3 : 5 |
|
|
366 @end example |
|
|
367 |
|
|
368 @noindent |
|
|
369 defines the set of values @samp{[ 1, 4 ]}. |
|
|
370 |
|
|
371 Although a range constant specifies a row vector, Octave does @emph{not} |
|
|
372 convert range constants to vectors unless it is necessary to do so. |
|
|
373 This allows you to write a constant like @samp{1 : 10000} without using |
|
|
374 80,000 bytes of storage on a typical 32-bit workstation. |
|
|
375 |
|
|
376 Note that the upper (or lower, if the increment is negative) bound on |
|
|
377 the range is not always included in the set of values, and that ranges |
|
|
378 defined by floating point values can produce surprising results because |
|
|
379 Octave uses floating point arithmetic to compute the values in the |
|
|
380 range. If it is important to include the endpoints of a range and the |
|
|
381 number of elements is known, you should use the @code{linspace} function |
|
|
382 instead (@pxref{Special Utility Matrices}). |
|
|
383 |
|
|
384 When Octave parses a range expression, it examines the elements of the |
|
|
385 expression to determine whether they are all constants. If they are, it |
|
|
386 replaces the range expression with a single range constant. |
|
|
387 |
|
6549
|
388 @node Integer Data Types |
|
|
389 @section Integer Data Types |
|
|
390 |
|
6620
|
391 Octave supports integer matrices as an alternative to using double |
|
|
392 precision. It is possible to use both signed and unsigned integers |
|
|
393 represented by 8, 16, 32, or 64 bits. It should be noted that most |
|
|
394 computations require floating point data, meaning that integers will |
|
|
395 often change type when involved in numeric computations. For this |
|
|
396 reason integers are most often used to store data, and not for |
|
|
397 calculations. |
|
|
398 |
|
|
399 In general most integer matrices are created by casting |
|
|
400 existing matrices to integers. The following example shows how to cast |
|
|
401 a matrix into 32 bit integers. |
|
|
402 |
|
|
403 @example |
|
|
404 float = rand (2, 2) |
|
|
405 @result{} float = 0.37569 0.92982 |
|
|
406 0.11962 0.50876 |
|
|
407 integer = int32 (float) |
|
|
408 @result{} integer = 0 1 |
|
|
409 0 1 |
|
|
410 @end example |
|
|
411 |
|
|
412 @noindent |
|
|
413 As can be seen, floating point values are rounded to the nearest integer |
|
|
414 when converted. |
|
|
415 |
|
6549
|
416 @DOCSTRING(isinteger) |
|
|
417 |
|
|
418 @DOCSTRING(int8) |
|
|
419 |
|
|
420 @DOCSTRING(uint8) |
|
|
421 |
|
|
422 @DOCSTRING(int16) |
|
|
423 |
|
|
424 @DOCSTRING(uint16) |
|
|
425 |
|
|
426 @DOCSTRING(int32) |
|
|
427 |
|
|
428 @DOCSTRING(uint32) |
|
|
429 |
|
|
430 @DOCSTRING(int64) |
|
|
431 |
|
|
432 @DOCSTRING(uint64) |
|
|
433 |
|
|
434 @DOCSTRING(intmax) |
|
|
435 |
|
|
436 @DOCSTRING(intmin) |
|
|
437 |
|
6624
|
438 @menu |
|
|
439 * Integer Arithmetic:: |
|
|
440 @end menu |
|
|
441 |
|
6620
|
442 @node Integer Arithmetic |
|
|
443 @subsection Integer Arithmetic |
|
|
444 |
|
|
445 While many numerical computations can't be carried out in integers, |
|
|
446 Octave does support basic operations like addition and multiplication |
|
|
447 on integers. The operators @code{+}, @code{-}, @code{.*}, and @code{./} |
|
|
448 works on integers of the same type. So, it is possible to add two 32 bit |
|
|
449 integers, but not to add a 32 bit integer and a 16 bit integer. |
|
|
450 |
|
6715
|
451 The arithmetic operations on integers are performed by casting the |
|
|
452 integer values to double precision values, performing the operation, and |
|
|
453 then re-casting the values back to the original integer type. As the |
|
|
454 double precision type of Octave is only capable of representing integers |
|
|
455 with up to 53 bits of precision, it is not possible to perform |
|
|
456 arithmetic of the 64 bit integer types. |
|
|
457 |
|
6620
|
458 When doing integer arithmetic one should consider the possibility of |
|
|
459 underflow and overflow. This happens when the result of the computation |
|
|
460 can't be represented using the chosen integer type. As an example it is |
|
|
461 not possible to represent the result of @math{10 - 20} when using |
|
|
462 unsigned integers. Octave makes sure that the result of integer |
|
|
463 computations is the integer that is closest to the true result. So, the |
|
|
464 result of @math{10 - 20} when using unsigned integers is zero. |
|
|
465 |
|
|
466 When doing integer division Octave will round the result to the nearest |
|
|
467 integer. This is different from most programming languages, where the |
|
|
468 result is often floored to the nearest integer. So, the result of |
|
|
469 @code{int32(5)./int32(8)} is @code{1}. |
|
|
470 |
|
6781
|
471 @node Bit Manipulations |
|
|
472 @section Bit Manipulations |
|
|
473 |
|
|
474 Octave provides a number of functions for the manipulation of numeric |
|
|
475 values on a bit by bit basis. The basic functions to set and obtain the |
|
|
476 values of individual bits are @code{bitset} and @code{bitget}. |
|
|
477 |
|
|
478 @DOCSTRING(bitset) |
|
|
479 |
|
|
480 @DOCSTRING(bitget) |
|
|
481 |
|
|
482 The arguments to all of Octave's bitwise operations can be scalar or |
|
|
483 arrays, except for @code{bitcmp}, whose @var{k} argument must a |
|
|
484 scalar. In the case where more than one argument is an array, then all |
|
|
485 arguments must have the same shape, and the bitwise operator is applied |
|
|
486 to each of the elements of the argument individually. If at least one |
|
|
487 argument is a scalar and one an array, then the scalar argument is |
|
|
488 duplicated. Therefore |
|
|
489 |
|
|
490 @example |
|
|
491 bitget (100, 8:-1:1) |
|
|
492 @end example |
|
|
493 |
|
|
494 is the same as |
|
|
495 |
|
|
496 @example |
|
|
497 bitget (100 * ones (1, 8), 8:-1:1) |
|
|
498 @end example |
|
|
499 |
|
|
500 It should be noted that all values passed to the bit manipulation |
|
|
501 functions of Octave are treated as integers. Therefore, even though the |
|
|
502 example for @code{bitset} above passes the floating point value |
|
|
503 @code{10}, it is treated as the bits @code{[1, 0, 1, 0]} rather than the |
|
|
504 bits of the native floating point format representation of @code{10}. |
|
|
505 |
|
|
506 As the maximum number that can be represented by a number is important |
|
|
507 for bit manipulation, particularly when forming masks, Octave supplies |
|
|
508 the function @code{bitmax}. |
|
|
509 |
|
|
510 @DOCSTRING(bitmax) |
|
|
511 |
|
|
512 This is the double precision version of the functions @code{intmax}, |
|
|
513 previously discussed. |
|
|
514 |
|
|
515 Octave also include the basic bitwise 'and', 'or' and 'exclusive or' |
|
|
516 operators. |
|
|
517 |
|
|
518 @DOCSTRING(bitand) |
|
|
519 |
|
|
520 @DOCSTRING(bitor) |
|
|
521 |
|
|
522 @DOCSTRING(bitxor) |
|
|
523 |
|
|
524 The bitwise 'not' operator is unary operator that performs a logial |
|
|
525 negation of each of the bits of the value. For this to make sense, the |
|
|
526 mask against which the value is negated must be defined. Octave's |
|
|
527 bitwise 'not' operator is @code{bitcmp}. |
|
|
528 |
|
|
529 @DOCSTRING(bitcmp) |
|
|
530 |
|
|
531 Octave also includes the ability to left and right values bitwise. |
|
|
532 |
|
|
533 @DOCSTRING(bitshift) |
|
|
534 |
|
|
535 Bits that are shifted out of either end of the value are lost. Octave |
|
|
536 also uses arithmetic shifts, where the sign bit of the value is keep |
|
|
537 during a right shift. For example |
|
|
538 |
|
|
539 @example |
|
|
540 @group |
|
|
541 bitshift (-10, -1) |
|
|
542 @result{} -5 |
|
|
543 bitshift (int8 (-1), -1) |
|
|
544 @result{} -1 |
|
|
545 @end group |
|
|
546 @end example |
|
|
547 |
|
|
548 Note that @code{bitshift (int8 (-1), -1)} is @code{-1} since the bit |
|
|
549 representation of @code{-1} in the @code{int8} data type is @code{[1, 1, |
|
|
550 1, 1, 1, 1, 1, 1]}. |
|
|
551 |
|
4167
|
552 @node Logical Values |
|
3428
|
553 @section Logical Values |
|
|
554 |
|
6620
|
555 Octave has built-in support for logical values, i.e. variables that |
|
|
556 are either @code{true} or @code{false}. When comparing two variables, |
|
|
557 the result will be a logical value whose value depends on whether or |
|
|
558 not the comparison is true. |
|
|
559 |
|
|
560 The basic logical operations are @code{&}, @code{|}, and @code{!}, |
|
|
561 that corresponds to ``Logical And'', ``Logical Or'', and ``Logical |
|
|
562 Negation''. These operations all follow the rules of logic. |
|
|
563 |
|
|
564 It is also possible to use logical values as part of standard numerical |
|
|
565 calculations. In this case @code{true} is converted to @code{1}, and |
|
|
566 @code{false} to 0, both represented using double precision floating |
|
|
567 point numbers. So, the result of @code{true*22 - false/6} is @code{22}. |
|
|
568 |
|
|
569 Logical values can also be used to index matrices and cell arrays. |
|
|
570 When indexing with a logical array the result will be a vector containing |
|
|
571 the values corresponding to @code{true} parts of the logical array. |
|
|
572 The following example illustrates this. |
|
|
573 |
|
|
574 @example |
|
|
575 data = [ 1, 2; 3, 4 ]; |
|
|
576 idx = (data <= 2); |
|
|
577 data(idx) |
|
|
578 @result{} ans = [ 1; 4 ] |
|
|
579 @end example |
|
|
580 |
|
|
581 @noindent |
|
|
582 Instead of creating the @code{idx} array it is possible to replace |
|
|
583 @code{data(idx)} with @code{data( data <= 2 )} in the above code. |
|
|
584 |
|
|
585 Besides when doing comparisons, logical values can be constructed by |
|
|
586 casting numeric objects to logical values, or by using the @code{true} |
|
|
587 or @code{false} functions. |
|
|
588 |
|
6549
|
589 @DOCSTRING(logical) |
|
|
590 |
|
3428
|
591 @DOCSTRING(true) |
|
|
592 |
|
|
593 @DOCSTRING(false) |
|
|
594 |
|
4167
|
595 @node Predicates for Numeric Objects |
|
3294
|
596 @section Predicates for Numeric Objects |
|
|
597 |
|
6620
|
598 Since the type of a variable may change during the execution of a |
|
|
599 program, it can be necessary to type checking at run-time. Doing this |
|
|
600 also allows you to change the behaviour of a function depending on the |
|
|
601 type of the input. As an example, this naive implementation of @code{abs} |
|
|
602 return the absolute value of the input if it is a real number, and the |
|
|
603 length of the input if it is a complex number. |
|
|
604 |
|
|
605 @example |
|
|
606 function a = abs (x) |
|
|
607 if (isreal (x)) |
|
|
608 a = sign (x) .* x; |
|
|
609 elseif (iscomplex (x)) |
|
|
610 a = sqrt (real(x).^2 + imag(x).^2); |
|
|
611 endif |
|
|
612 endfunction |
|
|
613 @end example |
|
|
614 |
|
|
615 The following functions are available for determining the type of a |
|
|
616 variable. |
|
|
617 |
|
3428
|
618 @DOCSTRING(isnumeric) |
|
|
619 |
|
|
620 @DOCSTRING(isreal) |
|
|
621 |
|
4029
|
622 @DOCSTRING(iscomplex) |
|
3428
|
623 |
|
4029
|
624 @DOCSTRING(ismatrix) |
|
3294
|
625 |
|
4029
|
626 @DOCSTRING(isvector) |
|
3294
|
627 |
|
4029
|
628 @DOCSTRING(isscalar) |
|
3294
|
629 |
|
4029
|
630 @DOCSTRING(issquare) |
|
3294
|
631 |
|
4029
|
632 @DOCSTRING(issymmetric) |
|
3428
|
633 |
|
6550
|
634 @DOCSTRING(isdefinite) |
|
|
635 |
|
6688
|
636 @DOCSTRING(islogical) |
|
6550
|
637 |
|
|
638 @DOCSTRING(isprime) |
