com.github.vickumar1981.stringdistance.StringDistance.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of stringdistance_2.12 Show documentation
A fuzzy matching string distance library for Scala and Java.
The newest version!
package com.github.vickumar1981.stringdistance

import com.github.vickumar1981.stringdistance.impl._
import com.github.vickumar1981.stringdistance.interfaces.NGramTokenizer

/**
 * Main class to organize functionality of different string distance algorithms
 *
 * {{{
 * import com.github.vickumar1981.stringdistance.StringDistance._
 * import com.github.vickumar1981.stringdistance.impl.{ConstantGap, LinearGap}
 *
 * // Scores between strings
 * val cosSimilarity: Double = Cosine.score("hello", "chello")
 * val damerau: Double = Damerau.score("martha", "marhta")
 * val diceCoefficient: Double = DiceCoefficient.score("martha", "marhta")
 * val hamming: Double = Hamming.score("martha", "marhta")
 * val jaccard: Double = Jaccard.score("karolin", "kathrin", 1)
 * val jaro: Double = Jaro.score("martha", "marhta")
 * val jaroWinkler: Double = JaroWinkler.score("martha", "marhta", 0.1)
 * val levenshtein: Double = Levenshtein.score("martha", "marhta")
 * val needlemanWunsch: Double = NeedlemanWunsch.score("martha", "marhta", ConstantGap())
 * val ngramSimilarity: Double = NGram.score("karolin", "kathrin", 1)
 * val bigramSimilarity: Double = NGram.score("karolin", "kathrin", 2)
 * val overlap: Double = Overlap.score("karolin", "kathrin", 1)
 * val smithWaterman: Double = SmithWaterman.score("martha", "marhta", (LinearGap(gapValue = -1), Integer.MAX_VALUE))
 * val smithWatermanGotoh: Double = SmithWatermanGotoh.score("martha", "marhta", ConstantGap())
 * val tversky: Double = Tversky.score("karolin", "kathrin", 0.5)
 *
 * // Distances between strings
 * val damerauDist: Int = Damerau.distance("martha", "marhta")
 * val hammingDist: Int = Hamming.distance("martha", "marhta")
 * val levenshteinDist: Int = Levenshtein.distance("martha", "marhta")
 * val longestCommonSubSeq: Int = LongestCommonSeq.distance("martha", "marhta")
 * val ngramDist: Int = NGram.distance("karolin", "kathrin", 1)
 * val bigramDist: Int = NGram.distance("karolin", "kathrin", 2)
 *
 * // return a List[String] of ngram tokens
 * val tokens = NGram.tokens("martha", 2) // List("ma", "ar", "rt", "th", "ha")
 * }}}
 */
object StringDistance {
  object Cosine extends StringMetric[CosineAlgorithm]
  object Damerau extends StringMetric[DamerauLevenshteinAlgorithm]
  object DiceCoefficient extends StringMetric[DiceCoefficientAlgorithm]
  object Hamming extends StringMetric[HammingAlgorithm]
  object Jaccard extends WeightedStringMetric[JaccardAlgorithm, Int]
  object Jaro extends StringMetric[JaroAlgorithm]
  object JaroWinkler extends WeightedStringMetric[JaroWinklerAlgorithm, Double]
  object Levenshtein extends StringMetric[LevenshteinAlgorithm]
  object LongestCommonSeq extends StringMetric[LongestCommonSeqAlorithm]
  object NeedlemanWunsch extends WeightedStringMetric[NeedlemanWunschAlgorithm, ConstantGap]
  object NGram extends WeightedStringMetric[NGramAlgorithm, Int] with NGramTokenizer {
    def tokens(s: String, n: Int): List[String] = tokenizeNGram(s.toCharArray, n).map(_.mkString)
  }
  object Overlap extends WeightedStringMetric[OverlapAlgorithm, Int]
  object SmithWaterman extends WeightedStringMetric[SmithWatermanAlgorithm, (Gap, Int)]
  object SmithWatermanGotoh extends WeightedStringMetric[SmithWatermanGotohAlgorithm, ConstantGap]
  object Tversky extends WeightedStringMetric[TverskyAlgorithm, Double]
}

private[stringdistance] class CosineSimilarityImplWrapper extends CosSimilarityImpl
private[stringdistance] class DiceCoefficientImplWrapper extends DiceCoefficientImpl
private[stringdistance] class HammingImplWrapper extends HammingImpl
private[stringdistance] class JaccardImplWrapper extends JaccardImpl
private[stringdistance] class JaroImplWrapper extends JaroImpl
private[stringdistance] class LevenshteinDistanceImplWrapper extends LevenshteinDistanceImpl
private[stringdistance] class LongestCommonSeqWrapper extends LongestCommonSeqImpl
private[stringdistance] class NeedlemanWunschImplWrapper extends NeedlemanWunschImpl
private[stringdistance] class NGramImplWrapper extends NGramImpl
private[stringdistance] class OverlapImplWrapper extends OverlapImpl
private[stringdistance] class SmithWatermanImplWrapper extends SmithWatermanImpl