This class encapsulates all the information about the similarity values computed using a similarity function for all the cases in a casebase It contains information that describes the similarity function employed to copmpute the similarity data. The similarity values are stored in two different ways:

  • A list of pairs of cases with detailed similarity values (global and local similarity values)
  • A matrix of global similarity values

Constructors

Properties

similarityConfiguration: SimilarityConfiguration

A detailed description about the similarity function employed to computed the similarity data

similarityMatrix?: number[][]

A matrix of global similarity values. This attribute is optional because it is commonly created during the construction

similarityScores: {
    [key: string]: EntrySimilarityValue;
}

A list of pairs of cases with detailed similarity values (global and local similarity values)

Methods

  • Return the similarity value of a pair of cases (id1, id2). The similarity values is returned as an object with detailed information about global and local similarity between cases

    Parameters

    • id1: string

      The unique identifier of a case

    • id2: string

      The unique identifier of a case

    Returns null | SimilarityValue

    A similarity value object; or null if any case does not exist.