Class BasicModel

    • Constructor Summary

      Constructors 
      Constructor Description
      BasicModel()
      Sole constructor.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      Explanation explain​(BasicStats stats, float tfn)
      Returns an explanation for the score.
      abstract float score​(BasicStats stats, float tfn)
      Returns the informative content score.
      abstract java.lang.String toString()
      Subclasses must override this method to return the code of the basic model formula.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • BasicModel

        public BasicModel()
        Sole constructor. (For invocation by subclass constructors, typically implicit.)
    • Method Detail

      • score

        public abstract float score​(BasicStats stats,
                                    float tfn)
        Returns the informative content score.
      • explain

        public Explanation explain​(BasicStats stats,
                                   float tfn)
        Returns an explanation for the score.

        Most basic models use the number of documents and the total term frequency to compute Inf1. This method provides a generic explanation for such models. Subclasses that use other statistics must override this method.

      • toString

        public abstract java.lang.String toString()
        Subclasses must override this method to return the code of the basic model formula. Refer to the original paper for the list.
        Overrides:
        toString in class java.lang.Object