tuple_maxtuple_maxTupleMaxTupleMaxtuple_max (Operator)
Name
tuple_maxtuple_maxTupleMaxTupleMaxtuple_max — Return the maximal element of a tuple.
Signature
Herror tuple_max(const Hlong Tuple, double* Max)
Herror T_tuple_max(const Htuple Tuple, Htuple* Max)
def tuple_max(tuple: MaybeSequence[Union[float, int, str]]) -> Sequence[Union[float, int, str]]
def tuple_max_s(tuple: MaybeSequence[Union[float, int, str]]) -> Union[float, int, str]
Description
tuple_maxtuple_maxTupleMaxTupleMaxtuple_max returns the maximal 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 MaxMaxMaxmaxmax 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
maximum in MaxMaxMaxmaxmax 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_maxtuple_maxTupleMaxTupleMaxtuple_max,
which can be used in an expression in the following syntax:
Max := max(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) → HTupleMaybeSequence[Union[float, int, str]]HTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)
Input tuple.
MaxMaxMaxmaxmax (output_control) tuple(-array) → HTupleSequence[Union[float, int, str]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)
Maximal element of the input tuple elements.
Alternatives
tuple_mintuple_minTupleMinTupleMintuple_min,
tuple_meantuple_meanTupleMeanTupleMeantuple_mean,
tuple_deviationtuple_deviationTupleDeviationTupleDeviationtuple_deviation,
tuple_sumtuple_sumTupleSumTupleSumtuple_sum,
tuple_lengthtuple_lengthTupleLengthTupleLengthtuple_length,
tuple_mediantuple_medianTupleMedianTupleMediantuple_median
See also
tuple_max2tuple_max2TupleMax2TupleMax2tuple_max2,
tuple_min2tuple_min2TupleMin2TupleMin2tuple_min2
Module
Foundation