tuple_maxtuple_maxTupleMaxTupleMax (Operator)

Name

tuple_maxtuple_maxTupleMaxTupleMax — Return the maximal element of a tuple.

Signature

tuple_max( : : Tuple : Max)

Herror tuple_max(const Hlong Tuple, double* Max)

Herror T_tuple_max(const Htuple Tuple, Htuple* Max)

void TupleMax(const HTuple& Tuple, HTuple* Max)

HTuple HTuple::TupleMax() const

static void HOperatorSet.TupleMax(HTuple tuple, out HTuple max)

HTuple HTuple.TupleMax()

Description

tuple_maxtuple_maxTupleMaxTupleMaxTupleMax 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 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_maxtuple_maxTupleMaxTupleMaxTupleMax, which can be used in an expression in the following syntax:

Max := max(Tuple)

Execution Information

Parameters

TupleTupleTupleTupletuple (input_control)  tuple(-array) HTupleHTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)

Input tuple.

MaxMaxMaxMaxmax (output_control)  tuple(-array) HTupleHTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)

Maximal element of the input tuple elements.

Alternatives

tuple_mintuple_minTupleMinTupleMinTupleMin, 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