Class GetItemsFromDeepJaggedOp<T>

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

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

The type of an item.

Methods

ArrayAverageConditional<ArrayType, DistributionArrayArrayType, DistributionArrayType, DistributionType>(IList<DistributionType>, IList<Int32>, IList<Int32>, IList<Int32>, ArrayType)

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

The type of the resulting array.
DistributionArrayArrayType

The type of a distribution over depth 1 array elements.
DistributionArrayType

The type of a distribution over depth 2 array elements.
DistributionType

The type of a distribution over depth 3 array elements.

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

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

The type of the resulting array.
DistributionArrayArrayType

The type of a distribution over depth 1 array elements.
DistributionArrayType

The type of a distribution over depth 2 array elements.
DistributionType

The type of a distribution over depth 3 array elements.

ArrayAverageLogarithm<DistributionArrayArrayType, DistributionArrayType, DistributionType, ArrayType>(IList<DistributionType>, IList<Int32>, IList<Int32>, IList<Int32>, ArrayType)

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

The type of a distribution over depth 1 array elements.
DistributionArrayType

The type of a distribution over depth 2 array elements.
DistributionType

The type of a distribution over depth 3 array elements.
ArrayType

The type of the resulting array.

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

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

The type of the resulting array.
DistributionArrayArrayType

The type of a distribution over depth 1 array elements.
DistributionArrayType

The type of a distribution over depth 2 array elements.
DistributionType

The type of a distribution over depth 3 array elements.

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

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

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

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

The type of a distribution over array elements.

AverageLogFactor<DistributionArrayArrayType, DistributionArrayType, DistributionType>(IList<DistributionType>, IList<DistributionArrayType>, IList<Int32>, IList<Int32>, IList<Int32>)

Declaration
public static double AverageLogFactor<DistributionArrayArrayType, DistributionArrayType, DistributionType>(IList<DistributionType> items, IList<DistributionArrayType> array, IList<int> indices, IList<int> indices2, IList<int> indices3)
    where DistributionArrayArrayType : IList<DistributionArrayType> where DistributionArrayType : IList<DistributionType> where DistributionType : SettableToProduct<DistributionType>, CanGetLogAverageOf<DistributionType>
Parameters
Type Name Description
IList<DistributionType> items
IList<DistributionArrayType> array
IList<Int32> indices
IList<Int32> indices2
IList<Int32> indices3
Returns
Type Description
Double
Type Parameters
Name Description
DistributionArrayArrayType

The type of a distribution over depth 1 array elements.
DistributionArrayType

The type of a distribution over depth 2 array elements.
DistributionType

The type of a distribution over depth 3 array elements.

AverageLogFactor<DistributionArrayArrayType, DistributionArrayType, DistributionType>(IList<T>, IList<DistributionArrayType>, IList<Int32>, IList<Int32>, IList<Int32>)

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

The type of a distribution over depth 1 array elements.
DistributionArrayType

The type of a distribution over depth 2 array elements.
DistributionType

The type of a distribution over depth 3 array elements.

ItemsAverageConditional<ArrayType, DistributionArrayArrayType, DistributionArrayType, DistributionType>(DistributionType, ArrayType, ArrayType, IList<Int32>, IList<Int32>, IList<Int32>, Int32, DistributionType)

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

The type of an array for the marginal.
DistributionArrayArrayType

The type of a distribution over depth 1 array elements.
DistributionArrayType

The type of a distribution over depth 2 array elements.
DistributionType

The type of a distribution over depth 3 array elements.

ItemsAverageLogarithm<DistributionArrayArrayType, DistributionArrayType, DistributionType>(IList<DistributionArrayArrayType>, IList<Int32>, IList<Int32>, IList<Int32>, Int32, DistributionType)

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

The type of a distribution over depth 1 array elements.
DistributionArrayType

The type of a distribution over depth 2 array elements.
DistributionType

The type of a distribution over depth 3 array elements.

ItemsAverageLogarithmInit<TDist>(IList<IList<DistributionRefArray<TDist, T>>>, IList<Int32>, IList<Int32>, IList<Int32>)

Declaration
public static DistributionRefArray<TDist, T> ItemsAverageLogarithmInit<TDist>(IList<IList<DistributionRefArray<TDist, T>>> array, IList<int> indices, IList<int> indices2, IList<int> indices3)
    where TDist : class, SettableTo<TDist>, SettableToProduct<TDist>, SettableToRatio<TDist>, SettableToPower<TDist>, SettableToWeightedSum<TDist>, CanGetLogAverageOf<TDist>, CanGetLogAverageOfPower<TDist>, CanGetAverageLog<TDist>, IDistribution<T>, Sampleable<T>
Parameters
Type Name Description
IList<IList<DistributionRefArray<TDist, T>>> array
IList<Int32> indices
IList<Int32> indices2
IList<Int32> indices3
Returns
Type Description
DistributionRefArray<TDist, T>
Type Parameters
Name Description
TDist

The type of a distribution over array elements.

ItemsAverageLogarithmInit<TDist>(IList<IList<DistributionStructArray<TDist, T>>>, IList<Int32>, IList<Int32>, IList<Int32>)

Declaration
public static DistributionStructArray<TDist, T> ItemsAverageLogarithmInit<TDist>(IList<IList<DistributionStructArray<TDist, T>>> array, IList<int> indices, IList<int> indices2, IList<int> indices3)
    where TDist : struct, SettableToProduct<TDist>, SettableToRatio<TDist>, SettableToPower<TDist>, SettableToWeightedSum<TDist>, CanGetLogAverageOf<TDist>, CanGetLogAverageOfPower<TDist>, CanGetAverageLog<TDist>, IDistribution<T>, Sampleable<T>
Parameters
Type Name Description
IList<IList<DistributionStructArray<TDist, T>>> array
IList<Int32> indices
IList<Int32> indices2
IList<Int32> indices3
Returns
Type Description
DistributionStructArray<TDist, T>
Type Parameters
Name Description
TDist

The type of a distribution over array elements.

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

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

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

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

The type of a distribution over array elements.

LogAverageFactor<DistributionArrayArrayType, DistributionArrayType, DistributionType>(IList<DistributionType>, IList<DistributionArrayArrayType>, IList<Int32>, IList<Int32>, IList<Int32>)

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

The type of a distribution over depth 1 array elements.
DistributionArrayType

The type of a distribution over depth 2 array elements.
DistributionType

The type of a distribution over depth 3 array elements.

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

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

The type of a distribution over depth 1 array elements.
DistributionArrayType

The type of a distribution over depth 2 array elements.
DistributionType

The type of a distribution over depth 3 array elements.

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

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

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

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

The type of a distribution over array elements.

LogEvidenceRatio<DistributionArrayArrayType, DistributionArrayType, DistributionType>(IList<DistributionType>, IList<DistributionArrayArrayType>, IList<Int32>, IList<Int32>, IList<Int32>, IList<DistributionType>)

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

The type of a distribution over depth 1 array elements.
DistributionArrayType

The type of a distribution over depth 2 array elements.
DistributionType

The type of a distribution over depth 3 array elements.

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

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

The type of a distribution over depth 1 array elements.
DistributionArrayType

The type of a distribution over depth 2 array elements.
DistributionType

The type of a distribution over depth 3 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, DistributionArrayArrayType, DistributionArrayType, DistributionType>(ArrayType, DistributionType, DistributionType, IList<Int32>, IList<Int32>, IList<Int32>, Int32)

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

The type of an array for the marginal.
DistributionArrayArrayType

The type of a distribution over depth 1 array elements.
DistributionArrayType

The type of a distribution over depth 2 array elements.
DistributionType

The type of a distribution over depth 3 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.