tuple_is_realtuple_is_realTupleIsRealTupleIsReal (Operator)

Name

tuple_is_realtuple_is_realTupleIsRealTupleIsReal — Test if the internal representation of a tuple is of type real.

Signature

tuple_is_real( : : T : IsReal)

Description

tuple_is_realtuple_is_realTupleIsRealTupleIsRealTupleIsReal tests if the internal representation of the input tuple TTTTt is of type real. In that case the value 1 (true) is returned in IsRealIsRealIsRealIsRealisReal, otherwise the value 0 (false) is returned. If a tuple consists of real elements only, IsRealIsRealIsRealIsRealisReal can nevertheless be 0 in case the internal representation is H_TYPE_MIXED; see tuple_typetuple_typeTupleTypeTupleTypeTupleType 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_realTupleIsRealTupleIsRealTupleIsReal, 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_realTupleIsRealTupleIsRealTupleIsReal 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_elemTupleIsRealElemTupleIsRealElemTupleIsRealElem 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) → (real / integer / string / handle)

Input tuple.

IsRealIsRealIsRealIsRealisReal (output_control) number → (integer)

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_realTupleIsRealTupleIsRealTupleIsReal returns the value 2 (H_MSG_TRUE).

Alternatives

tuple_typetuple_typeTupleTypeTupleTypeTupleType, tuple_is_numbertuple_is_numberTupleIsNumberTupleIsNumberTupleIsNumber, tuple_is_real_elemtuple_is_real_elemTupleIsRealElemTupleIsRealElemTupleIsRealElem

Module

Foundation

Operators