org.tribuo.util.infotheory.impl

Class WeightedPairDistribution<T1,T2>

java.lang.Object

org.tribuo.util.infotheory.impl.WeightedPairDistribution<T1,T2>

Type Parameters:

T1 - Type of the first list.

T2 - Type of the second list.

public class WeightedPairDistribution<T1,T2>
extends Object

Generates the counts for a pair of vectors. Contains the joint count and the two marginal counts.

Field Summary

Fields

Modifier and Type	Field and Description
long	count

Constructor Summary

Constructors

Constructor and Description
WeightedPairDistribution(long count, LinkedHashMap<CachedPair<T1,T2>,WeightCountTuple> jointCounts, LinkedHashMap<T1,WeightCountTuple> firstCount, LinkedHashMap<T2,WeightCountTuple> secondCount)
WeightedPairDistribution(long count, Map<CachedPair<T1,T2>,WeightCountTuple> jointCounts, Map<T1,WeightCountTuple> firstCount, Map<T2,WeightCountTuple> secondCount)

Method Summary

Modifier and Type	Method and Description
static <T1,T2> WeightedPairDistribution<T1,T2>	constructFromLists(List<T1> first, List<T2> second, List<Double> weights) Generates the counts for two vectors.
static <T1,T2> WeightedPairDistribution<T1,T2>	constructFromMap(Map<CachedPair<T1,T2>,WeightCountTuple> jointCount) Generates a WeightedPairDistribution by generating the marginal distributions for the first and second elements.
Map<T1,WeightCountTuple>	getFirstCount()
Map<CachedPair<T1,T2>,WeightCountTuple>	getJointCounts()
Map<T2,WeightCountTuple>	getSecondCount()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

count

public final long count

Constructor Detail

WeightedPairDistribution

public WeightedPairDistribution(long count,
                                Map<CachedPair<T1,T2>,WeightCountTuple> jointCounts,
                                Map<T1,WeightCountTuple> firstCount,
                                Map<T2,WeightCountTuple> secondCount)

WeightedPairDistribution

public WeightedPairDistribution(long count,
                                LinkedHashMap<CachedPair<T1,T2>,WeightCountTuple> jointCounts,
                                LinkedHashMap<T1,WeightCountTuple> firstCount,
                                LinkedHashMap<T2,WeightCountTuple> secondCount)

Method Detail

getJointCounts

public Map<CachedPair<T1,T2>,WeightCountTuple> getJointCounts()

getFirstCount

public Map<T1,WeightCountTuple> getFirstCount()

getSecondCount

public Map<T2,WeightCountTuple> getSecondCount()

constructFromLists

public static <T1,T2> WeightedPairDistribution<T1,T2> constructFromLists(List<T1> first,
                                                                         List<T2> second,
                                                                         List<Double> weights)

Generates the counts for two vectors. Returns a pair containing the joint count, and a pair of the two marginal counts.

Type Parameters:

T1 - Type of the first list.

T2 - Type of the second list.

Parameters:

first - An list of values.

second - Another list of values.

weights - An list of per example weights.

Returns:

A WeightedPairDistribution.

constructFromMap

public static <T1,T2> WeightedPairDistribution<T1,T2> constructFromMap(Map<CachedPair<T1,T2>,WeightCountTuple> jointCount)

Generates a WeightedPairDistribution by generating the marginal distributions for the first and second elements. This assumes the weights have already been normalised.

Type Parameters:

T1 - Type of the first element.

T2 - Type of the second element.

Parameters:

jointCount - The (normalised) input map.

Returns:

A WeightedPairDistribution