ClassesClasses | | Operators

tuple_deviationtuple_deviationTupleDeviationTupleDeviation (Operator)

Name

tuple_deviationtuple_deviationTupleDeviationTupleDeviation — Return the standard deviation of the elements of a tuple.

Signature

tuple_deviation( : : Tuple : Deviation)

Herror tuple_deviation(const Hlong Tuple, double* Deviation)

Herror T_tuple_deviation(const Htuple Tuple, Htuple* Deviation)

void TupleDeviation(const HTuple& Tuple, HTuple* Deviation)

HTuple HTuple::TupleDeviation() const

static void HOperatorSet.TupleDeviation(HTuple tuple, out HTuple deviation)

HTuple HTuple.TupleDeviation()

Description

tuple_deviationtuple_deviationTupleDeviationTupleDeviationTupleDeviation calculates the standard deviation of all elements of the input tuple TupleTupleTupleTupletuple. It returns the deviation as a floating point number in the output parameter DeviationDeviationDeviationDeviationdeviation. 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_deviationtuple_deviationTupleDeviationTupleDeviationTupleDeviation, which can be used in an expression in the following syntax:

Deviation := deviation(Tuple)

Execution Information

Parameters

TupleTupleTupleTupletuple (input_control)  number(-array) HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Input tuple.

DeviationDeviationDeviationDeviationdeviation (output_control)  number(-array) HTupleHTupleHtuple (real) (double) (double) (double)

Standard deviation of tuple elements.

Alternatives

tuple_meantuple_meanTupleMeanTupleMeanTupleMean, tuple_sumtuple_sumTupleSumTupleSumTupleSum, tuple_mintuple_minTupleMinTupleMinTupleMin, tuple_maxtuple_maxTupleMaxTupleMaxTupleMax, tuple_lengthtuple_lengthTupleLengthTupleLengthTupleLength, tuple_mediantuple_medianTupleMedianTupleMedianTupleMedian

Module

Foundation


ClassesClasses | | Operators