Interface Scorer

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      double getDistance()
      Returns score as a distance between 0.0 and 1.0.
      double getDistance​(double scale)
      Returns score as a distance between 0.0 and scale.
      double getMaxScore()
      Returns maximum possible score.
      double getMinScore()
      Returns minimum possible score.
      double getScore()
      Returns score resulting from algorithm.
      double getSimilarity()
      Returns score as a similarity between 0.0 and 1.0.
      double getSimilarity​(double scale)
      Returns score as a similarity between 0.0 and scale.
    • Method Detail

      • getDistance

        double getDistance​(double scale)
        Returns score as a distance between 0.0 and scale. This equals scale * (getMaxScore() - getScore()) / (getMaxScore() - getMinScore()).
        Parameters:
        scale - maximum distance
        Returns:
        score as a distance between 0.0 and scale
      • getMaxScore

        double getMaxScore()
        Returns maximum possible score.
        Returns:
        maximum possible score
      • getMinScore

        double getMinScore()
        Returns minimum possible score.
        Returns:
        minimum possible score
      • getSimilarity

        double getSimilarity​(double scale)
        Returns score as a similarity between 0.0 and scale. This equals scale * (getScore() - getMinScore()) / (getMaxScore() - getMinScore()).
        Parameters:
        scale - maximum similarity
        Returns:
        score as a similarity between 0.0 and scale