Class DerivedVariableGibbsOp

Provides outgoing messages for the following factors:

• DerivedVariableGibbs<T>(T, out T)
• DerivedVariableInitGibbs<T>(T, T, out T)

, given random arguments to the function.

Inheritance

Object

DerivedVariableGibbsOp

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(Clone), "DerivedVariableGibbs<>", new Type[]{})]
[FactorMethod(typeof(Clone), "DerivedVariableInitGibbs<>", new Type[]{})]
[Quality(QualityBand.Preview)]
public static class DerivedVariableGibbsOp

Methods

DefGibbs<TDist, T>(TDist)

Gibbs distribution message to 'Def'

Declaration

public static TDist DefGibbs<TDist, T>(TDist Use)

Parameters

Type	Name	Description
TDist	Use	Incoming message from 'Use'.

Returns

Type	Description
TDist

Type Parameters

Name	Description
TDist	Distribution type
T	Domain type

Remarks

The outgoing message is the product of all the 'Use' messages.

Exceptions

Type	Condition
ImproperMessageException	Use is not a proper distribution

DefGibbs<TDist, T>(GibbsMarginal<TDist, T>, T)

Declaration

public static T DefGibbs<TDist, T>(GibbsMarginal<TDist, T> marginal, T result)
    where TDist : IDistribution<T>, Sampleable<T>

Parameters

Type	Name	Description
GibbsMarginal<TDist, T>	marginal
T	result

Returns

Type	Description
T

Type Parameters

Name	Description
TDist
T

GibbsEvidence()

Evidence message for Gibbs.

Declaration

public static double GibbsEvidence()

Returns

Type	Description
Double

MarginalGibbs<TDist, T>(TDist, TDist, GibbsMarginal<TDist, T>)

Gibbs message to 'Marginal' for distribution Def

Declaration

[SkipIfAllUniform]
public static GibbsMarginal<TDist, T> MarginalGibbs<TDist, T>(TDist Use, TDist Def, GibbsMarginal<TDist, T> to_marginal)
    where TDist : IDistribution<T>, SettableToProduct<TDist>, Sampleable<T>

Parameters

Type	Name	Description
TDist	Use	Incoming message from 'Use'.
TDist	Def	Incoming message from 'Def'.
GibbsMarginal<TDist, T>	to_marginal	Previous outgoing message to 'marginal'.

Returns

Type	Description
GibbsMarginal<TDist, T>	to_marginal

Type Parameters

Name	Description
TDist
T

Remarks

The outgoing message is the product of 'Def' and 'Use' messages.

MarginalGibbs<TDist, T>(T, TDist, GibbsMarginal<TDist, T>)

Gibbs message to 'Marginal' for sample Use

Declaration

public static GibbsMarginal<TDist, T> MarginalGibbs<TDist, T>(T Use, TDist Def, GibbsMarginal<TDist, T> to_marginal)
    where TDist : IDistribution<T>, Sampleable<T>

Parameters

Type	Name	Description
T	Use
TDist	Def
GibbsMarginal<TDist, T>	to_marginal	Previous outgoing message to 'marginal'.

Returns

Type	Description
GibbsMarginal<TDist, T>	to_marginal

Type Parameters

Name	Description
TDist
T

MarginalGibbs<TDist, T>(T, GibbsMarginal<TDist, T>)

Gibbs message to 'Marginal' for sample Def

Declaration

public static GibbsMarginal<TDist, T> MarginalGibbs<TDist, T>(T Def, GibbsMarginal<TDist, T> to_marginal)
    where TDist : IDistribution<T>, Sampleable<T>

Parameters

Type	Name	Description
T	Def
GibbsMarginal<TDist, T>	to_marginal	Previous outgoing message to 'marginal'.

Returns

Type	Description
GibbsMarginal<TDist, T>	to_marginal

Type Parameters

Name	Description
TDist
T

UseGibbs<T>(T, T)

Gibbs sample message to 'Uses'

Declaration

public static T UseGibbs<T>(T def, T result)

Parameters

Type	Name	Description
T	def
T	result	Result

Returns

Type	Description
T

Type Parameters

Name	Description
T	Domain type

Remarks

The outgoing message is the current Gibbs sample.

UseGibbs<TDist, T>(GibbsMarginal<TDist, T>, TDist, T)

Gibbs sample message to 'Uses'

Declaration

public static T UseGibbs<TDist, T>(GibbsMarginal<TDist, T> marginal, TDist def, T result)
    where TDist : IDistribution<T>, Sampleable<T>

Parameters

Type	Name	Description
GibbsMarginal<TDist, T>	marginal	The Gibbs marginal
TDist	def
T	result	Result

Returns

Type	Description
T

Type Parameters

Name	Description
TDist	Gibbs marginal type
T	Domain type

Remarks

The outgoing message is the current Gibbs sample.