tuple_is_realtuple_is_realTupleIsRealTupleIsRealtuple_is_real (Operator)
Name
tuple_is_realtuple_is_realTupleIsRealTupleIsRealtuple_is_real — Test if the internal representation of a tuple is of type real.
Signature
Herror tuple_is_real(double T, Hlong* IsReal)
Herror T_tuple_is_real(const Htuple T, Htuple* IsReal)
def tuple_is_real(t: HTupleType) -> int
Description
tuple_is_realtuple_is_realTupleIsRealTupleIsRealtuple_is_real tests if the internal representation of the
input tuple TTTtt is of type real. In that case
the value 1 (true) is returned in IsRealIsRealIsRealisRealis_real, otherwise the
value 0 (false) is returned. If a tuple consists of real
elements only, IsRealIsRealIsRealisRealis_real can nevertheless be 0 in case the internal
representation is H_TYPE_MIXED; see tuple_typetuple_typeTupleTypeTupleTypetuple_type for details.
Exception: Empty input tuple
If the input tuple is empty, the operator returns 1.
HDevelop In-line Operation
HDevelop provides an in-line operation for tuple_is_realtuple_is_realTupleIsRealTupleIsRealtuple_is_real,
which can be used in an expression in the following syntax:
IsReal := is_real(T)
Attention
Even if all tuple elements are of type real,
tuple_is_realtuple_is_realTupleIsRealTupleIsRealtuple_is_real returns 0 (false) if the internal representation
of the tuple is of type H_TYPE_MIXED. To test if the elements of the
tuple are of type real the operator tuple_is_real_elemtuple_is_real_elemTupleIsRealElemTupleIsRealElemtuple_is_real_elem
should be used.
Execution Information
- Multithreading type: independent (runs in parallel even with exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
TTTtt (input_control) tuple(-array) → HTupleHTupleTypeHTupleHtuple (real / integer / string / handle) (double / int / long / string / HHandle) (double / Hlong / HString / HHandle) (double / Hlong / char* / handle)
Input tuple.
IsRealIsRealIsRealisRealis_real (output_control) number → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Is the input tuple of type real?
Example (HDevelop)
tuple_is_real ([3.1416,'pi',3], IsRealA)
* IsRealA = false
tuple_is_real ([1.0,2.0,3.0], IsRealB)
* IsRealB = true
tuple_is_real ([], IsRealC)
* IsRealC = true
Result
If the parameters are valid, the operator
tuple_is_realtuple_is_realTupleIsRealTupleIsRealtuple_is_real returns the value 2 (
H_MSG_TRUE)
.
Alternatives
tuple_typetuple_typeTupleTypeTupleTypetuple_type,
tuple_is_numbertuple_is_numberTupleIsNumberTupleIsNumbertuple_is_number,
tuple_is_real_elemtuple_is_real_elemTupleIsRealElemTupleIsRealElemtuple_is_real_elem
See also
tuple_is_inttuple_is_intTupleIsIntTupleIsInttuple_is_int,
tuple_is_stringtuple_is_stringTupleIsStringTupleIsStringtuple_is_string,
tuple_is_handletuple_is_handleTupleIsHandleTupleIsHandletuple_is_handle
Module
Foundation