org.elasticsearch.search.aggregations.bucket.significant.heuristics

Class MutualInformation

java.lang.Object

org.elasticsearch.search.aggregations.bucket.significant.heuristics.SignificanceHeuristic

org.elasticsearch.search.aggregations.bucket.significant.heuristics.NXYSignificanceHeuristic

org.elasticsearch.search.aggregations.bucket.significant.heuristics.MutualInformation

public class MutualInformation
extends NXYSignificanceHeuristic

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MutualInformation.MutualInformationBuilder
static class	MutualInformation.MutualInformationParser

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.bucket.significant.heuristics.NXYSignificanceHeuristic

NXYSignificanceHeuristic.Frequencies, NXYSignificanceHeuristic.NXYBuilder, NXYSignificanceHeuristic.NXYParser

Field Summary

Fields

Modifier and Type	Field and Description
protected static ParseField	NAMES_FIELD
static SignificanceHeuristicStreams.Stream	STREAM

Fields inherited from class org.elasticsearch.search.aggregations.bucket.significant.heuristics.NXYSignificanceHeuristic

BACKGROUND_IS_SUPERSET, backgroundIsSuperset, INCLUDE_NEGATIVES_FIELD, includeNegatives, SCORE_ERROR_MESSAGE

Constructor Summary

Constructors

Constructor and Description
MutualInformation(boolean includeNegatives, boolean backgroundIsSuperset)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
double	getScore(long subsetFreq, long subsetSize, long supersetFreq, long supersetSize) Calculates mutual information see "Information Retrieval", Manning et al., Eq.
int	hashCode()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.search.aggregations.bucket.significant.heuristics.NXYSignificanceHeuristic

checkFrequencies, computeNxys

Methods inherited from class org.elasticsearch.search.aggregations.bucket.significant.heuristics.SignificanceHeuristic

checkFrequencyValidity, initialize

Methods inherited from class java.lang.Object

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

Field Detail

NAMES_FIELD

protected static final ParseField NAMES_FIELD

STREAM

public static final SignificanceHeuristicStreams.Stream STREAM

Constructor Detail

MutualInformation

public MutualInformation(boolean includeNegatives,
                 boolean backgroundIsSuperset)

Method Detail

equals

public boolean equals(Object other)

Overrides:

equals in class NXYSignificanceHeuristic

hashCode

public int hashCode()

Overrides:

hashCode in class NXYSignificanceHeuristic

getScore

public double getScore(long subsetFreq,
              long subsetSize,
              long supersetFreq,
              long supersetSize)

Calculates mutual information see "Information Retrieval", Manning et al., Eq. 13.17

Specified by:

getScore in class SignificanceHeuristic

Parameters:

subsetFreq - The frequency of the term in the selected sample

subsetSize - The size of the selected sample (typically number of docs)

supersetFreq - The frequency of the term in the superset from which the sample was taken

supersetSize - The size of the superset from which the sample was taken (typically number of docs)

Returns:

a "significance" score

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Overrides:

writeTo in class NXYSignificanceHeuristic

Throws:

IOException