Class UsesEqualDefGibbsOp<T>

Provides outgoing messages for UsesEqualDef<T>(T, Int32, out T), given random arguments to the function.

Inheritance

Object

UsesEqualDefGibbsOp<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(Clone), "UsesEqualDef<>", new Type[]{})]
[Quality(QualityBand.Mature)]
public static class UsesEqualDefGibbsOp<T>

Type Parameters

Name	Description
T	The type of the variable.

Methods

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

Declaration

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

Parameters

Type	Name	Description
GibbsMarginal<TDist, T>	to_marginal	Previous outgoing message to `marginal`.
T	result	Modified to contain the outgoing message.

Returns

Type	Description
T	`result`

Type Parameters

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

Remarks

DefGibbs<TDist>(IReadOnlyList<TDist>, TDist)

Declaration

public static TDist DefGibbs<TDist>([SkipIfAllUniform] IReadOnlyList<TDist> Uses, TDist result)
    where TDist : IDistribution<T>, Sampleable<T>, SettableTo<TDist>, SettableToProduct<TDist>, SettableToRatio<TDist>

Parameters

Type	Name	Description
IReadOnlyList<TDist>	Uses
TDist	result

Returns

Type	Description
TDist

Type Parameters

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

GibbsEvidence<TDist>(IList<TDist>, TDist, GibbsMarginal<TDist, T>)

Declaration

public static double GibbsEvidence<TDist>(IList<TDist> Uses, TDist Def, GibbsMarginal<TDist, T> to_marginal)
    where TDist : IDistribution<T>, Sampleable<T>, CanGetLogAverageOf<TDist>, SettableTo<TDist>, SettableToProduct<TDist>

Parameters

Type	Name	Description
IList<TDist>	Uses	Incoming message from `Uses`.
TDist	Def	Incoming message from `Def`.
GibbsMarginal<TDist, T>	to_marginal	Previous outgoing message to `marginal`.

Returns

Type	Description
Double

Type Parameters

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

Remarks

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

Declaration

public static GibbsMarginal<TDist, T> MarginalGibbs<TDist>(IList<T> Uses, TDist Def, GibbsMarginal<TDist, T> to_marginal)
    where TDist : IDistribution<T>, SettableToProduct<TDist>, SettableToRatio<TDist>, SettableTo<TDist>, Sampleable<T>

Parameters

Type	Name	Description
IList<T>	Uses	Incoming message from `Uses`.
TDist	Def	Incoming message from `Def`.
GibbsMarginal<TDist, T>	to_marginal	Previous outgoing message to `marginal`.

Returns

Type	Description
GibbsMarginal<TDist, T>

Type Parameters

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

Remarks

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

Declaration

public static GibbsMarginal<TDist, T> MarginalGibbs<TDist>(IReadOnlyList<TDist> Uses, TDist Def, GibbsMarginal<TDist, T> to_marginal)
    where TDist : IDistribution<T>, SettableToProduct<TDist>, SettableToRatio<TDist>, SettableTo<TDist>, Sampleable<T>

Parameters

Type	Name	Description
IReadOnlyList<TDist>	Uses
TDist	Def
GibbsMarginal<TDist, T>	to_marginal

Returns

Type	Description
GibbsMarginal<TDist, T>

Type Parameters

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

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

Declaration

public static GibbsMarginal<TDist, T> MarginalGibbs<TDist>(IReadOnlyList<TDist> Uses, T Def, GibbsMarginal<TDist, T> to_marginal)
    where TDist : IDistribution<T>, SettableToProduct<TDist>, SettableToRatio<TDist>, SettableTo<TDist>, Sampleable<T>

Parameters

Type	Name	Description
IReadOnlyList<TDist>	Uses
T	Def
GibbsMarginal<TDist, T>	to_marginal

Returns

Type	Description
GibbsMarginal<TDist, T>

Type Parameters

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

MarginalGibbsInit<TDist>(TDist)

Declaration

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

Parameters

Type	Name	Description
TDist	Def	Incoming message from `Def`.

Returns

Type	Description
GibbsMarginal<TDist, T>

Type Parameters

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

Remarks

UsesGibbs<TDist>(GibbsMarginal<TDist, T>, Int32, T)

Declaration

public static T UsesGibbs<TDist>(GibbsMarginal<TDist, T> to_marginal, int resultIndex, T result)
    where TDist : IDistribution<T>, Sampleable<T>

Parameters

Type	Name	Description
GibbsMarginal<TDist, T>	to_marginal	Previous outgoing message to `marginal`.
Int32	resultIndex	Index of the `Uses` for which a message is desired.
T	result	Modified to contain the outgoing message.

Returns

Type	Description
T	`result`

Type Parameters

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

Remarks

UsesGibbs<TDist>(ICollection<TDist>, TDist, Int32, TDist)

Declaration

public static TDist UsesGibbs<TDist>(ICollection<TDist> Uses, TDist Def, int resultIndex, TDist result)
    where TDist : IDistribution<T>, Sampleable<T>, SettableTo<TDist>, SettableToProduct<TDist>, SettableToRatio<TDist>

Parameters

Type	Name	Description
ICollection<TDist>	Uses	Incoming message from `Uses`.
TDist	Def	Incoming message from `Def`.
Int32	resultIndex	Index of the `Uses` for which a message is desired.
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.

Remarks

UsesGibbsInit<TArrayType, TDef>(TDef, Int32, IArrayFactory<TDef, TArrayType>)

Declaration

public static TArrayType UsesGibbsInit<TArrayType, TDef>(TDef Def, int count, IArrayFactory<TDef, TArrayType> factory)
    where TDef : ICloneable

Parameters

Type	Name	Description
TDef	Def	Incoming message from `Def`.
Int32	count	Constant value for `count`.
IArrayFactory<TDef, TArrayType>	factory

Returns

Type	Description
TArrayType

Type Parameters

Name	Description
TArrayType	The type of arrays produced by `factory`.
TDef	The type of the incoming message from `Def`.