Class DiceCoefficient

DiceCoefficient algorithm. The DiceCoefficient algorithm is a method for finding the similarity between two strings.

See

https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient

Implements

AlgorithmBase

Index

Constructors

Properties

Methods

diceCoefficientAlgorithm differences distance

Constructors

constructor

new DiceCoefficient(options?): DiceCoefficient
Parameters
- options: AlgorithmOptions = ...
Returns DiceCoefficient
- Defined in algorithms/dice-coefficient.ts:13

Properties

`Private` options

options: AlgorithmOptions = ...

Methods

`Private` diceCoefficientAlgorithm

diceCoefficientAlgorithm(startText, endText): number
Calculate the similarity between two strings.
Parameters
- startText: string
  The initial string.
- endText: string
  The resulting string.
Returns number
a number between 0 and 1 that represents the similarity between two strings.
- Defined in algorithms/dice-coefficient.ts:46

differences

differences(startText, endText): Operation[]
The method is not supported for this algorithm.
Parameters
- startText: string
  The initial string.
- endText: string
  The resulting string.
Returns Operation[]
an exception because this algorithm doesn't have support for the method.
Implementation of AlgorithmBase.differences
- Defined in algorithms/dice-coefficient.ts:22

distance

distance(startText, endText): number
Calculate the similarity between two strings.
Parameters
- startText: string
  The initial string.
- endText: string
  The resulting string.
Returns number
a number between 0 and 1 that represents the similarity between two strings.
Implementation of AlgorithmBase.distance
- Defined in algorithms/dice-coefficient.ts:32