Class GetJaggedItemsOp<T>

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

Inheritance
Object
GetJaggedItemsOp<T>
Inherited Members
Namespace: Microsoft.ML.Probabilistic.Factors
Assembly: Microsoft.ML.Probabilistic.dll
Syntax
[FactorMethod(typeof(Collection), "GetJaggedItems<>", new Type[]{}, Default = true)]
[Quality(QualityBand.Mature)]
[Buffers(new string[]{"marginal"})]
public static class GetJaggedItemsOp<T>
Type Parameters
Name Description
T

The type of an item.

Methods

ArrayAverageConditional<DistributionType, ArrayType>(IList<IList<T>>, IList<IList<Int32>>, ArrayType)

Declaration
public static ArrayType ArrayAverageConditional<DistributionType, ArrayType>([SkipIfAllUniform] IList<IList<T>> items, IList<IList<int>> indices, ArrayType result)
    where DistributionType : HasPoint<T> where ArrayType : IList<DistributionType>, SettableToUniform
Parameters
Type Name Description
IList<IList<T>> items
IList<IList<Int32>> indices
ArrayType result
Returns
Type Description
ArrayType
Type Parameters
Name Description
DistributionType

The type of a distribution over array elements.
ArrayType

The type of the resulting array.

ArrayAverageConditional<ItemType, DistributionType, ArrayType>(IList<ItemType>, IList<IList<Int32>>, ArrayType)

Declaration
public static ArrayType ArrayAverageConditional<ItemType, DistributionType, ArrayType>([SkipIfAllUniform] IList<ItemType> items, IList<IList<int>> indices, ArrayType result)
    where ItemType : IList<DistributionType> where DistributionType : SettableToProduct<DistributionType> where ArrayType : IList<DistributionType>, SettableToUniform
Parameters
Type Name Description
IList<ItemType> items
IList<IList<Int32>> indices
ArrayType result
Returns
Type Description
ArrayType
Type Parameters
Name Description
ItemType

The type of a sub-array.
DistributionType

The type of a distribution over array elements.
ArrayType

The type of the resulting array.

ArrayAverageLogarithm<DistributionType, ArrayType>(IList<IList<T>>, IList<IList<Int32>>, ArrayType)

Declaration
public static ArrayType ArrayAverageLogarithm<DistributionType, ArrayType>(IList<IList<T>> items, IList<IList<int>> indices, ArrayType result)
    where DistributionType : HasPoint<T> where ArrayType : IList<DistributionType>, SettableToUniform
Parameters
Type Name Description
IList<IList<T>> items
IList<IList<Int32>> indices
ArrayType result
Returns
Type Description
ArrayType
Type Parameters
Name Description
DistributionType

The type of a distribution over array elements.
ArrayType

The type of the resulting array.

ArrayAverageLogarithm<ItemType, DistributionType, ArrayType>(IList<ItemType>, IList<IList<Int32>>, ArrayType)

Declaration
public static ArrayType ArrayAverageLogarithm<ItemType, DistributionType, ArrayType>([SkipIfAllUniform] IList<ItemType> items, IList<IList<int>> indices, ArrayType result)
    where ItemType : IList<DistributionType> where DistributionType : SettableToUniform, SettableToProduct<DistributionType> where ArrayType : IList<DistributionType>, SettableToUniform
Parameters
Type Name Description
IList<ItemType> items
IList<IList<Int32>> indices
ArrayType result
Returns
Type Description
ArrayType
Type Parameters
Name Description
ItemType

The type of a sub-array.
DistributionType

The type of a distribution over array elements.
ArrayType

The type of the resulting array.

AverageLogFactor(IList<IList<T>>, IList<T>, IList<IList<Int32>>)

Declaration
public static double AverageLogFactor(IList<IList<T>> items, IList<T> array, IList<IList<int>> indices)
Parameters
Type Name Description
IList<IList<T>> items
IList<T> array
IList<IList<Int32>> indices
Returns
Type Description
Double

AverageLogFactor<DistributionType>(IList<IList<T>>, IList<DistributionType>)

Declaration
public static double AverageLogFactor<DistributionType>(IList<IList<T>> items, IList<DistributionType> array)
    where DistributionType : HasPoint<T>, CanGetLogProb<T>
Parameters
Type Name Description
IList<IList<T>> items
IList<DistributionType> array
Returns
Type Description
Double
Type Parameters
Name Description
DistributionType

The type of a distribution over array elements.

AverageLogFactor<ItemType, DistributionType>(IList<ItemType>, IList<DistributionType>)

Declaration
public static double AverageLogFactor<ItemType, DistributionType>(IList<ItemType> items, IList<DistributionType> array)
    where ItemType : IList<DistributionType> where DistributionType : SettableToProduct<DistributionType>, CanGetLogAverageOf<DistributionType>
Parameters
Type Name Description
IList<ItemType> items
IList<DistributionType> array
Returns
Type Description
Double
Type Parameters
Name Description
ItemType

The type of a sub-array.
DistributionType

The type of a distribution over array elements.

AverageLogFactor<ItemType, DistributionType>(IList<ItemType>, IList<T>)

Declaration
public static double AverageLogFactor<ItemType, DistributionType>(IList<ItemType> items, IList<T> array)
    where ItemType : IList<DistributionType> where DistributionType : CanGetLogProb<T>
Parameters
Type Name Description
IList<ItemType> items
IList<T> array
Returns
Type Description
Double
Type Parameters
Name Description
ItemType

The type of a sub-array.
DistributionType

The type of a distribution over array elements.

ItemsAverageConditional<ArrayType, ItemType, DistributionType>(ItemType, ArrayType, ArrayType, IList<IList<Int32>>, Int32, ItemType)

Declaration
public static ItemType ItemsAverageConditional<ArrayType, ItemType, DistributionType>(ItemType items, ArrayType array, [SkipIfAllUniform] ArrayType marginal, IList<IList<int>> indices, int resultIndex, ItemType result)
    where ArrayType : IList<DistributionType> where ItemType : IList<DistributionType> where DistributionType : SettableToRatio<DistributionType>
Parameters
Type Name Description
ItemType items
ArrayType array
ArrayType marginal
IList<IList<Int32>> indices
Int32 resultIndex
ItemType result
Returns
Type Description
ItemType
Type Parameters
Name Description
ArrayType

The type of an array for the marginal.
ItemType

The type of a sub-array.
DistributionType

The type of a distribution over array elements.

ItemsAverageLogarithm<ItemType, DistributionType>(IList<DistributionType>, IList<IList<Int32>>, Int32, ItemType)

Declaration
public static ItemType ItemsAverageLogarithm<ItemType, DistributionType>([SkipIfAllUniform] IList<DistributionType> array, IList<IList<int>> indices, int resultIndex, ItemType result)
    where ItemType : IList<DistributionType> where DistributionType : SettableTo<DistributionType>
Parameters
Type Name Description
IList<DistributionType> array
IList<IList<Int32>> indices
Int32 resultIndex
ItemType result
Returns
Type Description
ItemType
Type Parameters
Name Description
ItemType

The type of a sub-array.
DistributionType

The type of a distribution over array elements.

LogAverageFactor(IList<IList<T>>, IList<T>, IList<IList<Int32>>)

Declaration
public static double LogAverageFactor(IList<IList<T>> items, IList<T> array, IList<IList<int>> indices)
Parameters
Type Name Description
IList<IList<T>> items
IList<T> array
IList<IList<Int32>> indices
Returns
Type Description
Double

LogAverageFactor<DistributionType>(IList<IList<T>>, IList<DistributionType>, IList<IList<Int32>>)

Declaration
public static double LogAverageFactor<DistributionType>(IList<IList<T>> items, IList<DistributionType> array, IList<IList<int>> indices)
    where DistributionType : HasPoint<T>, CanGetLogProb<T>
Parameters
Type Name Description
IList<IList<T>> items
IList<DistributionType> array
IList<IList<Int32>> indices
Returns
Type Description
Double
Type Parameters
Name Description
DistributionType

The type of a distribution over array elements.

LogAverageFactor<ItemType, DistributionType>(IList<ItemType>, IList<DistributionType>, IList<IList<Int32>>)

Declaration
public static double LogAverageFactor<ItemType, DistributionType>(IList<ItemType> items, IList<DistributionType> array, IList<IList<int>> indices)
    where ItemType : IList<DistributionType> where DistributionType : IDistribution<T>, SettableToProduct<DistributionType>, CanGetLogAverageOf<DistributionType>
Parameters
Type Name Description
IList<ItemType> items
IList<DistributionType> array
IList<IList<Int32>> indices
Returns
Type Description
Double
Type Parameters
Name Description
ItemType

The type of a sub-array.
DistributionType

The type of a distribution over array elements.

LogAverageFactor<ItemType, DistributionType>(IList<ItemType>, IList<T>, IList<IList<Int32>>)

Declaration
public static double LogAverageFactor<ItemType, DistributionType>(IList<ItemType> items, IList<T> array, IList<IList<int>> indices)
    where ItemType : IList<DistributionType> where DistributionType : CanGetLogProb<T>
Parameters
Type Name Description
IList<ItemType> items
IList<T> array
IList<IList<Int32>> indices
Returns
Type Description
Double
Type Parameters
Name Description
ItemType

The type of a sub-array.
DistributionType

The type of a distribution over array elements.

LogEvidenceRatio(IList<IList<T>>, IList<T>, IList<IList<Int32>>)

Declaration
public static double LogEvidenceRatio(IList<IList<T>> items, IList<T> array, IList<IList<int>> indices)
Parameters
Type Name Description
IList<IList<T>> items
IList<T> array
IList<IList<Int32>> indices
Returns
Type Description
Double

LogEvidenceRatio<DistributionType>(IList<IList<T>>, IList<DistributionType>, IList<IList<Int32>>)

Declaration
public static double LogEvidenceRatio<DistributionType>(IList<IList<T>> items, IList<DistributionType> array, IList<IList<int>> indices)
    where DistributionType : HasPoint<T>, CanGetLogProb<T>
Parameters
Type Name Description
IList<IList<T>> items
IList<DistributionType> array
IList<IList<Int32>> indices
Returns
Type Description
Double
Type Parameters
Name Description
DistributionType

The type of a distribution over array elements.

LogEvidenceRatio<ItemType, DistributionType>(IList<ItemType>, IList<DistributionType>, IList<IList<Int32>>, IList<ItemType>)

Declaration
public static double LogEvidenceRatio<ItemType, DistributionType>(IList<ItemType> items, IList<DistributionType> array, IList<IList<int>> indices, IList<ItemType> to_items)
    where ItemType : IList<DistributionType> where DistributionType : SettableToUniform, SettableToProduct<DistributionType>, CanGetLogAverageOf<DistributionType>, ICloneable
Parameters
Type Name Description
IList<ItemType> items
IList<DistributionType> array
IList<IList<Int32>> indices
IList<ItemType> to_items
Returns
Type Description
Double
Type Parameters
Name Description
ItemType

The type of a sub-array.
DistributionType

The type of a distribution over array elements.

LogEvidenceRatio<ItemType, DistributionType>(IList<ItemType>, IList<T>, IList<IList<Int32>>)

Declaration
public static double LogEvidenceRatio<ItemType, DistributionType>(IList<ItemType> items, IList<T> array, IList<IList<int>> indices)
    where ItemType : IList<DistributionType> where DistributionType : CanGetLogProb<T>
Parameters
Type Name Description
IList<ItemType> items
IList<T> array
IList<IList<Int32>> indices
Returns
Type Description
Double
Type Parameters
Name Description
ItemType

The type of a sub-array.
DistributionType

The type of a distribution over array elements.

Marginal<ArrayType, DistributionType>(ArrayType, ArrayType, ArrayType)

Declaration
[SkipIfAllUniform(new string[]{"array", "to_array"})]
public static ArrayType Marginal<ArrayType, DistributionType>(ArrayType array, ArrayType to_array, ArrayType result)
    where ArrayType : IList<DistributionType>, SettableTo<ArrayType> where DistributionType : SettableToProduct<DistributionType>
Parameters
Type Name Description
ArrayType array
ArrayType to_array
ArrayType result
Returns
Type Description
ArrayType
Type Parameters
Name Description
ArrayType
DistributionType

MarginalIncrement<ArrayType, ItemType, DistributionType>(ArrayType, ItemType, ItemType, IList<IList<Int32>>, Int32)

Declaration
public static ArrayType MarginalIncrement<ArrayType, ItemType, DistributionType>(ArrayType result, ItemType to_item, ItemType item, IList<IList<int>> indices, int resultIndex)
    where ArrayType : IList<DistributionType>, SettableTo<ArrayType> where ItemType : IList<DistributionType> where DistributionType : SettableToProduct<DistributionType>
Parameters
Type Name Description
ArrayType result
ItemType to_item
ItemType item
IList<IList<Int32>> indices
Int32 resultIndex
Returns
Type Description
ArrayType
Type Parameters
Name Description
ArrayType

The type of an array for the marginal.
ItemType

The type of a sub-array.
DistributionType

The type of a distribution over array elements.

MarginalInit<ArrayType>(ArrayType)

Initialize the buffer marginal.

Declaration
public static ArrayType MarginalInit<ArrayType>(ArrayType array)
    where ArrayType : ICloneable
Parameters
Type Name Description
ArrayType array

Incoming message from array. Must be a proper distribution. If any element is uniform, the result will be uniform.
Returns
Type Description
ArrayType

Initial value of buffer marginal.
Type Parameters
Name Description
ArrayType

The type of an array for the marginal.
Remarks

Exceptions
Type Condition
ImproperMessageException

array is not a proper distribution.