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

Class GND

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.GND

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment

public class GND
extends NXYSignificanceHeuristic

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GND.GNDBuilder

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

NXYSignificanceHeuristic.Frequencies, NXYSignificanceHeuristic.NXYBuilder, NXYSignificanceHeuristic.NXYParser

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

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

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME
static SignificanceHeuristicParser	PARSER

Fields inherited from class org.elasticsearch.search.aggregations.bucket.significant.heuristics.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 and Description
GND(boolean backgroundIsSuperset)
GND(StreamInput in) Read from a stream.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
double	getScore(long subsetFreq, long subsetSize, long supersetFreq, long supersetSize) Calculates Google Normalized Distance, as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007 link: http://arxiv.org/pdf/cs/0412098v3.pdf
java.lang.String	getWriteableName() Returns the name of the writeable object
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this into the StreamOutput.

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

build, checkFrequencies, computeNxys

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

checkFrequencyValidity, rewrite, rewrite

Methods inherited from class java.lang.Object

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

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

isFragment

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

PARSER

public static final SignificanceHeuristicParser PARSER

Constructor Detail

GND

public GND(boolean backgroundIsSuperset)

GND

public GND(StreamInput in)
    throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class NXYSignificanceHeuristic

Throws:

java.io.IOException

equals

public boolean equals(java.lang.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 Google Normalized Distance, as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007 link: http://arxiv.org/pdf/cs/0412098v3.pdf

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 java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Throws:

java.io.IOException