Operator Reference

tuple_meantuple_meanTupleMeanTupleMeantuple_mean (Operator)

tuple_meantuple_meanTupleMeanTupleMeantuple_mean — Return the mean value of a tuple of numbers.

Signature

tuple_mean( : : Tuple : Mean)

Herror tuple_mean(const Hlong Tuple, double* Mean)

Herror T_tuple_mean(const Htuple Tuple, Htuple* Mean)

void TupleMean(const HTuple& Tuple, HTuple* Mean)

HTuple HTuple::TupleMean() const

static void HOperatorSet.TupleMean(HTuple tuple, out HTuple mean)

HTuple HTuple.TupleMean()

def tuple_mean(tuple: MaybeSequence[Union[float, int]]) -> float

Description

tuple_meantuple_meanTupleMeanTupleMeantuple_mean returns the mean value of all elements of the input tuple TupleTupleTupletupletuple as a floating point number in the output parameter MeanMeanMeanmeanmean. The input tuple may only consist of numbers (integer or floating point numbers).

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

Mean := mean(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)  number(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Input tuple.

MeanMeanMeanmeanmean (output_control)  number HTuplefloatHTupleHtuple (real) (double) (double) (double)

Mean value of tuple elements.

Alternatives

tuple_deviationtuple_deviationTupleDeviationTupleDeviationtuple_deviation, tuple_sumtuple_sumTupleSumTupleSumtuple_sum, tuple_mintuple_minTupleMinTupleMintuple_min, tuple_maxtuple_maxTupleMaxTupleMaxtuple_max, tuple_lengthtuple_lengthTupleLengthTupleLengthtuple_length, tuple_mediantuple_medianTupleMedianTupleMediantuple_median

Module

Foundation