Class GammaPowerEstimator

Estimates a GammaPower distribution from samples.

Inheritance
Object
GammaPowerEstimator
Inherited Members
Namespace: Microsoft.ML.Probabilistic.Distributions
Assembly: Microsoft.ML.Probabilistic.dll
Syntax
public class GammaPowerEstimator : Estimator<GammaPower>, Accumulator<GammaPower>, Accumulator<double>, SettableTo<GammaPowerEstimator>, ICloneable
Remarks
    The distribution is estimated via moment matching (not maximum-likelihood).
    In the one-dimensional case,
    E[x] = (a+1)/b
    var(x) = (a+1)/b^2
    b = E[x]/var(x)
    a = E[x]^2/var(x) - 1

Constructors

GammaPowerEstimator(Double)

Creates a new GammaPower estimator

Declaration
public GammaPowerEstimator(double power)
Parameters
Type Name Description
Double power

Fields

Power

Desired power

Declaration
public readonly double Power
Field Value
Type Description
Double

Methods

Add(GammaPower)

Adds a GammaPower distribution item to the estimator

Declaration
public void Add(GammaPower distribution)
Parameters
Type Name Description
GammaPower distribution

The distribution instance to add

Add(GammaPower, Double)

Adds a GammaPower distribution item to the estimator

Declaration
public void Add(GammaPower distribution, double weight)
Parameters
Type Name Description
GammaPower distribution

The distribution instance to add
Double weight

The weight of the sample

Add(Double)

Adds a sample to the estimator

Declaration
public void Add(double value)
Parameters
Type Name Description
Double value

The sample to add

Add(Double, Double)

Adds a sample with a given weight to the estimator

Declaration
public void Add(double value, double weight)
Parameters
Type Name Description
Double value

The sample to add
Double weight

The weight of the sample

Clear()

Clears the estimator

Declaration
public void Clear()

Clone()

Returns a clone of this estimator.

Declaration
public object Clone()
Returns
Type Description
Object

GetDistribution(GammaPower)

Retrieves the estimated GammaPower

Declaration
public GammaPower GetDistribution(GammaPower result)
Parameters
Type Name Description
GammaPower result

Where to put the result
Returns
Type Description
GammaPower

The resulting distribution

SetTo(GammaPowerEstimator)

Sets the state of this estimator from the supplied estimator.

Declaration
public void SetTo(GammaPowerEstimator value)
Parameters
Type Name Description
GammaPowerEstimator value

Implements