tuple_mintuple_minTupleMinTupleMin (Operator)
Name
tuple_mintuple_minTupleMinTupleMin
— Return the minimal element of a tuple.
Signature
Herror tuple_min(const Hlong Tuple, double* Min)
Herror T_tuple_min(const Htuple Tuple, Htuple* Min)
Description
tuple_mintuple_minTupleMinTupleMinTupleMin
returns the minimal element of all elements
of the input tuple TupleTupleTupleTupletuple
. All elements of TupleTupleTupleTupletuple
either have to be strings or numbers (integer or floating point numbers).
It is not allowed to mix strings with numerical values. The result
parameter MinMinMinMinmin
will contain a floating point number, if
at least one element of TupleTupleTupleTupletuple
is a floating point number.
If all elements of TupleTupleTupleTupletuple
are integer numbers the resulting
sum will also be an integer number.
Exception: Empty input tuple
If the input tuple is empty, an exception is raised.
HDevelop In-line Operation
HDevelop provides an in-line operation for tuple_mintuple_minTupleMinTupleMinTupleMin
,
which can be used in an expression in the following syntax:
Min := min(Tuple)
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
TupleTupleTupleTupletuple
(input_control) tuple(-array) →
HTupleHTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)
Input tuple.
MinMinMinMinmin
(output_control) tuple(-array) →
HTupleHTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)
Minimal element of the input tuple elements.
Alternatives
tuple_maxtuple_maxTupleMaxTupleMaxTupleMax
,
tuple_meantuple_meanTupleMeanTupleMeanTupleMean
,
tuple_deviationtuple_deviationTupleDeviationTupleDeviationTupleDeviation
,
tuple_sumtuple_sumTupleSumTupleSumTupleSum
,
tuple_lengthtuple_lengthTupleLengthTupleLengthTupleLength
,
tuple_mediantuple_medianTupleMedianTupleMedianTupleMedian
See also
tuple_max2tuple_max2TupleMax2TupleMax2TupleMax2
,
tuple_min2tuple_min2TupleMin2TupleMin2TupleMin2
Module
Foundation