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

クラス 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

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	MutualInformation.MutualInformationBuilder
static class	MutualInformation.MutualInformationParser

クラスから継承されたネストされたクラス/インタフェース org.elasticsearch.search.aggregations.bucket.significant.heuristics.NXYSignificanceHeuristic

NXYSignificanceHeuristic.Frequencies, NXYSignificanceHeuristic.NXYBuilder, NXYSignificanceHeuristic.NXYParser

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected static ParseField	NAMES_FIELD
static SignificanceHeuristicStreams.Stream	STREAM

クラスから継承されたフィールド org.elasticsearch.search.aggregations.bucket.significant.heuristics.NXYSignificanceHeuristic

BACKGROUND_IS_SUPERSET, backgroundIsSuperset, INCLUDE_NEGATIVES_FIELD, includeNegatives, SCORE_ERROR_MESSAGE

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
MutualInformation(boolean includeNegatives, boolean backgroundIsSuperset)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	equals(Object other)
double	getScore(long subsetFreq, long subsetSize, long supersetFreq, long supersetSize) Calculates mutual information see "Information Retrieval", Manning et al., Eq. 13.17
int	hashCode()
void	writeTo(StreamOutput out)

クラスから継承されたメソッド org.elasticsearch.search.aggregations.bucket.significant.heuristics.NXYSignificanceHeuristic

checkFrequencies, computeNxys

クラスから継承されたメソッド org.elasticsearch.search.aggregations.bucket.significant.heuristics.SignificanceHeuristic

checkFrequencyValidity, initialize

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

NAMES_FIELD

protected static final ParseField NAMES_FIELD

STREAM

public static final SignificanceHeuristicStreams.Stream STREAM

コンストラクタの詳細

MutualInformation

public MutualInformation(boolean includeNegatives,
                         boolean backgroundIsSuperset)

メソッドの詳細

equals

public boolean equals(Object other)

オーバーライド:

equals クラス内 NXYSignificanceHeuristic

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 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

定義:

getScore クラス内 SignificanceHeuristic

パラメータ:

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)

戻り値:

a "significance" score

writeTo

public void writeTo(StreamOutput out)
             throws IOException

オーバーライド:

writeTo クラス内 NXYSignificanceHeuristic

例外:

IOException