Interface SMListCorrectness

  • All Superinterfaces:
    SimilarityMeasure, SMCollection
    All Known Implementing Classes:
    SMListCorrectnessImpl

    public interface SMListCorrectness
    extends SMCollection
    The SMListCorrectness uses the CorrectnessMetric to compare the elements of two lists and compute a similarity. It takes the order of the elements in relation to each other into account. If only concordant pairs in both lists exists, the similarity will be computed as 1.0. If there are just as many concordant as discordant pairs, the similarity will be 0.0. In the case, that their are only discordant pairs, a parameter needs to be specified, that indicates, which similarity should be set for this case. Between these limits, the similarity is a linear function.
    Author:
    Alexander Schultheis
    • Field Detail

      • DEFAULT_DISCORDANT_PARAMETER

        static final double DEFAULT_DISCORDANT_PARAMETER
        Default value for discordant values is 1.0.
        See Also:
        Constant Field Values
    • Method Detail

      • setDiscordantParameter

        void setDiscordantParameter​(double discordantParameter)
        Setting a parameter, that specifies, how the similarity is evaluated if there are more discordant than concordant pairs. By default, this parameter is set to 1.0 and decreases linearly. This means that only discordant pairs have a similarity of 1.0. The parameter can be in the interval 1.0 to 0.0.
        Parameters:
        discordantParameter - A double parameter, which specifies the maximum similarity if only discordant pairs exists.
      • getDiscordantParameter

        double getDiscordantParameter()
        Returns the double parameter, which specifies the maximum similarity if only discordant pairs exists.
        Returns:
        A double parameter, which specifies the maximum similarity if only discordant pairs exists.