Class GetItemsFromJaggedOp<T>

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

Inheritance

Object

GetItemsFromJaggedOp<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(Collection), "GetItemsFromJagged<>", new Type[]{}, Default = true)]
[Quality(QualityBand.Mature)]
[Buffers(new string[]{"marginal"})]
public static class GetItemsFromJaggedOp<T>

Type Parameters

Name	Description
T	The type of an item.

Methods

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

Declaration

public static ArrayType ArrayAverageConditional<ArrayType, DistributionArrayType, DistributionType>([SkipIfAllUniform] IList<DistributionType> items, IList<int> indices, IList<int> indices2, ArrayType result)
    where ArrayType : IList<DistributionArrayType>, SettableToUniform where DistributionArrayType : IList<DistributionType> where DistributionType : SettableToProduct<DistributionType>

Parameters

Type	Name	Description
IList<DistributionType>	items
IList<Int32>	indices
IList<Int32>	indices2
ArrayType	result

Returns

Type	Description
ArrayType

Type Parameters

Name	Description
ArrayType	The type of the resulting array.
DistributionArrayType	The type of a distribution over array elements.
DistributionType	The type of a distribution over inner array elements.

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

Declaration

public static ArrayType ArrayAverageConditional<ArrayType, DistributionArrayType, DistributionType>([SkipIfAllUniform] IList<T> items, IList<int> indices, IList<int> indices2, ArrayType result)
    where ArrayType : IList<DistributionArrayType>, SettableToUniform where DistributionArrayType : IList<DistributionType> where DistributionType : HasPoint<T>

Parameters

Type	Name	Description
IList<T>	items
IList<Int32>	indices
IList<Int32>	indices2
ArrayType	result

Returns

Type	Description
ArrayType

Type Parameters

Name	Description
ArrayType	The type of the resulting array.
DistributionArrayType	The type of a distribution over array elements.
DistributionType	The type of a distribution over inner array elements.

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

Declaration

public static ArrayType ArrayAverageLogarithm<DistributionArrayType, DistributionType, ArrayType>([SkipIfAllUniform] IList<DistributionType> items, IList<int> indices, IList<int> indices2, ArrayType result)
    where DistributionArrayType : IList<DistributionType> where DistributionType : SettableToUniform, SettableToProduct<DistributionType> where ArrayType : IList<DistributionArrayType>, SettableToUniform

Parameters

Type	Name	Description
IList<DistributionType>	items
IList<Int32>	indices
IList<Int32>	indices2
ArrayType	result

Returns

Type	Description
ArrayType

Type Parameters

Name	Description
DistributionArrayType	The type of a distribution over array elements.
DistributionType	The type of a distribution over inner array elements.
ArrayType	The type of the resulting array.

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

Declaration

public static ArrayType ArrayAverageLogarithm<ArrayType, DistributionArrayType, DistributionType>(IList<T> items, IList<int> indices, IList<int> indices2, ArrayType result)
    where ArrayType : IList<DistributionArrayType>, SettableToUniform where DistributionArrayType : IList<DistributionType> where DistributionType : HasPoint<T>

Parameters

Type	Name	Description
IList<T>	items
IList<Int32>	indices
IList<Int32>	indices2
ArrayType	result

Returns

Type	Description
ArrayType

Type Parameters

Name	Description
ArrayType	The type of the resulting array.
DistributionArrayType	The type of a distribution over array elements.
DistributionType	The type of a distribution over inner array elements.

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

Declaration

public static double AverageLogFactor(IList<T> items, IList<IList<T>> array, IList<int> indices, IList<int> indices2)

Parameters

Type	Name	Description
IList<T>	items
IList<IList<T>>	array
IList<Int32>	indices
IList<Int32>	indices2

Returns

Type	Description
Double

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

Declaration

public static double AverageLogFactor<DistributionType>(IList<DistributionType> items, IList<IList<T>> array)
    where DistributionType : CanGetLogProb<T>

Parameters

Type	Name	Description
IList<DistributionType>	items
IList<IList<T>>	array

Returns

Type	Description
Double

Type Parameters

Name	Description
DistributionType	The type of a distribution over array elements.

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

Declaration

public static double AverageLogFactor<DistributionArrayType, DistributionType>(IList<DistributionType> items, IList<DistributionArrayType> array)
    where DistributionArrayType : IList<DistributionType> where DistributionType : SettableToProduct<DistributionType>, CanGetLogAverageOf<DistributionType>

Parameters

Type	Name	Description
IList<DistributionType>	items
IList<DistributionArrayType>	array

Returns

Type	Description
Double

Type Parameters

Name	Description
DistributionArrayType	The type of a distribution over array elements.
DistributionType	The type of a distribution over inner array elements.

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

Declaration

public static double AverageLogFactor<DistributionArrayType, DistributionType>(IList<T> items, IList<DistributionArrayType> array)
    where DistributionArrayType : IList<DistributionType> where DistributionType : HasPoint<T>, CanGetLogProb<T>

Parameters

Type	Name	Description
IList<T>	items
IList<DistributionArrayType>	array

Returns

Type	Description
Double

Type Parameters

Name	Description
DistributionArrayType	The type of a distribution over array elements.
DistributionType	The type of a distribution over inner array elements.

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

Declaration

public static DistributionType ItemsAverageConditional<ArrayType, DistributionArrayType, DistributionType>(DistributionType items, ArrayType array, [SkipIfAllUniform] ArrayType marginal, IList<int> indices, IList<int> indices2, int resultIndex, DistributionType result)
    where ArrayType : 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
Int32	resultIndex
DistributionType	result

Returns

Type	Description
DistributionType

Type Parameters

Name	Description
ArrayType	The type of an array for the marginal.
DistributionArrayType	The type of a distribution over array elements.
DistributionType	The type of a distribution over inner array elements.

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

Declaration

public static DistributionType ItemsAverageLogarithm<DistributionArrayType, DistributionType>([SkipIfAllUniform] IList<DistributionArrayType> array, IList<int> indices, IList<int> indices2, int resultIndex, DistributionType result)
    where DistributionArrayType : IList<DistributionType> where DistributionType : SettableTo<DistributionType>

Parameters

Type	Name	Description
IList<DistributionArrayType>	array
IList<Int32>	indices
IList<Int32>	indices2
Int32	resultIndex
DistributionType	result

Returns

Type	Description
DistributionType

Type Parameters

Name	Description
DistributionArrayType	The type of a distribution over array elements.
DistributionType	The type of a distribution over inner array elements.

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

Declaration

public static DistributionRefArray<TDist, T> ItemsAverageLogarithmInit<TDist>(IList<DistributionRefArray<TDist, T>> array, IList<int> indices, IList<int> indices2)
    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<DistributionRefArray<TDist, T>>	array
IList<Int32>	indices
IList<Int32>	indices2

Returns

Type	Description
DistributionRefArray<TDist, T>

Type Parameters

Name	Description
TDist	The type of a distribution over array elements.

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

Declaration

public static DistributionStructArray<TDist, T> ItemsAverageLogarithmInit<TDist>(IList<DistributionStructArray<TDist, T>> array, IList<int> indices, IList<int> indices2)
    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<DistributionStructArray<TDist, T>>	array
IList<Int32>	indices
IList<Int32>	indices2

Returns

Type	Description
DistributionStructArray<TDist, T>

Type Parameters

Name	Description
TDist	The type of a distribution over array elements.

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

Declaration

public static double LogAverageFactor(IList<T> items, IList<IList<T>> array, IList<int> indices, IList<int> indices2)

Parameters

Type	Name	Description
IList<T>	items
IList<IList<T>>	array
IList<Int32>	indices
IList<Int32>	indices2

Returns

Type	Description
Double

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

Declaration

public static double LogAverageFactor<DistributionType>(IList<DistributionType> items, IList<IList<T>> array, IList<int> indices, IList<int> indices2)
    where DistributionType : CanGetLogProb<T>

Parameters

Type	Name	Description
IList<DistributionType>	items
IList<IList<T>>	array
IList<Int32>	indices
IList<Int32>	indices2

Returns

Type	Description
Double

Type Parameters

Name	Description
DistributionType	The type of a distribution over array elements.

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

Declaration

public static double LogAverageFactor<DistributionArrayType, DistributionType>(IList<DistributionType> items, IList<DistributionArrayType> array, IList<int> indices, IList<int> indices2)
    where DistributionArrayType : IList<DistributionType> where DistributionType : IDistribution<T>, SettableToProduct<DistributionType>, CanGetLogAverageOf<DistributionType>

Parameters

Type	Name	Description
IList<DistributionType>	items
IList<DistributionArrayType>	array
IList<Int32>	indices
IList<Int32>	indices2

Returns

Type	Description
Double

Type Parameters

Name	Description
DistributionArrayType	The type of a distribution over array elements.
DistributionType	The type of a distribution over inner array elements.

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

Declaration

public static double LogAverageFactor<DistributionArrayType, DistributionType>(IList<T> items, IList<DistributionArrayType> array, IList<int> indices, IList<int> indices2)
    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

Returns

Type	Description
Double

Type Parameters

Name	Description
DistributionArrayType	The type of a distribution over array elements.
DistributionType	The type of a distribution over inner array elements.

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

Declaration

public static double LogEvidenceRatio(IList<T> items, IList<IList<T>> array, IList<int> indices, IList<int> indices2)

Parameters

Type	Name	Description
IList<T>	items
IList<IList<T>>	array
IList<Int32>	indices
IList<Int32>	indices2

Returns

Type	Description
Double

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

Declaration

public static double LogEvidenceRatio<DistributionType>(IList<DistributionType> items, IList<IList<T>> array, IList<int> indices, IList<int> indices2)
    where DistributionType : CanGetLogProb<T>

Parameters

Type	Name	Description
IList<DistributionType>	items
IList<IList<T>>	array
IList<Int32>	indices
IList<Int32>	indices2

Returns

Type	Description
Double

Type Parameters

Name	Description
DistributionType	The type of a distribution over array elements.

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

Declaration

public static double LogEvidenceRatio<DistributionArrayType, DistributionType>(IList<DistributionType> items, IList<DistributionArrayType> array, IList<int> indices, IList<int> indices2, IList<DistributionType> to_items)
    where DistributionArrayType : IList<DistributionType> where DistributionType : SettableToUniform, SettableToProduct<DistributionType>, CanGetLogAverageOf<DistributionType>, ICloneable

Parameters

Type	Name	Description
IList<DistributionType>	items
IList<DistributionArrayType>	array
IList<Int32>	indices
IList<Int32>	indices2
IList<DistributionType>	to_items

Returns

Type	Description
Double

Type Parameters

Name	Description
DistributionArrayType	The type of a distribution over array elements.
DistributionType	The type of a distribution over inner array elements.

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

Declaration

public static double LogEvidenceRatio<DistributionArrayType, DistributionType>(IList<T> items, IList<DistributionArrayType> array, IList<int> indices, IList<int> indices2)
    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

Returns

Type	Description
Double

Type Parameters

Name	Description
DistributionArrayType	The type of a distribution over array elements.
DistributionType	The type of a distribution over inner 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, DistributionArrayType, DistributionType>(ArrayType, DistributionType, DistributionType, IList<Int32>, IList<Int32>, Int32)

Declaration

public static ArrayType MarginalIncrement<ArrayType, DistributionArrayType, DistributionType>(ArrayType result, DistributionType to_item, DistributionType item, IList<int> indices, IList<int> indices2, int resultIndex)
    where ArrayType : IList<DistributionArrayType>, SettableTo<ArrayType> 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
Int32	resultIndex

Returns

Type	Description
ArrayType

Type Parameters

Name	Description
ArrayType	The type of an array for the marginal.
DistributionArrayType	The type of a distribution over array elements.
DistributionType	The type of a distribution over inner 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.