Class ReplicateGibbsOp2<T>

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

Inheritance

Object

ReplicateGibbsOp2<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), "ReplicateWithMarginalGibbs<>", new Type[]{})]
[Buffers(new string[]{"sample", "conditional", "marginalEstimator", "sampleAcc", "conditionalAcc"})]
[Quality(QualityBand.Mature)]
public static class ReplicateGibbsOp2<T>

Type Parameters

Name	Description
T	The type of the replicated variable.

Methods

Conditional<TDist>(T, TDist)

Update the buffer conditional.

Declaration

public static TDist Conditional<TDist>(T Def, TDist result)
    where TDist : HasPoint<T>

Parameters

Type	Name	Description
T	Def	Incoming message from Def.
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 replicated variable.

Remarks

Conditional<TDist>(IReadOnlyList<TDist>, TDist, TDist)

Declaration

public static TDist Conditional<TDist>(IReadOnlyList<TDist> Uses, TDist Def, TDist result)
    where TDist : SettableTo<TDist>, SettableToProduct<TDist>

Parameters

Type	Name	Description
IReadOnlyList<TDist>	Uses
TDist	Def
TDist	result

Returns

Type	Description
TDist

Type Parameters

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

ConditionalAcc<TDist>(TDist, Accumulator<TDist>)

Update the buffer conditionalAcc.

Declaration

public static Accumulator<TDist> ConditionalAcc<TDist>(TDist conditional, Accumulator<TDist> conditionalAcc)
    where TDist : ICloneable

Parameters

Type	Name	Description
TDist	conditional	Buffer conditional.
Accumulator<TDist>	conditionalAcc	Buffer conditionalAcc.

Returns

Type	Description
Accumulator<TDist>	New value of buffer conditionalAcc.

Type Parameters

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

Remarks

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

Initialize the buffer conditionalAcc.

Declaration

public static Accumulator<TDist> ConditionalAccInit<TDist>(ICollection<TDist> to_conditionals, int burnIn, int thin)

Parameters

Type	Name	Description
ICollection<TDist>	to_conditionals	Previous outgoing message to conditionals.
Int32	burnIn	Constant value for burnIn.
Int32	thin	Constant value for thin.

Returns

Type	Description
Accumulator<TDist>	Initial value of buffer conditionalAcc.

Type Parameters

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

Remarks

ConditionalInit<TDist>(TDist)

Initialize the buffer conditional.

Declaration

public static TDist ConditionalInit<TDist>(TDist to_marginal)
    where TDist : ICloneable

Parameters

Type	Name	Description
TDist	to_marginal	Previous outgoing message to marginal.

Returns

Type	Description
TDist	Initial value of buffer conditional.

Type Parameters

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

Remarks

ConditionalsGibbs<TDist, TDistList>(Accumulator<TDist>, TDistList)

Declaration

public static TDistList ConditionalsGibbs<TDist, TDistList>(Accumulator<TDist> conditionalAcc, TDistList result)
    where TDistList : ICollection<TDist>

Parameters

Type	Name	Description
Accumulator<TDist>	conditionalAcc	Buffer conditionalAcc.
TDistList	result	Modified to contain the outgoing message.

Returns

Type	Description
TDistList	result

Type Parameters

Name	Description
TDist	The type of the distribution over the replicated variable.
TDistList	The type of the outgoing message.

Remarks

DefGibbs<TDist>(TDist, T)

Declaration

public static T DefGibbs<TDist>(TDist def, T sample)
    where TDist : IDistribution<T>

Parameters

Type	Name	Description
TDist	def	Incoming message from Def.
T	sample	Buffer sample.

Returns

Type	Description
T

Type Parameters

Name	Description
TDist	The type of the distribution over the replicated 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 replicated variable.

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

Declaration

public static double GibbsEvidence<TDist>(IList<TDist> Uses, T Def)
    where TDist : IDistribution<T>

Parameters

Type	Name	Description
IList<TDist>	Uses	Incoming message from Uses.
T	Def	Incoming message from Def.

Returns

Type	Description
Double

Type Parameters

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

Remarks

MarginalEstimator<TDist, TAcc>(TDist, TAcc)

Update the buffer marginalEstimator.

Declaration

public static TAcc MarginalEstimator<TDist, TAcc>(TDist conditional, TAcc marginalEstimator)
    where TAcc : Accumulator<TDist>

Parameters

Type	Name	Description
TDist	conditional	Buffer conditional.
TAcc	marginalEstimator	Buffer marginalEstimator.

Returns

Type	Description
TAcc	New value of buffer marginalEstimator.

Type Parameters

Name	Description
TDist	The type of the distribution over the replicated variable.
TAcc	The type of the marginal estimator.

Remarks

MarginalEstimatorInit<TDist>(TDist, Int32)

Initialize the buffer marginalEstimator.

Declaration

public static BurnInAccumulator<TDist> MarginalEstimatorInit<TDist>(TDist to_marginal, int burnIn)
    where TDist : IDistribution<T>

Parameters

Type	Name	Description
TDist	to_marginal	Previous outgoing message to marginal.
Int32	burnIn	Constant value for burnIn.

Returns

Type	Description
BurnInAccumulator<TDist>	Initial value of buffer marginalEstimator.

Type Parameters

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

Remarks

MarginalGibbs<TDist>(BurnInAccumulator<TDist>, TDist)

Declaration

public static TDist MarginalGibbs<TDist>(BurnInAccumulator<TDist> marginalEstimator, TDist result)

Parameters

Type	Name	Description
BurnInAccumulator<TDist>	marginalEstimator	Buffer marginalEstimator.
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 replicated variable.

Remarks

Sample<TDist>(TDist, TDist)

Update the buffer sample.

Declaration

public static T Sample<TDist>(TDist to_marginal, TDist conditional)
    where TDist : IDistribution<T>, Sampleable<T>

Parameters

Type	Name	Description
TDist	to_marginal	Previous outgoing message to marginal.
TDist	conditional	Buffer conditional.

Returns

Type	Description
T	New value of buffer sample.

Type Parameters

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

Remarks

SampleAcc(T, Accumulator<T>)

Update the buffer sampleAcc.

Declaration

public static Accumulator<T> SampleAcc(T sample, Accumulator<T> sampleAcc)

Parameters

Type	Name	Description
T	sample	Buffer sample.
Accumulator<T>	sampleAcc	Buffer sampleAcc.

Returns

Type	Description
Accumulator<T>	New value of buffer sampleAcc.

Remarks

SampleAccInit(ICollection<T>, Int32, Int32)

Initialize the buffer sampleAcc.

Declaration

public static Accumulator<T> SampleAccInit(ICollection<T> to_samples, int burnIn, int thin)

Parameters

Type	Name	Description
ICollection<T>	to_samples	Previous outgoing message to samples.
Int32	burnIn	Constant value for burnIn.
Int32	thin	Constant value for thin.

Returns

Type	Description
Accumulator<T>	Initial value of buffer sampleAcc.

Remarks

SamplesGibbs<TList>(Accumulator<T>, TList)

Declaration

public static TList SamplesGibbs<TList>(Accumulator<T> sampleAcc, TList result)
    where TList : ICollection<T>

Parameters

Type	Name	Description
Accumulator<T>	sampleAcc	Buffer sampleAcc.
TList	result	Modified to contain the outgoing message.

Returns

Type	Description
TList	result

Type Parameters

Name	Description
TList	The type of the outgoing message.

Remarks

UsesGibbs(T, Int32, T)

Declaration

public static T UsesGibbs(T def, int resultIndex, T result)

Parameters

Type	Name	Description
T	def	Incoming message from Def.
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

Remarks

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

Declaration

public static T UsesGibbs<TDist>(TDist def, T sample, int resultIndex, T result)
    where TDist : IDistribution<T>

Parameters

Type	Name	Description
TDist	def	Incoming message from Def.
T	sample	Buffer sample.
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 replicated 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 replicated variable.

Remarks

UsesGibbsInit<TDist>(TDist, Int32)

Declaration

public static TDist UsesGibbsInit<TDist>(TDist Def, int resultIndex)
    where TDist : ICloneable

Parameters

Type	Name	Description
TDist	Def	Incoming message from Def.
Int32	resultIndex	Index of the Uses for which a message is desired.

Returns

Type	Description
TDist

Type Parameters

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

Remarks