Class VectorGaussianEstimator
Estimates a Gaussian distribution from samples.
Implements
Inherited Members
Namespace: Microsoft.ML.Probabilistic.Distributions
Assembly: Microsoft.ML.Probabilistic.dll
Syntax
public class VectorGaussianEstimator : Estimator<VectorGaussian>, Accumulator<VectorGaussian>, Accumulator<Vector>, SettableTo<VectorGaussianEstimator>, ICloneable
Constructors
VectorGaussianEstimator(Int32)
Creates a new VectorGaussian estimator of a given dimension
Declaration
public VectorGaussianEstimator(int dimension)
Parameters
Type | Name | Description |
---|---|---|
Int32 | dimension | The dimension |
Properties
Dimension
Dimension of the VectorGaussian
Declaration
public int Dimension { get; }
Property Value
Type | Description |
---|---|
Int32 |
Methods
Add(VectorGaussian)
Adds a VectorGaussian distribution item to the estimator
Declaration
public void Add(VectorGaussian distribution)
Parameters
Type | Name | Description |
---|---|---|
VectorGaussian | distribution | The distribution instance to add |
Add(VectorGaussian, Double)
Adds a weighted VectorGaussian distribution item to the estimator
Declaration
public void Add(VectorGaussian distribution, double weight)
Parameters
Type | Name | Description |
---|---|---|
VectorGaussian | distribution | The distribution instance to add |
Double | weight | The weight of the distribution |
Add(Vector)
Adds a sample item to the estimator
Declaration
public void Add(Vector sample)
Parameters
Type | Name | Description |
---|---|---|
Vector | sample | The sample value to add |
Add(Vector, Double)
Add a sample item with a given weight to the estimator
Declaration
public void Add(Vector sample, double weight)
Parameters
Type | Name | Description |
---|---|---|
Vector | sample | The sample value to add |
Double | weight | The weight of the sample |
Clear()
Clears the accumulator
Declaration
public void Clear()
Clone()
Returns a clone of this estimator.
Declaration
public object Clone()
Returns
Type | Description |
---|---|
Object |
GetDistribution(VectorGaussian)
Computes the maximum-likelihood Gaussian from the samples.
Declaration
public VectorGaussian GetDistribution(VectorGaussian result)
Parameters
Type | Name | Description |
---|---|---|
VectorGaussian | result | May be null. |
Returns
Type | Description |
---|---|
VectorGaussian | If result is not null, modifies and returns result. |
SetTo(VectorGaussianEstimator)
Sets the state of this estimator from the specified estimator.
Declaration
public void SetTo(VectorGaussianEstimator value)
Parameters
Type | Name | Description |
---|---|---|
VectorGaussianEstimator | value |