Package org.elasticsearch.search.aggregations.bucket.terms.heuristic

Class MutualInformation

org.elasticsearch.search.aggregations.bucket.terms.heuristic.SignificanceHeuristic

org.elasticsearch.search.aggregations.bucket.terms.heuristic.NXYSignificanceHeuristic

org.elasticsearch.search.aggregations.bucket.terms.heuristic.MutualInformation

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

public class MutualInformation
extends NXYSignificanceHeuristic

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MutualInformation.MutualInformationBuilder

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.bucket.terms.heuristic.NXYSignificanceHeuristic

NXYSignificanceHeuristic.Frequencies, NXYSignificanceHeuristic.NXYBuilder

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static	NAME
static org.elasticsearch.common.xcontent.ConstructingObjectParser<>	PARSER

Fields inherited from class org.elasticsearch.search.aggregations.bucket.terms.heuristic.NXYSignificanceHeuristic

BACKGROUND_IS_SUPERSET, backgroundIsSuperset, INCLUDE_NEGATIVES_FIELD, includeNegatives, SCORE_ERROR_MESSAGE

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MutualInformation(boolean includeNegatives, boolean backgroundIsSuperset)
MutualInformation(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
boolean	other)
double	getScore(long subsetFreq, long subsetSize, long supersetFreq, long supersetSize)	Calculates mutual information see "Information Retrieval", Manning et al., Eq.
	getWriteableName()	Returns the name of the writeable object
int	hashCode()
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)

Methods inherited from class org.elasticsearch.search.aggregations.bucket.terms.heuristic.NXYSignificanceHeuristic

build, buildFromParsedArgs, checkFrequencies, computeNxys, declareParseFields, writeTo

Methods inherited from class org.elasticsearch.search.aggregations.bucket.terms.heuristic.SignificanceHeuristic

checkFrequencyValidity, rewrite, rewrite

Methods inherited from class java.lang.

, , , , , , , ,

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final  NAME

See Also:

Constant Field Values

PARSER

public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<> PARSER

Constructor Details

MutualInformation

public MutualInformation(boolean includeNegatives,
 boolean backgroundIsSuperset)

MutualInformation

public MutualInformation(StreamInput in)
                  throws 

Read from a stream.

Throws:

Method Details

equals

public boolean equals( 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

getWriteableName

public  getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

toXContent

public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws 

Throws: