Struct ArithmeticMean 

pub struct ArithmeticMean<T> { /* private fields */ }

Arithmetic mean statistic.

The arithmetic mean sums samples within their domain and computes the mean as a real number represented using floating-point. For floating-point samples, NaNs are discarded and the sum saturates to infinity without error.

This statistic is sensitive to overflow in the count of samples.

Implementations

impl<T> ArithmeticMean<T>

pub fn with_sum(sum: T) -> Self

Trait Implementations

impl<T: Clone> Clone for ArithmeticMean<T>

fn clone(&self) -> ArithmeticMean<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for ArithmeticMean<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Default for ArithmeticMean<T>

where T: Zero,

fn default() -> Self

Returns the “default value” for a type.

impl Statistic for ArithmeticMean<f32>

type Semantic = Gauge

The type of data semantic associated with samples.

type Sample = f32

The type of samples.

type Aggregation = f32

The type of the statistical aggregation.

fn fold(&mut self, sample: Self::Sample) -> Result<(), FoldError>

Folds a sample into the aggregation of the statistic.

fn fill( &mut self, sample: Self::Sample, n: NonZeroUsize, ) -> Result<(), FoldError>

Folds a sample into the aggregation of a statistic n (one or more) times.

fn reset(&mut self)

Resets the state (and aggregation) of the statistic.

fn aggregation(&self) -> Option<Self::Aggregation>

Gets the statistical aggregation.

impl Statistic for ArithmeticMean<i64>

type Semantic = Gauge

The type of data semantic associated with samples.

type Sample = i64

The type of samples.

type Aggregation = f32

The type of the statistical aggregation.

fn fold(&mut self, sample: Self::Sample) -> Result<(), FoldError>

Folds a sample into the aggregation of the statistic.

fn fill( &mut self, sample: Self::Sample, n: NonZeroUsize, ) -> Result<(), FoldError>

Folds a sample into the aggregation of a statistic n (one or more) times.

fn reset(&mut self)

Resets the state (and aggregation) of the statistic.

fn aggregation(&self) -> Option<Self::Aggregation>

Gets the statistical aggregation.

impl Statistic for ArithmeticMean<u64>

type Semantic = Gauge

The type of data semantic associated with samples.

type Sample = u64

The type of samples.

type Aggregation = f32

The type of the statistical aggregation.

fn fold(&mut self, sample: Self::Sample) -> Result<(), FoldError>

Folds a sample into the aggregation of the statistic.

fn fill( &mut self, sample: Self::Sample, n: NonZeroUsize, ) -> Result<(), FoldError>

Folds a sample into the aggregation of a statistic n (one or more) times.

fn reset(&mut self)

Resets the state (and aggregation) of the statistic.

fn aggregation(&self) -> Option<Self::Aggregation>

Gets the statistical aggregation.