Operator Reference

tuple_deviationtuple_deviationTupleDeviationTupleDeviationtuple_deviation (Operator)

tuple_deviationtuple_deviationTupleDeviationTupleDeviationtuple_deviation — 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()

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

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

Description

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

Deviation := deviation(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.

DeviationDeviationDeviationdeviationdeviation (output_control)  number(-array) HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Standard deviation of tuple elements.

Alternatives

tuple_meantuple_meanTupleMeanTupleMeantuple_mean, tuple_sumtuple_sumTupleSumTupleSumtuple_sum, tuple_mintuple_minTupleMinTupleMintuple_min, tuple_maxtuple_maxTupleMaxTupleMaxtuple_max, tuple_lengthtuple_lengthTupleLengthTupleLengthtuple_length, tuple_mediantuple_medianTupleMedianTupleMediantuple_median

Module

Foundation