Class MeanVarianceAccumulator

Class for accumulating weighted noisy scalar observations, and computing sample count, mean, and variance

Inheritance

Object

MeanVarianceAccumulator

Implements

Accumulator<Double>

SettableTo<MeanVarianceAccumulator>

ICloneable

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: Microsoft.ML.Probabilistic.Math

Assembly: Microsoft.ML.Probabilistic.dll

Syntax

public class MeanVarianceAccumulator : Accumulator<double>, SettableTo<MeanVarianceAccumulator>, ICloneable

Fields

Count

Sample count

Declaration

public double Count

Field Value

Type	Description
Double

Mean

The sample mean

Declaration

public double Mean

Field Value

Type	Description
Double

Variance

Sample variance

Declaration

public double Variance

Field Value

Type	Description
Double

Methods

Add(Double)

Adds an observation

Declaration

public void Add(double x)

Parameters

Type	Name	Description
Double	x

Add(Double, Double)

Adds a weighted observation.

Declaration

public void Add(double x, double weight)

Parameters

Type	Name	Description
Double	x
Double	weight

Add(Double, Double, Double)

Adds a noisy observation.

Declaration

public void Add(double x, double noiseVariance, double weight)

Parameters

Type	Name	Description
Double	x
Double	noiseVariance
Double	weight

Clear()

Clears the accumulator

Declaration

public void Clear()

Clone()

Returns a clone of this estimator.

Declaration

public object Clone()

Returns

Type	Description
Object

SetTo(MeanVarianceAccumulator)

Sets the state of this estimator from the specified estimator.

Declaration

public void SetTo(MeanVarianceAccumulator value)

Parameters

Type	Name	Description
MeanVarianceAccumulator	value

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

Implements

Accumulator<T>

SettableTo<T>

System.ICloneable