Class CutForwardWhenOp<T>

Provides outgoing messages for ForwardWhen<T>(T, Boolean), given random arguments to the function.

Inheritance

Object

CutForwardWhenOp<T>

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(Cut), "ForwardWhen<>", new Type[]{})]
[Quality(QualityBand.Preview)]
public static class CutForwardWhenOp<T>

Type Parameters

Name	Description
T	The type of the variable being copied.

Methods

ForwardWhenAverageConditional(T)

EP message to forwardWhen.

Declaration

public static T ForwardWhenAverageConditional(T Value)

Parameters

Type	Name	Description
T	Value	Incoming message from value.

Returns

Type	Description
T	The outgoing EP message to the forwardWhen argument.

Remarks

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

ForwardWhenAverageConditional<TDist>(TDist, Boolean, TDist)

Declaration

public static TDist ForwardWhenAverageConditional<TDist>(TDist Value, bool shouldCut, TDist result)
    where TDist : IDistribution<T>, SettableTo<TDist>

Parameters

Type	Name	Description
TDist	Value
Boolean	shouldCut
TDist	result

Returns

Type	Description
TDist

Type Parameters

Name	Description
TDist	The type of the distribution over the variable being copied.

ForwardWhenAverageLogarithm(T)

VMP message to forwardWhen.

Declaration

public static T ForwardWhenAverageLogarithm(T Value)

Parameters

Type	Name	Description
T	Value	Incoming message from value.

Returns

Type	Description
T	The outgoing VMP message to the forwardWhen argument.

Remarks

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

ForwardWhenAverageLogarithm<TDist>(TDist)

VMP message to forwardWhen.

Declaration

public static TDist ForwardWhenAverageLogarithm<TDist>(TDist Value)
    where TDist : IDistribution<T>

Parameters

Type	Name	Description
TDist	Value	Incoming message from value.

Returns

Type	Description
TDist	The outgoing VMP message to the forwardWhen argument.

Type Parameters

Name	Description
TDist	The type of the distribution over the variable being copied.

Remarks

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

ValueAverageConditional<TDist>(TDist)

EP message to value.

Declaration

public static TDist ValueAverageConditional<TDist>(TDist forwardWhen)
    where TDist : IDistribution<T>

Parameters

Type	Name	Description
TDist	forwardWhen	Incoming message from forwardWhen.

Returns

Type	Description
TDist	The outgoing EP message to the value argument.

Type Parameters

Name	Description
TDist	The type of the distribution over the variable being copied.

Remarks

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

ValueAverageLogarithm<TDist>(TDist)

VMP message to value.

Declaration

public static TDist ValueAverageLogarithm<TDist>(TDist result)
    where TDist : IDistribution<T>

Parameters

Type	Name	Description
TDist	result	Modified to contain the outgoing message.

Returns

Type	Description
TDist	result

Type Parameters

Name	Description
TDist	The type of the distribution over the variable being copied.

Remarks

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