Explicitly casts the input to a logical integer.
CASTLOGICAL(val)
val |
- |
A scalar, series or table. |
A logical integer with a value of 1 or 0.
castlogical(1.9)
returns the logical integer 1.
castlogical(1 + 2i)
returns the logical integer 1.
castlogical(0 + 0i)
returns the logical integer 0.
CASTLOGICAL always returns an integer.
CASTLOGICAL is helpful when writing SPL functions that require an explicit logical integer input and the type of the variable passed into the function may not be an integer.
CASTLOGICAL only converts the first point of a series input.
See LOGICAL to convert a series of values to a logical series.