Class SumOp2

Provides outgoing messages for Sum(IList<Double>), given random arguments to the function.

Inheritance

Object

SumOp2

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), "Sum", new Type[]{typeof(double[])}, Default = false)]
[Quality(QualityBand.Experimental)]
public static class SumOp2

Methods

ArrayAverageConditional(Gaussian, Gaussian, IList<Gaussian>, Int32)

EP message to array.

Declaration

public static Gaussian ArrayAverageConditional(Gaussian sum, Gaussian to_sum, IList<Gaussian> array, int resultIndex)

Parameters

Type	Name	Description
Gaussian	sum	Incoming message from `sum`. Must be a proper distribution. If uniform, the result will be uniform.
Gaussian	to_sum	Outgoing message to `sum`.
IList<Gaussian>	array	Incoming message from `array`. Must be a proper distribution. If the element at resultIndex is uniform, the result will be uniform.
Int32	resultIndex	Index of the `array` for which a message is desired.

Returns

Type	Description
Gaussian	The outgoing EP message to the `array` argument.

Remarks

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

Exceptions

Type	Condition
ImproperMessageException	`sum` is not a proper distribution.
ImproperMessageException	`array` is not a proper distribution.

ArrayAverageConditional(Double, IList<Gaussian>, Int32)

EP message to array.

Declaration

public static Gaussian ArrayAverageConditional(double sum, IList<Gaussian> array, int resultIndex)

Parameters

Type	Name	Description
Double	sum	Constant value for `sum`.
IList<Gaussian>	array	Incoming message from `array`. Must be a proper distribution. If the element at resultIndex is uniform, the result will be uniform.
Int32	resultIndex	Index of the `array` for which a message is desired.

Returns

Type	Description
Gaussian	The outgoing EP message to the `array` argument.

Remarks

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

Exceptions

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

ArrayAverageLogarithm(Gaussian, Gaussian, IList<Gaussian>, Int32)

VMP message to array.

Declaration

public static Gaussian ArrayAverageLogarithm(Gaussian sum, Gaussian to_sum, IList<Gaussian> array, int resultIndex)

Parameters

Type	Name	Description
Gaussian	sum	Incoming message from `sum`. Must be a proper distribution. If uniform, the result will be uniform.
Gaussian	to_sum	Outgoing message to `sum`.
IList<Gaussian>	array	Incoming message from `array`. Must be a proper distribution. If the element at resultIndex is uniform, the result will be uniform.
Int32	resultIndex	Index of the `array` for which a message is desired.

Returns

Type	Description
Gaussian	The outgoing VMP message to the `array` argument.

Remarks

The outgoing message is the factor viewed as a function of array with sum integrated out. The formula is sum_sum p(sum) factor(sum,array).

Exceptions

Type	Condition
ImproperMessageException	`sum` is not a proper distribution.
ImproperMessageException	`array` is not a proper distribution.