Class GaussianRatioVmpOp

Provides outgoing messages for Ratio(Double, Double), given random arguments to the function.

Inheritance

Object

GaussianRatioVmpOp

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Microsoft.ML.Probabilistic.Factors

Assembly: Microsoft.ML.Probabilistic.dll

Syntax

[FactorMethod(typeof(Factor), "Ratio", new Type[]{typeof(double), typeof(double)})]
[Quality(QualityBand.Mature)]
public static class GaussianRatioVmpOp

Methods

AAverageLogarithm(Gaussian)

VMP message to a.

Declaration

[NotSupported("Variational Message Passing does not support a Ratio factor with fixed output or random denominator.")]
public static Gaussian AAverageLogarithm(Gaussian B)

Parameters

Type	Name	Description
Gaussian	B	Incoming message from b.

Returns

Type	Description
Gaussian	The outgoing VMP message to the a argument.

Remarks

The outgoing message is the exponential of the average log-factor value, where the average is over all arguments except a. The formula is exp(sum_(b) p(b) log(factor(ratio,a,b))).

AAverageLogarithm(Gaussian, Double)

VMP message to a.

Declaration

public static Gaussian AAverageLogarithm(Gaussian ratio, double B)

Parameters

Type	Name	Description
Gaussian	ratio	Incoming message from ratio. Must be a proper distribution. If uniform, the result will be uniform.
Double	B	Constant value for b.

Returns

Type	Description
Gaussian	The outgoing VMP message to the a argument.

Remarks

The outgoing message is the factor viewed as a function of a with ratio integrated out. The formula is sum_ratio p(ratio) factor(ratio,a,b).

Exceptions

Type	Condition
ImproperMessageException	ratio is not a proper distribution.

AAverageLogarithm(Double, Double)

VMP message to a.

Declaration

public static Gaussian AAverageLogarithm(double ratio, double B)

Parameters

Type	Name	Description
Double	ratio	Constant value for ratio.
Double	B	Constant value for b.

Returns

Type	Description
Gaussian	The outgoing VMP message to the a argument.

Remarks

The outgoing message is the factor viewed as a function of a conditioned on the given values.

AverageLogFactor(Gaussian)

Evidence message for VMP.

Declaration

public static double AverageLogFactor(Gaussian ratio)

Parameters

Type	Name	Description
Gaussian	ratio	Incoming message from ratio.

Returns

Type	Description
Double	Zero.

Remarks

In Variational Message Passing, the evidence contribution of a deterministic factor is zero. Adding up these values across all factors and variables gives the log-evidence estimate for VMP.

BAverageLogarithm()

VMP message to b.

Declaration

[NotSupported("Variational Message Passing does not support a Ratio factor with fixed output or random denominator.")]
public static Gaussian BAverageLogarithm()

Returns

Type	Description
Gaussian	The outgoing VMP message to the b argument.

Remarks

The outgoing message is the factor viewed as a function of b conditioned on the given values.

RatioAverageLogarithm(Gaussian)

VMP message to ratio.

Declaration

[NotSupported("Variational Message Passing does not support a Ratio factor with fixed output or random denominator.")]
public static Gaussian RatioAverageLogarithm(Gaussian B)

Parameters

Type	Name	Description
Gaussian	B	Incoming message from b.

Returns

Type	Description
Gaussian	The outgoing VMP message to the ratio argument.

Remarks

The outgoing message is a distribution matching the moments of ratio as the random arguments are varied. The formula is proj[sum_(b) p(b) factor(ratio,a,b)].

RatioAverageLogarithm(Gaussian, Double)

VMP message to ratio.

Declaration

public static Gaussian RatioAverageLogarithm(Gaussian A, double B)

Parameters

Type	Name	Description
Gaussian	A	Incoming message from a. Must be a proper distribution. If uniform, the result will be uniform.
Double	B	Constant value for b.

Returns

Type	Description
Gaussian	The outgoing VMP message to the ratio argument.

Remarks

The outgoing message is a distribution matching the moments of ratio as the random arguments are varied. The formula is proj[sum_(a) p(a) factor(ratio,a,b)].

Exceptions

Type	Condition
ImproperMessageException	A is not a proper distribution.