Class MutualInformation

    • Constructor Detail

      • MutualInformation

        public MutualInformation​(boolean includeNegatives,
                                 boolean backgroundIsSuperset)
      • MutualInformation

        public MutualInformation​(StreamInput in)
                          throws java.io.IOException
        Read from a stream.
        Throws:
        java.io.IOException
    • Method Detail

      • 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 java.lang.String getWriteableName()
        Description copied from interface: NamedWriteable
        Returns the name of the writeable object