BloombergLP::bdlsta::Moment<BloombergLP::bdlsta::MomentLevel::e_M1>::meanIfValid

Load mean into result when data is sufficient.

Synopsis

Declared in <bdlsta_moment.h>

int
meanIfValid(double* result) const;

Description

Load into the specified result, the mean of the data set. Return 0 on success, and a non-zero value otherwise. Specifically, e_INADEQUATE_DATA is returned if 1 > count.

Return Value

0 on success, or a non-zero status otherwise

Parameters

NameDescription
resultdestination for the mean on success