stringdistance

Type Members

trait CosineAlgorithm extends StringMetricAlgorithm

A marker interface for the cosine similarity algorithm.
class CosineSimilarityImplWrapper extends CosSimilarityImpl

Jave Wrapper for cosine similarity.
trait DamerauLevenshteinAlgorithm extends StringMetricAlgorithm

A marker interface for the damerau levenshtein distance algorithm.
trait DiceCoefficientAlgorithm extends StringMetricAlgorithm

A marker interface for the dice coefficient algorithm.
class DiceCoefficientImplWrapper extends DiceCoefficientImpl

Jave Wrapper for dice coefficient similarity.
trait DistanceAlgorithm[+T <: StringMetricAlgorithm] extends AnyRef

A type class to extend a distance method to StringMetricAlgorithm.
trait HammingAlgorithm extends StringMetricAlgorithm

A marker interface for the hamming distance algorithm.
class HammingImplWrapper extends HammingImpl

Jave Wrapper for hamming distance.
trait JaccardAlgorithm extends StringMetricAlgorithm

A marker interface for a jaccard similarity algorithm.
class JaccardImplWrapper extends JaccardImpl

Jave Wrapper for jaccard similarity.
trait JaroAlgorithm extends StringMetricAlgorithm

A marker interface for the jaro similarity algorithm.
class JaroImplWrapper extends JaroImpl

Jave Wrapper for jaro and jaro winkler similarity.
trait JaroWinklerAlgorithm extends StringMetricAlgorithm

A marker interface for the jaro winkler algorithm.
trait LevenshteinAlgorithm extends StringMetricAlgorithm

A marker interface for the levenshtein distance algorithm.
class LevenshteinDistanceImplWrapper extends LevenshteinDistanceImpl

Jave Wrapper for levenshtein distance.
trait LongestCommonSeqAlorithm extends StringMetricAlgorithm

A marker interface for the longest common subsequence algorithm.
class LongestCommonSeqWrapper extends LongestCommonSeqImpl

Jave Wrapper for longest comment sequence.
trait MetaphoneAlgorithm extends StringMetricAlgorithm

A marker interface for the metaphone algorithm.
class MetaphoneImplWrapper extends MetaphoneImpl

Jave Wrapper for metaphone similarity.
trait NGramAlgorithm extends StringMetricAlgorithm

A marker interface for the n-gram similarity algorithm.
class NGramImplWrapper extends NGramImpl

Jave Wrapper for n-gram similarity.
trait NeedlemanWunschAlgorithm extends StringMetricAlgorithm

A marker interface for the needleman wunsch similarity algorithm.
class NeedlemanWunschImplWrapper extends NeedlemanWunschImpl

Jave Wrapper for needleman wunsch similarity.
trait OverlapAlgorithm extends StringMetricAlgorithm

A marker interface for the overlap similarity algorithm.
class OverlapImplWrapper extends OverlapImpl

Jave Wrapper for overlap similarity.
trait ScorableFromDistance[+T <: StringMetricAlgorithm] extends ScoringAlgorithm[T]

A mix-in trait to extend a score method using the distance method to StringMetricAlgorithm.
trait ScoringAlgorithm[+T <: StringMetricAlgorithm] extends AnyRef

A type class to extend a score method to StringMetricAlgorithm.
trait SmithWatermanAlgorithm extends StringMetricAlgorithm

A marker interface for the smith waterman similarity algorithm.
trait SmithWatermanGotohAlgorithm extends StringMetricAlgorithm

A marker interface for the smith waterman gotoh similarity algorithm.
class SmithWatermanImplWrapper extends SmithWatermanImpl

Jave Wrapper for smith waterman similarity.
trait SoundScoringAlgorithm[+T <: StringMetricAlgorithm] extends AnyRef

A type class to extend a sound score method to StringMetricAlgorithm.
trait SoundexAlgorithm extends StringMetricAlgorithm

A marker interface for the soundex similarity algorithm.
class SoundexImplWrapper extends SoundexImpl

Jave Wrapper for soundex similarity.
trait StringMetric[A <: StringMetricAlgorithm] extends AnyRef

Defines implementation for StringMetricAlgorithm by adding implicit definitions from DistanceAlgorithm, ScoringAlgorithm, WeightedDistanceAlgorithm, or WeightedScoringAlgorithm
trait StringMetricAlgorithm extends AnyRef

A marker interface for the string metric algorithm.
trait StringSoundMetric[A <: StringMetricAlgorithm] extends AnyRef
trait TverskyAlgorithm extends StringMetricAlgorithm

A marker interface for the tversky similarity algorithm.
trait WeightedDistanceAlgorithm[+A <: StringMetricAlgorithm, B] extends AnyRef

A type class to extend a distance method with a 2nd typed parameter to StringMetricAlgorithm.
trait WeightedScoringAlgorithm[+A <: StringMetricAlgorithm, B] extends AnyRef

A type class to extend a score method with a 2nd typed parameter to StringMetricAlgorithm.
trait WeightedStringMetric[A <: StringMetricAlgorithm, B] extends AnyRef

Value Members

implicit object CosSimilarityScore extends CosSimilarityImpl with WeightedScoringAlgorithm[CosineAlgorithm, String]

Implicit definition of cosine similarity score for CosineAlgorithm.
Implicit definition of cosine similarity score for CosineAlgorithm.

Definition Classes
ScoreDefinitions
implicit object DamerauLevenshteinDistance extends LevenshteinDistanceImpl with DistanceAlgorithm[DamerauLevenshteinAlgorithm] with ScorableFromDistance[DamerauLevenshteinAlgorithm]

Implicit definition of damerau levenshtein distance for DamerauLevenshteinAlgorithm.
Implicit definition of damerau levenshtein distance for DamerauLevenshteinAlgorithm.

Definition Classes
DistanceDefinitions
implicit object DiceCoefficientScore extends DiceCoefficientImpl with ScoringAlgorithm[DiceCoefficientAlgorithm]

Implicit definition of dice coefficient score for DiceCoefficientAlgorithm.
Implicit definition of dice coefficient score for DiceCoefficientAlgorithm.

Definition Classes
ScoreDefinitions
implicit object HammingDistance extends HammingImpl with DistanceAlgorithm[HammingAlgorithm] with ScorableFromDistance[HammingAlgorithm]

Implicit definition of hamming distance for HammingAlgorithm.
Implicit definition of hamming distance for HammingAlgorithm.

Definition Classes
DistanceDefinitions
implicit object JaccardScore extends JaccardImpl with WeightedScoringAlgorithm[JaccardAlgorithm, Int]

Implicit definition of jaccard score for JaccardAlgorithm.
Implicit definition of jaccard score for JaccardAlgorithm.

Definition Classes
ScoreDefinitions
implicit object JaroScore extends JaroImpl with ScoringAlgorithm[JaroAlgorithm]

Implicit definition of jaro score for JaroAlgorithm.
Implicit definition of jaro score for JaroAlgorithm.

Definition Classes
ScoreDefinitions
implicit object JaroWinklerScore extends JaroImpl with WeightedScoringAlgorithm[JaroWinklerAlgorithm, Double]

Implicit definition of jaro winkler score for JaroWinklerAlgorithm.
Implicit definition of jaro winkler score for JaroWinklerAlgorithm.

Definition Classes
ScoreDefinitions
implicit object LevenshteinDistance extends LevenshteinDistanceImpl with DistanceAlgorithm[LevenshteinAlgorithm] with ScorableFromDistance[LevenshteinAlgorithm]

Implicit definition of levenshtein distance for LevenshteinAlgorithm.
Implicit definition of levenshtein distance for LevenshteinAlgorithm.

Definition Classes
DistanceDefinitions
implicit object LongestCommonSeqDistance extends LongestCommonSeqImpl with DistanceAlgorithm[LongestCommonSeqAlorithm]

Implicit definition of longest common subsequence for CosineAlgorithm.
Implicit definition of longest common subsequence for CosineAlgorithm.

Definition Classes
DistanceDefinitions
implicit object MetaphoneScore extends MetaphoneImpl with SoundScoringAlgorithm[MetaphoneAlgorithm]

Implicit definition of metaphone score for MetaphoneAlgorithm.
Implicit definition of metaphone score for MetaphoneAlgorithm.

Definition Classes
SoundDefinitions
implicit object NGramDistance extends NGramImpl with WeightedDistanceAlgorithm[NGramAlgorithm, Int]

Implicit definition of n-gram distance for NGramAlgorithm.
Implicit definition of n-gram distance for NGramAlgorithm.

Definition Classes
DistanceDefinitions
implicit object NGramScore extends NGramImpl with WeightedScoringAlgorithm[NGramAlgorithm, Int]

Implicit definition of n-gram score for NGramAlgorithm.
Implicit definition of n-gram score for NGramAlgorithm.

Definition Classes
ScoreDefinitions
implicit object NeedlemanWunschScore extends NeedlemanWunschImpl with WeightedScoringAlgorithm[NeedlemanWunschAlgorithm, ConstantGap]

Implicit definition of needleman wunsch score for NeedlemanWunschAlgorithm.
Implicit definition of needleman wunsch score for NeedlemanWunschAlgorithm.

Definition Classes
ScoreDefinitions
implicit object OverlapScore extends OverlapImpl with WeightedScoringAlgorithm[OverlapAlgorithm, Int]

Implicit definition of overlap score for OverlapAlgorithm.
Implicit definition of overlap score for OverlapAlgorithm.

Definition Classes
ScoreDefinitions
implicit object SmithWatermanGotohScore extends SmithWatermanImpl with WeightedScoringAlgorithm[SmithWatermanGotohAlgorithm, ConstantGap]

Implicit definition of smith waterman gotoh score for SmithWatermanGotohAlgorithm.
Implicit definition of smith waterman gotoh score for SmithWatermanGotohAlgorithm.

Definition Classes
ScoreDefinitions
implicit object SmithWatermanScore extends SmithWatermanImpl with WeightedScoringAlgorithm[SmithWatermanAlgorithm, (Gap, Int)]

Implicit definition of smith waterman score for SmithWatermanAlgorithm.
Implicit definition of smith waterman score for SmithWatermanAlgorithm.

Definition Classes
ScoreDefinitions
implicit object SoundexScore extends SoundexImpl with SoundScoringAlgorithm[SoundexAlgorithm]

Implicit definition of soundex score for SoundexAlgorithm.
Implicit definition of soundex score for SoundexAlgorithm.

Definition Classes
SoundDefinitions
object Strategy

The Strategy object has two strategies(reg ex) expressions on which to split input.
The Strategy object has two strategies(reg ex) expressions on which to split input. Strategy.splitWord splits a word into a sequence of characters. Strategy.splitSentence splits a sentence into a sequence of words.

object StringConverter

Object to extend operations to the String class.

import com.github.vickumar1981.stringdistance.StringConverter._

// Scores between two strings
val cosSimilarity: Double = "hello".cosine("chello")
val damerau: Double = "martha".damerau("marhta")
val diceCoefficient: Double = "martha".diceCoefficient("marhta")
val hamming: Double = "martha".hamming("marhta")
val jaccard: Double = "karolin".jaccard("kathrin")
val jaro: Double = "martha".jaro("marhta")
val jaroWinkler: Double = "martha".jaroWinkler("marhta")
val levenshtein: Double = "martha".levenshtein("marhta")
val needlemanWunsch: Double = "martha".needlemanWusnch("marhta")
val ngramSimilarity: Double = "karolin".nGram("kathrin")
val bigramSimilarity: Double = "karolin".nGram("kathrin", 2)
val overlap: Double = "karolin".overlap("kathrin")
val smithWaterman: Double = "martha".smithWaterman("marhta")
val smithWatermanGotoh: Double = "martha".smithWatermanGotoh("marhta")
val tversky: Double = "karolin".tversky("kathrin", 0.5)

// Distances between two strings
val damerauDist: int = "martha".damerauDist("marhta")
val hammingDist: Int = "martha".hammingDist("marhta")
val levenshteinDist: Int = "martha".levenshteinDist("marhta")
val longestCommonSeq: Int = "martha".longestCommonSeq("marhta")
val ngramDist: Int = "karolin".nGramDist("kathrin")
val bigramDist: Int = "karolin".nGramDist("kathrin", 2)

// Phonetic similarity of two strings
val metaphone: Boolean = "merci".metaphone("mercy")
val soundex: Boolean = "merci".soundex("mercy")

object StringDistance

Main class to organize functionality of different string distance algorithms

import com.github.vickumar1981.stringdistance.Strategy
import com.github.vickumar1981.stringdistance.StringDistance._
import com.github.vickumar1981.stringdistance.impl.{ConstantGap, LinearGap}

// Scores between strings
val cosSimilarity: Double = Cosine.score("hello", "chello", Strategy.splitWord)
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)

object StringSound

Main class to organize functionality of different phonetic/sound string algorithms

import com.github.vickumar1981.stringdistance.StringSound._
import com.github.vickumar1981.stringdistance.implicits._

// Phonetic similarity between strings
val metaphone: Boolean = Metaphone.score("merci", "mercy")
val soundex: Boolean = Soundex.score("merci", "mercy")

implicit object TverskyScore extends JaccardImpl with WeightedScoringAlgorithm[TverskyAlgorithm, Double]

Implicit definition of tversky score for TverskyAlgorithm.
Implicit definition of tversky score for TverskyAlgorithm.

Definition Classes
ScoreDefinitions
package impl
package implicits
package interfaces
package util

package stringdistance

Overview

Type Members

trait CosineAlgorithm extends StringMetricAlgorithm

class CosineSimilarityImplWrapper extends CosSimilarityImpl

trait DamerauLevenshteinAlgorithm extends StringMetricAlgorithm

trait DiceCoefficientAlgorithm extends StringMetricAlgorithm

class DiceCoefficientImplWrapper extends DiceCoefficientImpl

trait DistanceAlgorithm[+T <: StringMetricAlgorithm] extends AnyRef

trait HammingAlgorithm extends StringMetricAlgorithm

class HammingImplWrapper extends HammingImpl

trait JaccardAlgorithm extends StringMetricAlgorithm

class JaccardImplWrapper extends JaccardImpl

trait JaroAlgorithm extends StringMetricAlgorithm

class JaroImplWrapper extends JaroImpl

trait JaroWinklerAlgorithm extends StringMetricAlgorithm

trait LevenshteinAlgorithm extends StringMetricAlgorithm

class LevenshteinDistanceImplWrapper extends LevenshteinDistanceImpl

trait LongestCommonSeqAlorithm extends StringMetricAlgorithm

class LongestCommonSeqWrapper extends LongestCommonSeqImpl

trait MetaphoneAlgorithm extends StringMetricAlgorithm

class MetaphoneImplWrapper extends MetaphoneImpl

trait NGramAlgorithm extends StringMetricAlgorithm

class NGramImplWrapper extends NGramImpl

trait NeedlemanWunschAlgorithm extends StringMetricAlgorithm

class NeedlemanWunschImplWrapper extends NeedlemanWunschImpl

trait OverlapAlgorithm extends StringMetricAlgorithm

class OverlapImplWrapper extends OverlapImpl

trait ScorableFromDistance[+T <: StringMetricAlgorithm] extends ScoringAlgorithm[T]

trait ScoringAlgorithm[+T <: StringMetricAlgorithm] extends AnyRef

trait SmithWatermanAlgorithm extends StringMetricAlgorithm

trait SmithWatermanGotohAlgorithm extends StringMetricAlgorithm

class SmithWatermanImplWrapper extends SmithWatermanImpl

trait SoundScoringAlgorithm[+T <: StringMetricAlgorithm] extends AnyRef

trait SoundexAlgorithm extends StringMetricAlgorithm

class SoundexImplWrapper extends SoundexImpl

trait StringMetric[A <: StringMetricAlgorithm] extends AnyRef

trait StringMetricAlgorithm extends AnyRef

trait StringSoundMetric[A <: StringMetricAlgorithm] extends AnyRef

trait TverskyAlgorithm extends StringMetricAlgorithm

trait WeightedDistanceAlgorithm[+A <: StringMetricAlgorithm, B] extends AnyRef

trait WeightedScoringAlgorithm[+A <: StringMetricAlgorithm, B] extends AnyRef

trait WeightedStringMetric[A <: StringMetricAlgorithm, B] extends AnyRef

Value Members

implicit object CosSimilarityScore extends CosSimilarityImpl with WeightedScoringAlgorithm[CosineAlgorithm, String]

implicit object DamerauLevenshteinDistance extends LevenshteinDistanceImpl with DistanceAlgorithm[DamerauLevenshteinAlgorithm] with ScorableFromDistance[DamerauLevenshteinAlgorithm]

implicit object DiceCoefficientScore extends DiceCoefficientImpl with ScoringAlgorithm[DiceCoefficientAlgorithm]

implicit object HammingDistance extends HammingImpl with DistanceAlgorithm[HammingAlgorithm] with ScorableFromDistance[HammingAlgorithm]

implicit object JaccardScore extends JaccardImpl with WeightedScoringAlgorithm[JaccardAlgorithm, Int]

implicit object JaroScore extends JaroImpl with ScoringAlgorithm[JaroAlgorithm]

implicit object JaroWinklerScore extends JaroImpl with WeightedScoringAlgorithm[JaroWinklerAlgorithm, Double]

implicit object LevenshteinDistance extends LevenshteinDistanceImpl with DistanceAlgorithm[LevenshteinAlgorithm] with ScorableFromDistance[LevenshteinAlgorithm]

implicit object LongestCommonSeqDistance extends LongestCommonSeqImpl with DistanceAlgorithm[LongestCommonSeqAlorithm]

implicit object MetaphoneScore extends MetaphoneImpl with SoundScoringAlgorithm[MetaphoneAlgorithm]

implicit object NGramDistance extends NGramImpl with WeightedDistanceAlgorithm[NGramAlgorithm, Int]

implicit object NGramScore extends NGramImpl with WeightedScoringAlgorithm[NGramAlgorithm, Int]

implicit object NeedlemanWunschScore extends NeedlemanWunschImpl with WeightedScoringAlgorithm[NeedlemanWunschAlgorithm, ConstantGap]

implicit object OverlapScore extends OverlapImpl with WeightedScoringAlgorithm[OverlapAlgorithm, Int]

implicit object SmithWatermanGotohScore extends SmithWatermanImpl with WeightedScoringAlgorithm[SmithWatermanGotohAlgorithm, ConstantGap]

implicit object SmithWatermanScore extends SmithWatermanImpl with WeightedScoringAlgorithm[SmithWatermanAlgorithm, (Gap, Int)]

implicit object SoundexScore extends SoundexImpl with SoundScoringAlgorithm[SoundexAlgorithm]

object Strategy

object StringConverter

object StringDistance

object StringSound

implicit object TverskyScore extends JaccardImpl with WeightedScoringAlgorithm[TverskyAlgorithm, Double]

package impl

package implicits

package interfaces

package util

Inherited from SoundDefinitions

Inherited from ScoreDefinitions

Inherited from DistanceDefinitions

Inherited from AnyRef

Inherited from Any

Ungrouped