Class WrappedGaussianProductOp

Provides outgoing messages for the following factors:

, given random arguments to the function.

Inheritance

Object

WrappedGaussianProductOp

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), "Product", new Type[]{typeof(double), typeof(double)})]
[FactorMethod(new string[]{"A", "Product", "B"}, typeof(Factor), "Ratio", new Type[]{typeof(double), typeof(double)})]
[Quality(QualityBand.Experimental)]
public static class WrappedGaussianProductOp

Methods

AAverageConditional(WrappedGaussian, Double, WrappedGaussian)

EP message to a.

Declaration

public static WrappedGaussian AAverageConditional(WrappedGaussian Product, double B, WrappedGaussian result)

Parameters

Type	Name	Description
WrappedGaussian	Product	Incoming message from `product`. Must be a proper distribution. If uniform, the result will be uniform.
Double	B	Constant value for `b`.
WrappedGaussian	result	Modified to contain the outgoing message.

Returns

Type	Description
WrappedGaussian	`result`

Remarks

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

Exceptions

Type	Condition
ImproperMessageException	`Product` is not a proper distribution.

AAverageConditional(Double, Double, WrappedGaussian)

EP message to a.

Declaration

public static WrappedGaussian AAverageConditional(double Product, double B, WrappedGaussian result)

Parameters

Type	Name	Description
Double	Product	Constant value for `product`.
Double	B	Constant value for `b`.
WrappedGaussian	result	Modified to contain the outgoing message.

Returns

Type	Description
WrappedGaussian	`result`

Remarks

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

AAverageLogarithm(WrappedGaussian, Double, WrappedGaussian)

VMP message to a.

Declaration

public static WrappedGaussian AAverageLogarithm(WrappedGaussian Product, double B, WrappedGaussian result)

Parameters

Type	Name	Description
WrappedGaussian	Product	Incoming message from `product`. Must be a proper distribution. If uniform, the result will be uniform.
Double	B	Constant value for `b`.
WrappedGaussian	result	Modified to contain the outgoing message.

Returns

Type	Description
WrappedGaussian	`result`

Remarks

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

Exceptions

Type	Condition
ImproperMessageException	`Product` is not a proper distribution.

AAverageLogarithm(Double, Double, WrappedGaussian)

VMP message to a.

Declaration

public static WrappedGaussian AAverageLogarithm(double Product, double B, WrappedGaussian result)

Parameters

Type	Name	Description
Double	Product	Constant value for `product`.
Double	B	Constant value for `b`.
WrappedGaussian	result	Modified to contain the outgoing message.

Returns

Type	Description
WrappedGaussian	`result`

Remarks

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

AverageLogFactor(WrappedGaussian)

Evidence message for VMP.

Declaration

public static double AverageLogFactor(WrappedGaussian product)

Parameters

Type	Name	Description
WrappedGaussian	product	Incoming message from `product`.

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.

BAverageConditional(WrappedGaussian, Double, WrappedGaussian)

EP message to b.

Declaration

public static WrappedGaussian BAverageConditional(WrappedGaussian Product, double A, WrappedGaussian result)

Parameters

Type	Name	Description
WrappedGaussian	Product	Incoming message from `product`. Must be a proper distribution. If uniform, the result will be uniform.
Double	A	Constant value for `a`.
WrappedGaussian	result	Modified to contain the outgoing message.

Returns

Type	Description
WrappedGaussian	`result`

Remarks

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

Exceptions

Type	Condition
ImproperMessageException	`Product` is not a proper distribution.

BAverageLogarithm(WrappedGaussian, Double, WrappedGaussian)

VMP message to b.

Declaration

public static WrappedGaussian BAverageLogarithm(WrappedGaussian Product, double A, WrappedGaussian result)

Parameters

Type	Name	Description
WrappedGaussian	Product	Incoming message from `product`. Must be a proper distribution. If uniform, the result will be uniform.
Double	A	Constant value for `a`.
WrappedGaussian	result	Modified to contain the outgoing message.

Returns

Type	Description
WrappedGaussian	`result`

Remarks

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

Exceptions

Type	Condition
ImproperMessageException	`Product` is not a proper distribution.

ProductAverageLogarithm(WrappedGaussian, Double, WrappedGaussian)

VMP message to product.

Declaration

public static WrappedGaussian ProductAverageLogarithm(WrappedGaussian A, double B, WrappedGaussian result)

Parameters

Type	Name	Description
WrappedGaussian	A	Incoming message from `a`. Must be a proper distribution. If uniform, the result will be uniform.
Double	B	Constant value for `b`.
WrappedGaussian	result	Modified to contain the outgoing message.

Returns

Type	Description
WrappedGaussian	`result`

Remarks

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

Exceptions

Type	Condition
ImproperMessageException	`A` is not a proper distribution.

ProductAverageLogarithm(Double, WrappedGaussian, WrappedGaussian)

VMP message to product.

Declaration

public static WrappedGaussian ProductAverageLogarithm(double A, WrappedGaussian B, WrappedGaussian result)

Parameters

Type	Name	Description
Double	A	Constant value for `a`.
WrappedGaussian	B	Incoming message from `b`. Must be a proper distribution. If uniform, the result will be uniform.
WrappedGaussian	result	Modified to contain the outgoing message.

Returns

Type	Description
WrappedGaussian	`result`

Remarks

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

Exceptions

Type	Condition
ImproperMessageException	`B` is not a proper distribution.