tuple_meantuple_meanTupleMeanTupleMean (Operator)
Name
tuple_meantuple_meanTupleMeanTupleMean
— Return the mean value of a tuple of numbers.
Signature
Herror tuple_mean(const Hlong Tuple, double* Mean)
Herror T_tuple_mean(const Htuple Tuple, Htuple* Mean)
Description
tuple_meantuple_meanTupleMeanTupleMeanTupleMean
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_meanTupleMeanTupleMeanTupleMean
,
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) →
HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)
Input tuple.
MeanMeanMeanMeanmean
(output_control) number →
HTupleHTupleHtuple (real) (double) (double) (double)
Mean value of tuple elements.
Alternatives
tuple_deviationtuple_deviationTupleDeviationTupleDeviationTupleDeviation
,
tuple_sumtuple_sumTupleSumTupleSumTupleSum
,
tuple_mintuple_minTupleMinTupleMinTupleMin
,
tuple_maxtuple_maxTupleMaxTupleMaxTupleMax
,
tuple_lengthtuple_lengthTupleLengthTupleLengthTupleLength
,
tuple_mediantuple_medianTupleMedianTupleMedianTupleMedian
Module
Foundation