Skip navigation links
A B C D E F G H I J L M N O P Q R S T U V W 

A

AbstractTokenizer - Class in org.simmetrics.tokenizers
Convenience tokenizer.
AbstractTokenizer() - Constructor for class org.simmetrics.tokenizers.AbstractTokenizer
 
AffineGap - Class in org.simmetrics.metrics.functions
A gap function that calculates the gap penalty as A+(B * GapLegth).
AffineGap(float, float) - Constructor for class org.simmetrics.metrics.functions.AffineGap
Constructs a constant gap function that assigns a penalty of startValue + gapValue * gapLenght to a gap.

B

BlockDistance<T> - Class in org.simmetrics.metrics
Block distance algorithm whereby vector space block distance between tokens is used to determine a similarity.
BlockDistance() - Constructor for class org.simmetrics.metrics.BlockDistance
 
blockDistance() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses a Tokenizers.whitespace() and the BlockDistance metric.
build() - Method in interface org.simmetrics.StringMetricBuilder.BuildStep
Builds a metric with the given steps.
build() - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricTokenizerStep
Builds a string metric that will use the given simplification, tokenization and filtering steps.
build() - Method in interface org.simmetrics.StringMetricBuilder.StringMetricInitialSimplifierStep
Builds a metric with the given simplifier.
build() - Method in interface org.simmetrics.StringMetricBuilder.StringMetricSimplifierStep
Builds a metric with the given simplifier.

C

cacheStrings(Cache<String, String>) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricSimplifierStep
Sets a cache for simplification chain.
cacheStrings(Cache<String, String>) - Method in interface org.simmetrics.StringMetricBuilder.StringMetricSimplifierStep
Sets a cache for simplification chain.
cacheTokens(Cache<String, T>) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricTokenizerStep
Sets a cache for tokenization chain.
CachingSimplifier - Class in org.simmetrics.utils
Deprecated.
CachingSimplifier(int, int, Simplifier) - Constructor for class org.simmetrics.utils.CachingSimplifier
Deprecated.
Creates a caching simplifier with initialCapacity and maximumSize.
CachingSimplifier(int, int) - Constructor for class org.simmetrics.utils.CachingSimplifier
Deprecated.
Creates a caching simplifier with initialCapacity and maximumSize.
CachingTokenizer - Class in org.simmetrics.utils
Deprecated.
CachingTokenizer(int, int) - Constructor for class org.simmetrics.utils.CachingTokenizer
Deprecated.
Creates a caching tokenizer with initialCapacity and maximumSize.
CachingTokenizer(int, int, Tokenizer) - Constructor for class org.simmetrics.utils.CachingTokenizer
Deprecated.
Creates a caching tokenizer with initialCapacity and maximumSize.
Case - Class in org.simmetrics.simplifiers
Case() - Constructor for class org.simmetrics.simplifiers.Case
Deprecated.
 
Case.Lower - Class in org.simmetrics.simplifiers
Deprecated.
Lower case simplifier.
Case.Upper - Class in org.simmetrics.simplifiers
Deprecated.
Upper case simplifier.
Caverphone1 - Class in org.simmetrics.simplifiers
Encodes a string into a Caverphone 1.0 value.
Caverphone1() - Constructor for class org.simmetrics.simplifiers.Caverphone1
 
Caverphone2 - Class in org.simmetrics.simplifiers
Encodes a string into a Caverphone 2.0 value.
Caverphone2() - Constructor for class org.simmetrics.simplifiers.Caverphone2
 
chain(List<Simplifier>) - Static method in class org.simmetrics.simplifiers.Simplifiers
Constructs a new chain of simplifiers.
chain(Simplifier, Simplifier...) - Static method in class org.simmetrics.simplifiers.Simplifiers
Constructs a new chain of simplifiers.
chain(List<Tokenizer>) - Static method in class org.simmetrics.tokenizers.Tokenizers
Chains tokenizers together.
chain(Tokenizer, Tokenizer...) - Static method in class org.simmetrics.tokenizers.Tokenizers
Chains tokenizers together.
ColognePhonetic - Class in org.simmetrics.simplifiers
Encodes a string into a Cologne Phonetic value.
ColognePhonetic() - Constructor for class org.simmetrics.simplifiers.ColognePhonetic
 
compare(List<T>, List<T>) - Method in interface org.simmetrics.ListMetric
Measures the similarity between lists a and b.
compare(T, T) - Method in interface org.simmetrics.Metric
Measures the similarity between a and b.
compare(List<T>, List<T>) - Method in class org.simmetrics.metrics.BlockDistance
 
compare(Set<T>, Set<T>) - Method in class org.simmetrics.metrics.CosineSimilarity
 
compare(String, String) - Method in class org.simmetrics.metrics.DamerauLevenshtein
 
compare(Set<T>, Set<T>) - Method in class org.simmetrics.metrics.DiceSimilarity
 
compare(List<T>, List<T>) - Method in class org.simmetrics.metrics.EuclideanDistance
 
compare(String, int, String, int) - Method in class org.simmetrics.metrics.functions.MatchMismatch
 
compare(String, int, String, int) - Method in interface org.simmetrics.metrics.functions.Substitution
Rates the substitution of character a.getChar(aIndex) against b.getChar(bIndex).
compare(T, T) - Method in class org.simmetrics.metrics.Identity
 
compare(Set<T>, Set<T>) - Method in class org.simmetrics.metrics.JaccardSimilarity
 
compare(String, String) - Method in class org.simmetrics.metrics.Jaro
 
compare(String, String) - Method in class org.simmetrics.metrics.JaroWinkler
 
compare(String, String) - Method in class org.simmetrics.metrics.Levenshtein
 
compare(List<T>, List<T>) - Method in class org.simmetrics.metrics.MatchingCoefficient
 
compare(List<String>, List<String>) - Method in class org.simmetrics.metrics.MongeElkan
 
compare(String, String) - Method in class org.simmetrics.metrics.NeedlemanWunch
 
compare(Set<T>, Set<T>) - Method in class org.simmetrics.metrics.OverlapCoefficient
 
compare(List<T>, List<T>) - Method in class org.simmetrics.metrics.SimonWhite
 
compare(String, String) - Method in class org.simmetrics.metrics.SmithWaterman
 
compare(String, String) - Method in class org.simmetrics.metrics.SmithWatermanGotoh
 
compare(Set<T>, Set<T>) - Method in interface org.simmetrics.SetMetric
Measures the similarity between sets a and b.
compare(String, String) - Method in interface org.simmetrics.StringMetric
Measures the similarity between strings a and b.
compare(StringMetric, String, List<String>) - Static method in class org.simmetrics.StringMetrics
Deprecated.
trivial with no clear use case
compare(StringMetric, String, String...) - Static method in class org.simmetrics.StringMetrics
Deprecated.
trivial with no clear use case
compareArrays(StringMetric, String[], String[]) - Static method in class org.simmetrics.StringMetrics
Deprecated.
trivial with no clear use case
ConstantGap - Class in org.simmetrics.metrics.functions
A gap function that assigns a constant penalty to a gap regardless of size.
ConstantGap(float) - Constructor for class org.simmetrics.metrics.functions.ConstantGap
Constructs a constant gap function that assigns a penalty of gapValue to a gap.
CosineSimilarity<T> - Class in org.simmetrics.metrics
Cosine Similarity algorithm providing a similarity measure between two set from the angular divergence within token based vector space.
CosineSimilarity() - Constructor for class org.simmetrics.metrics.CosineSimilarity
 
cosineSimilarity() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses a Tokenizers.whitespace() and the CosineSimilarity metric.
create(Metric<String>) - Static method in class org.simmetrics.StringMetrics
Either constructs a new string metric or returns the original metric.
create(Metric<String>, Simplifier) - Static method in class org.simmetrics.StringMetrics
Constructs a new composite string metric.
createForListMetric(Metric<List<String>>, Simplifier, Tokenizer) - Static method in class org.simmetrics.StringMetrics
Creates a new composite string metric.The tokenizer is used to tokenize the simplified strings.
createForListMetric(Metric<List<String>>, Tokenizer) - Static method in class org.simmetrics.StringMetrics
Creates a new composite string metric.
createForSetMetric(Metric<Set<String>>, Simplifier, Tokenizer) - Static method in class org.simmetrics.StringMetrics
Creates a new composite string metric.The tokenizer is used to tokenize the simplified strings.
createForSetMetric(Metric<Set<String>>, Tokenizer) - Static method in class org.simmetrics.StringMetrics
Creates a new composite string metric.
createWithBoostThreshold() - Static method in class org.simmetrics.metrics.JaroWinkler
Constructs a new JaroWinkler metric with Winklers boost threshold of 0.7.

D

DaitchMokotoffSoundex - Class in org.simmetrics.simplifiers
Encodes a string into a Daitch-Mokotoff Soundex value.
DaitchMokotoffSoundex() - Constructor for class org.simmetrics.simplifiers.DaitchMokotoffSoundex
Creates a new instance with ASCII-folding enabled.
DaitchMokotoffSoundex(boolean) - Constructor for class org.simmetrics.simplifiers.DaitchMokotoffSoundex
Creates a new DaitchMokotoffSoundex simplifier.
DamerauLevenshtein - Class in org.simmetrics.metrics
Damerau-Levenshtein algorithm providing a similarity measure between two strings.
DamerauLevenshtein() - Constructor for class org.simmetrics.metrics.DamerauLevenshtein
Constructs a new Damerau-Levenshtein metric.
DamerauLevenshtein(float, float, float) - Constructor for class org.simmetrics.metrics.DamerauLevenshtein
Constructs a new weighted Damerau-Levenshtein metric.
damerauLevenshtein() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses a DamerauLevenshtein metric.
DiceSimilarity<T> - Class in org.simmetrics.metrics
Dice similarity algorithm providing a similarity measure between two sets using the vector space of presented tokens.
DiceSimilarity() - Constructor for class org.simmetrics.metrics.DiceSimilarity
 
diceSimilarity() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses a Tokenizers.whitespace() and the DiceSimilarity metric.
Distance<T> - Interface in org.simmetrics
Measures the unnormalized similarity (distance) between two arbitrary objects of the same type .
distance(T, T) - Method in interface org.simmetrics.Distance
Measures the distance between a and b.
distance(List<E>, List<E>) - Method in interface org.simmetrics.ListDistance
Measures the distance between lists a and b.
distance(List<T>, List<T>) - Method in class org.simmetrics.metrics.BlockDistance
 
distance(String, String) - Method in class org.simmetrics.metrics.DamerauLevenshtein
 
distance(List<T>, List<T>) - Method in class org.simmetrics.metrics.EuclideanDistance
 
distance(String, String) - Method in class org.simmetrics.metrics.Levenshtein
 
distance(String, String) - Method in interface org.simmetrics.StringDistance
Measures the distance between string a and b.
DoubleMetaphone - Class in org.simmetrics.simplifiers
Encodes a string into a double metaphone value.
DoubleMetaphone() - Constructor for class org.simmetrics.simplifiers.DoubleMetaphone
Creates an instance of this DoubleMetaphone encoder
DoubleMetaphone(int, boolean) - Constructor for class org.simmetrics.simplifiers.DoubleMetaphone
Creates an instance of the DoubleMetaphone simplifier with a maxCodeLength.

E

EuclideanDistance<T> - Class in org.simmetrics.metrics
Euclidean Distance algorithm providing a similarity measure between two lists using the vector space of combined terms as the dimensions.
EuclideanDistance() - Constructor for class org.simmetrics.metrics.EuclideanDistance
 
euclideanDistance() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses a Tokenizers.whitespace() and the EuclideanDistance metric.
example00() - Static method in class org.simmetrics.example.StringMetricBuilderExample
Simply comparing strings through a metric may not be very effective.
example01() - Static method in class org.simmetrics.example.ReadMeExample
 
example01() - Static method in class org.simmetrics.example.StringMetricBuilderExample
Simplification Simplification increases the effectiveness of a metric by removing noise and reducing the dimensionality of the problem.
example01() - Static method in class org.simmetrics.example.StringMetricsExample
Two strings can be compared using a predefined string metric.
example02() - Static method in class org.simmetrics.example.ReadMeExample
 
example02() - Static method in class org.simmetrics.example.StringMetricBuilderExample
Simplifiers can also be chained.
example02() - Static method in class org.simmetrics.example.StringMetricsExample
A tokenizer is included when the metric is a string or list metric.
example03() - Static method in class org.simmetrics.example.StringMetricBuilderExample
Tokenization Tokenization cuts up a string into tokens.
example03() - Static method in class org.simmetrics.example.StringMetricsExample
Using the string StringMetricBuilder metrics can be customized.
example04() - Static method in class org.simmetrics.example.StringMetricBuilderExample
Tokenizers can also be chained.
example05() - Static method in class org.simmetrics.example.StringMetricBuilderExample
Tokens can be filtered to avoid comparing strings on common but otherwise low information words.
example06() - Static method in class org.simmetrics.example.StringMetricBuilderExample
Tokens can be transformed to a simpler form.
example07() - Static method in class org.simmetrics.example.StringMetricBuilderExample
Tokenization and simplification can be expensive operations.

F

filter(Predicate<String>) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricTokenizerStep
Adds a filter step to the metric.
filter(Tokenizer, Predicate<String>) - Static method in class org.simmetrics.tokenizers.Tokenizers
Constructs a new filtering tokenizer.
forList() - Static method in class org.simmetrics.metrics.HammingDistance
Returns a Hamming distance to compare lists.
forString() - Static method in class org.simmetrics.metrics.HammingDistance
Returns a Hamming distance to compare strings.

G

Gap - Interface in org.simmetrics.metrics.functions
A gap function assigns penalty to the creation of a gap in a string when matching against another string.
getEndPadding() - Method in class org.simmetrics.tokenizers.QGramExtended
Deprecated.
Returns the end padding.
getQ() - Method in class org.simmetrics.tokenizers.QGram
Deprecated.
Returns the q of this tokenizer.
getSimplifier() - Method in class org.simmetrics.utils.CachingSimplifier
Deprecated.
 
getSimplifier() - Method in interface org.simmetrics.utils.Simplifying
Deprecated.
Gets the simplifier.
getStartPadding() - Method in class org.simmetrics.tokenizers.QGramExtended
Deprecated.
Returns the start padding.
getTokenizer() - Method in class org.simmetrics.utils.CachingTokenizer
Deprecated.
 
getTokenizer() - Method in interface org.simmetrics.utils.Tokenizing
Deprecated.
Gets the tokenizer.

H

HammingDistance - Class in org.simmetrics.metrics
Hamming Distance algorithm to calculate distance between lists and strings.

I

Identity<T> - Class in org.simmetrics.metrics
Identity metric that returns 1.0 when the inputs are equals, and 0.0 when they're not.
Identity() - Constructor for class org.simmetrics.metrics.Identity
 
identity() - Static method in class org.simmetrics.StringMetrics
Returns an string metric that uses the Identity metric.

J

JaccardSimilarity<T> - Class in org.simmetrics.metrics
Jaccard similarity algorithm providing a similarity measure between two sets using the vector space of presented tokens.
JaccardSimilarity() - Constructor for class org.simmetrics.metrics.JaccardSimilarity
 
jaccardSimilarity() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses a Tokenizers.whitespace() and the JaccardSimilarity metric.
Jaro - Class in org.simmetrics.metrics
Jaro algorithm providing a similarity measure between two strings.
Jaro() - Constructor for class org.simmetrics.metrics.Jaro
 
jaro() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses the Jaro metric.
JaroWinkler - Class in org.simmetrics.metrics
Jaro-Winkler algorithm providing a similarity measure between two strings.
JaroWinkler() - Constructor for class org.simmetrics.metrics.JaroWinkler
Constructs a new JaroWinkler metric.
JaroWinkler(float, float, int) - Constructor for class org.simmetrics.metrics.JaroWinkler
Constructs a new JaroWinkler metric.
jaroWinkler() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses the JaroWinkler metric.

L

Levenshtein - Class in org.simmetrics.metrics
Levenshtein algorithm providing a similarity measure between two strings.
Levenshtein(float, float) - Constructor for class org.simmetrics.metrics.Levenshtein
Constructs a new weighted Levenshtein metric.
Levenshtein() - Constructor for class org.simmetrics.metrics.Levenshtein
Constructs a new Levenshtein metric.
levenshtein() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses the Levenshtein metric.
LinearGap - Class in org.simmetrics.metrics.functions
A gap function that takes into account the length the gap.
LinearGap(float) - Constructor for class org.simmetrics.metrics.functions.LinearGap
Constructs a linear gap function that scales the length of a gap with gapValue.
ListDistance<E> - Interface in org.simmetrics
Measures the distance between two arbitrary lists containing elements of the same type.
ListMetric<T> - Interface in org.simmetrics
Measures the similarity between two arbitrary lists containing elements of the same type.
Lower(Locale) - Constructor for class org.simmetrics.simplifiers.Case.Lower
Deprecated.
Constructs a new Lower case simplifier that will use the given locale.
Lower() - Constructor for class org.simmetrics.simplifiers.Case.Lower
Deprecated.

M

MatchingCoefficient<T> - Class in org.simmetrics.metrics
Matching coefficient algorithm providing a similarity measure between two lists.
MatchingCoefficient() - Constructor for class org.simmetrics.metrics.MatchingCoefficient
 
matchingCoefficient() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses a Tokenizers.whitespace() and the MatchingCoefficient metric.
MatchMismatch - Class in org.simmetrics.metrics.functions
A substitution function that assigns one value to equal characters, another value to unequal characters.
MatchMismatch(float, float) - Constructor for class org.simmetrics.metrics.functions.MatchMismatch
Constructs a new match-mismatch substitution function.
MatchRatingApproach - Class in org.simmetrics.simplifiers
Match Rating Approach Phonetic Algorithm Developed by Western Airlines in 1977.
MatchRatingApproach() - Constructor for class org.simmetrics.simplifiers.MatchRatingApproach
 
Math - Class in org.simmetrics.utils
Deprecated.
max() - Method in class org.simmetrics.metrics.functions.AffineGap
 
max() - Method in class org.simmetrics.metrics.functions.ConstantGap
 
max() - Method in interface org.simmetrics.metrics.functions.Gap
Returns the minimum value a gap can have.
max() - Method in class org.simmetrics.metrics.functions.LinearGap
 
max() - Method in class org.simmetrics.metrics.functions.MatchMismatch
 
max() - Method in interface org.simmetrics.metrics.functions.Substitution
Returns the maximum value a gap can have
max(float, float, float) - Static method in class org.simmetrics.utils.Math
Deprecated.
 
max(int, int, int) - Static method in class org.simmetrics.utils.Math
Deprecated.
 
max(float, float, float, float) - Static method in class org.simmetrics.utils.Math
Deprecated.
 
max(int, int, int, int) - Static method in class org.simmetrics.utils.Math
Deprecated.
 
Metaphone - Class in org.simmetrics.simplifiers
Encodes a string into a Metaphone value.
Metaphone() - Constructor for class org.simmetrics.simplifiers.Metaphone
Creates an instance of the Metaphone simplifier
Metaphone(int) - Constructor for class org.simmetrics.simplifiers.Metaphone
Creates an instance of the Metaphone simplifier with a maxCodeLength.
Metric<T> - Interface in org.simmetrics
Measures the similarity between two arbitrary objects of the same type .
min() - Method in class org.simmetrics.metrics.functions.AffineGap
 
min() - Method in class org.simmetrics.metrics.functions.ConstantGap
 
min() - Method in interface org.simmetrics.metrics.functions.Gap
Returns the maximum value a gap can have.
min() - Method in class org.simmetrics.metrics.functions.LinearGap
 
min() - Method in class org.simmetrics.metrics.functions.MatchMismatch
 
min() - Method in interface org.simmetrics.metrics.functions.Substitution
Returns the minimum value a gap can have
min(float, float, float) - Static method in class org.simmetrics.utils.Math
Deprecated.
 
min(int, int, int) - Static method in class org.simmetrics.utils.Math
Deprecated.
 
min(float, float, float, float) - Static method in class org.simmetrics.utils.Math
Deprecated.
 
min(int, int, int, int) - Static method in class org.simmetrics.utils.Math
Deprecated.
 
MongeElkan - Class in org.simmetrics.metrics
Monge Elkan algorithm providing an matching style similarity measure between two strings.
MongeElkan(StringMetric) - Constructor for class org.simmetrics.metrics.MongeElkan
Constructs a MongeElkan metric with metric.
mongeElkan() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses a Tokenizers.whitespace() and the MongeElkan metric with an internal SmithWatermanGotoh metric.

N

NeedlemanWunch - Class in org.simmetrics.metrics
Needleman-Wunsch algorithm providing a similarity measure between two strings.
NeedlemanWunch() - Constructor for class org.simmetrics.metrics.NeedlemanWunch
Constructs a new Needleman-Wunch metric.
NeedlemanWunch(float, Substitution) - Constructor for class org.simmetrics.metrics.NeedlemanWunch
Constructs a new Needleman-Wunch metric.
needlemanWunch() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses the NeedlemanWunch metric.
NonDiacritics - Class in org.simmetrics.simplifiers
Deprecated.
NonDiacritics() - Constructor for class org.simmetrics.simplifiers.NonDiacritics
Deprecated.
 
Nysiis - Class in org.simmetrics.simplifiers
Encodes a string into a NYSIIS value.
Nysiis() - Constructor for class org.simmetrics.simplifiers.Nysiis
Creates an instance of the Nysiis encoder with strict mode (original form), i.e.
Nysiis(boolean) - Constructor for class org.simmetrics.simplifiers.Nysiis
Create an instance of the Nysiis simplifier with the specified strict mode: true: encoded strings have a maximum length of 6 false: encoded strings may have arbitrary length

O

org.simmetrics - package org.simmetrics
 
org.simmetrics.example - package org.simmetrics.example
 
org.simmetrics.metrics - package org.simmetrics.metrics
 
org.simmetrics.metrics.functions - package org.simmetrics.metrics.functions
 
org.simmetrics.simplifiers - package org.simmetrics.simplifiers
 
org.simmetrics.tokenizers - package org.simmetrics.tokenizers
 
org.simmetrics.utils - package org.simmetrics.utils
 
OverlapCoefficient<T> - Class in org.simmetrics.metrics
Overlap Coefficient algorithm providing a similarity measure between two sets where it is determined to what degree a set is a subset of another.
OverlapCoefficient() - Constructor for class org.simmetrics.metrics.OverlapCoefficient
 
overlapCoefficient() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses a Tokenizers.whitespace() and the OverlapCoefficient metric.

P

pattern(Pattern) - Static method in class org.simmetrics.tokenizers.Tokenizers
Returns a tokenizer that splits a string into tokens around the pattern as if calling pattern.split(input,-1).
pattern(String) - Static method in class org.simmetrics.tokenizers.Tokenizers
Returns a tokenizer that splits a string into tokens around the pattern as if calling Pattern.compile(regex).split(input,-1).

Q

QGram - Class in org.simmetrics.tokenizers
Deprecated.
QGram(int) - Constructor for class org.simmetrics.tokenizers.QGram
Deprecated.
Constructs a q-gram tokenizer with the given q.
qGram(int) - Static method in class org.simmetrics.tokenizers.Tokenizers
Returns a basic q-gram tokenizer for a variable q.
QGramExtended - Class in org.simmetrics.tokenizers
QGramExtended(int, String, String) - Constructor for class org.simmetrics.tokenizers.QGramExtended
Deprecated.
Constructs a q-gram tokenizer with the given q and padding.
QGramExtended(int) - Constructor for class org.simmetrics.tokenizers.QGramExtended
Deprecated.
Constructs a q-gram tokenizer with the given q and default padding.
qGramsDistance() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses a Tokenizers.qGramWithPadding(int) for q=3 and the BlockDistance metric.
qGramWithFilter(int) - Static method in class org.simmetrics.tokenizers.Tokenizers
Returns a basic q-gram tokenizer for a variable q.
qGramWithPadding(int) - Static method in class org.simmetrics.tokenizers.Tokenizers
Returns a basic q-gram tokenizer for a variable q.The input is padded with q-1 special characters before being tokenized.
qGramWithPadding(int, String) - Static method in class org.simmetrics.tokenizers.Tokenizers
Returns a basic q-gram tokenizer for a variable Q.The Q-Gram is extended beyond the length of the string with padding.
qGramWithPadding(int, String, String) - Static method in class org.simmetrics.tokenizers.Tokenizers
Returns a basic q-gram tokenizer for a variable Q.The Q-Gram is extended beyond the length of the string with padding.

R

ReadMeExample - Class in org.simmetrics.example
Examples from README.md
ReadMeExample() - Constructor for class org.simmetrics.example.ReadMeExample
 
RefinedSoundex - Class in org.simmetrics.simplifiers
Encodes a string into a Refined Soundex value.
RefinedSoundex() - Constructor for class org.simmetrics.simplifiers.RefinedSoundex
 
removeAll(String) - Static method in class org.simmetrics.simplifiers.Simplifiers
Returns a simplifier that removes every subsequence of the input that matches the regex.
removeAll(Pattern) - Static method in class org.simmetrics.simplifiers.Simplifiers
Returns a simplifier that removes every subsequence of the input that matches the pattern.
removeDiacritics() - Static method in class org.simmetrics.simplifiers.Simplifiers
Returns a simplifier that removes diacritics.
removeNonWord() - Static method in class org.simmetrics.simplifiers.Simplifiers
Returns a simplifier that removes all non-word [^0-9a-zA-Z] characters.
removeNonWord(String) - Static method in class org.simmetrics.simplifiers.Simplifiers
Returns a simplifier that removes all consecutive non-word characters [^0-9a-zA-Z]+ and replaces them with the replacement.
replaceAll(String, String) - Static method in class org.simmetrics.simplifiers.Simplifiers
Returns a simplifier that replaces every subsequence of the input that matches the regex with the given replacement string.
replaceAll(Pattern, String) - Static method in class org.simmetrics.simplifiers.Simplifiers
Returns a simplifier that replaces every subsequence of the input that matches the pattern with the given replacement string.
replaceNonWord() - Static method in class org.simmetrics.simplifiers.Simplifiers
Returns a simplifier that replaces all individual non-word characters [^0-9a-zA-Z] with a space.
replaceNonWord(String) - Static method in class org.simmetrics.simplifiers.Simplifiers
Returns a simplifier that replaces all individual non-word characters [^0-9a-zA-Z] with the replacement.

S

SetMetric<T> - Interface in org.simmetrics
Measures the similarity between two arbitrary sets containing elements of the same type.
setSimplifier(Simplifier) - Method in class org.simmetrics.utils.CachingSimplifier
Deprecated.
 
setSimplifier(Simplifier) - Method in interface org.simmetrics.utils.Simplifying
Deprecated.
Sets the simplifier.
setTokenizer(Tokenizer) - Method in class org.simmetrics.utils.CachingTokenizer
Deprecated.
 
setTokenizer(Tokenizer) - Method in interface org.simmetrics.utils.Tokenizing
Deprecated.
Sets the tokenizer.
SimonWhite<T> - Class in org.simmetrics.metrics
Simon White algorithm providing a similarity measure between two lists.
SimonWhite() - Constructor for class org.simmetrics.metrics.SimonWhite
 
simonWhite() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses a Tokenizers.whitespace() followed by a Tokenizers.qGramWithPadding(int) for q=2 and the SimonWhite metric.
Simplifier - Interface in org.simmetrics.simplifiers
Transforms a string into a simpler form.
simplifierCache(SimplifyingSimplifier) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricSimplifierStep
Deprecated.
simplifierCache(int, int) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricSimplifierStep
Deprecated.
use CollectionMetricInitialTokenizerStep#cacheStrings(Cache)
simplifierCache() - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricSimplifierStep
Deprecated.
use CollectionMetricInitialTokenizerStep#cacheStrings(Cache)
simplifierCache(SimplifyingSimplifier) - Method in interface org.simmetrics.StringMetricBuilder.StringMetricSimplifierStep
simplifierCache(int, int) - Method in interface org.simmetrics.StringMetricBuilder.StringMetricSimplifierStep
simplifierCache() - Method in interface org.simmetrics.StringMetricBuilder.StringMetricSimplifierStep
Simplifiers - Class in org.simmetrics.simplifiers
Utilities for simplifiers.
simplify(String) - Method in class org.simmetrics.simplifiers.Case.Lower
Deprecated.
 
simplify(String) - Method in class org.simmetrics.simplifiers.Case.Upper
Deprecated.
 
simplify(String) - Method in class org.simmetrics.simplifiers.Caverphone1
 
simplify(String) - Method in class org.simmetrics.simplifiers.Caverphone2
 
simplify(String) - Method in class org.simmetrics.simplifiers.ColognePhonetic
 
simplify(String) - Method in class org.simmetrics.simplifiers.DaitchMokotoffSoundex
 
simplify(String) - Method in class org.simmetrics.simplifiers.DoubleMetaphone
 
simplify(String) - Method in class org.simmetrics.simplifiers.MatchRatingApproach
 
simplify(String) - Method in class org.simmetrics.simplifiers.Metaphone
 
simplify(String) - Method in class org.simmetrics.simplifiers.NonDiacritics
Deprecated.
 
simplify(String) - Method in class org.simmetrics.simplifiers.Nysiis
 
simplify(String) - Method in class org.simmetrics.simplifiers.RefinedSoundex
 
simplify(String) - Method in interface org.simmetrics.simplifiers.Simplifier
Simplifiers the input string.
simplify(String) - Method in class org.simmetrics.simplifiers.Soundex
 
simplify(String) - Method in class org.simmetrics.simplifiers.WordCharacters
Deprecated.
 
simplify(Simplifier) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricInitialSimplifierStep
Adds a simplifier to the metric.
simplify(Simplifier) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricSimplifierStep
Adds a simplifier to the metric.
simplify(Simplifier) - Method in interface org.simmetrics.StringMetricBuilder.StringMetricInitialSimplifierStep
Adds a simplifier to the metric.
simplify(Simplifier) - Method in interface org.simmetrics.StringMetricBuilder.StringMetricSimplifierStep
Adds a simplifier to the metric.
simplify(String) - Method in class org.simmetrics.utils.CachingSimplifier
Deprecated.
 
Simplifying - Interface in org.simmetrics.utils
Deprecated.
SimplifyingSimplifier - Interface in org.simmetrics.utils
Deprecated.
SmithWaterman - Class in org.simmetrics.metrics
Smith-Waterman algorithm providing a similarity measure between two strings.
SmithWaterman() - Constructor for class org.simmetrics.metrics.SmithWaterman
Constructs a new Smith Waterman metric.
SmithWaterman(Gap, Substitution, int) - Constructor for class org.simmetrics.metrics.SmithWaterman
Constructs a new Smith Waterman metric.
smithWaterman() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses the SmithWaterman metric.
SmithWatermanGotoh - Class in org.simmetrics.metrics
Smith-Waterman algorithm providing a similarity measure between two strings.
SmithWatermanGotoh() - Constructor for class org.simmetrics.metrics.SmithWatermanGotoh
Constructs a new Smith Waterman metric.
SmithWatermanGotoh(float, Substitution) - Constructor for class org.simmetrics.metrics.SmithWatermanGotoh
Constructs a new Smith Waterman metric.
smithWatermanGotoh() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses the SmithWatermanGotoh metric.
Soundex - Class in org.simmetrics.simplifiers
Encodes a string into a Soundex value.
Soundex() - Constructor for class org.simmetrics.simplifiers.Soundex
 
soundex() - Static method in class org.simmetrics.StringMetrics
Returns a string metric that uses a Soundex and JaroWinkler metric.
StringDistance - Interface in org.simmetrics
Measures the unnormalized similarity (distance) between two Strings.
StringMetric - Interface in org.simmetrics
Measures the similarity between two strings.
StringMetricBuilder - Class in org.simmetrics
Convenience tool to build string metrics.
StringMetricBuilder.BuildStep - Interface in org.simmetrics
 
StringMetricBuilder.CollectionMetricInitialSimplifierStep<T extends Collection<String>> - Interface in org.simmetrics
 
StringMetricBuilder.CollectionMetricInitialTokenizerStep<T extends Collection<String>> - Interface in org.simmetrics
 
StringMetricBuilder.CollectionMetricSimplifierStep<T extends Collection<String>> - Interface in org.simmetrics
 
StringMetricBuilder.CollectionMetricTokenizerStep<T extends Collection<String>> - Interface in org.simmetrics
 
StringMetricBuilder.StringMetricInitialSimplifierStep - Interface in org.simmetrics
 
StringMetricBuilder.StringMetricSimplifierStep - Interface in org.simmetrics
 
StringMetricBuilderExample - Class in org.simmetrics.example
The StringMetricBuilder can be used to compose metrics.
StringMetricBuilderExample() - Constructor for class org.simmetrics.example.StringMetricBuilderExample
 
StringMetrics - Class in org.simmetrics
Utility class for StringMetrics.
StringMetricsExample - Class in org.simmetrics.example
The StringMetrics utility class contains a predefined list of well known metrics.
StringMetricsExample() - Constructor for class org.simmetrics.example.StringMetricsExample
 
Substitution - Interface in org.simmetrics.metrics.functions
A substitution function assigns value to the substitution of one character for another matching against another string.

T

tokenize(Tokenizer) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricInitialSimplifierStep
Adds a tokenization step to the metric.
tokenize(Tokenizer) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricInitialTokenizerStep
Adds a tokenization step to the metric.
tokenize(Tokenizer) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricSimplifierStep
Adds a tokenization step to the metric.
tokenize(Tokenizer) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricTokenizerStep
Adds a tokenization step to the metric.
Tokenizer - Interface in org.simmetrics.tokenizers
A tokenizer divides an input string into tokens.
tokenizerCache(TokenizingTokenizer) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricTokenizerStep
tokenizerCache(int, int) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricTokenizerStep
tokenizerCache() - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricTokenizerStep
Tokenizers - Class in org.simmetrics.tokenizers
Utilities for tokenizers.
tokenizeToList(String) - Method in class org.simmetrics.tokenizers.QGram
Deprecated.
 
tokenizeToList(String) - Method in class org.simmetrics.tokenizers.QGramExtended
Deprecated.
 
tokenizeToList(String) - Method in interface org.simmetrics.tokenizers.Tokenizer
Return tokenized version of a string as a list of tokens.
tokenizeToList(String) - Method in class org.simmetrics.tokenizers.Whitespace
Deprecated.
 
tokenizeToList(String) - Method in class org.simmetrics.utils.CachingTokenizer
Deprecated.
 
tokenizeToSet(String) - Method in class org.simmetrics.tokenizers.AbstractTokenizer
 
tokenizeToSet(String) - Method in interface org.simmetrics.tokenizers.Tokenizer
Return tokenized version of a string as a set of tokens.
tokenizeToSet(String) - Method in class org.simmetrics.utils.CachingTokenizer
Deprecated.
 
Tokenizing - Interface in org.simmetrics.utils
Deprecated.
TokenizingTokenizer - Interface in org.simmetrics.utils
Deprecated.
toLowerCase() - Static method in class org.simmetrics.simplifiers.Simplifiers
Returns a simplifier that transforms all upper case characters into their lower case equivalent.
toLowerCase(Locale) - Static method in class org.simmetrics.simplifiers.Simplifiers
Returns a simplifier that transforms all upper case characters into their lower case equivalent.
toString() - Method in class org.simmetrics.metrics.BlockDistance
 
toString() - Method in class org.simmetrics.metrics.CosineSimilarity
 
toString() - Method in class org.simmetrics.metrics.DamerauLevenshtein
 
toString() - Method in class org.simmetrics.metrics.DiceSimilarity
 
toString() - Method in class org.simmetrics.metrics.EuclideanDistance
 
toString() - Method in class org.simmetrics.metrics.functions.AffineGap
 
toString() - Method in class org.simmetrics.metrics.functions.ConstantGap
 
toString() - Method in class org.simmetrics.metrics.functions.LinearGap
 
toString() - Method in class org.simmetrics.metrics.functions.MatchMismatch
 
toString() - Method in class org.simmetrics.metrics.Identity
 
toString() - Method in class org.simmetrics.metrics.JaccardSimilarity
 
toString() - Method in class org.simmetrics.metrics.Jaro
 
toString() - Method in class org.simmetrics.metrics.JaroWinkler
 
toString() - Method in class org.simmetrics.metrics.Levenshtein
 
toString() - Method in class org.simmetrics.metrics.MatchingCoefficient
 
toString() - Method in class org.simmetrics.metrics.MongeElkan
 
toString() - Method in class org.simmetrics.metrics.NeedlemanWunch
 
toString() - Method in class org.simmetrics.metrics.OverlapCoefficient
 
toString() - Method in class org.simmetrics.metrics.SimonWhite
 
toString() - Method in class org.simmetrics.metrics.SmithWaterman
 
toString() - Method in class org.simmetrics.metrics.SmithWatermanGotoh
 
toString() - Method in class org.simmetrics.simplifiers.Case.Lower
Deprecated.
 
toString() - Method in class org.simmetrics.simplifiers.Case.Upper
Deprecated.
 
toString() - Method in class org.simmetrics.simplifiers.Caverphone1
 
toString() - Method in class org.simmetrics.simplifiers.Caverphone2
 
toString() - Method in class org.simmetrics.simplifiers.ColognePhonetic
 
toString() - Method in class org.simmetrics.simplifiers.DaitchMokotoffSoundex
 
toString() - Method in class org.simmetrics.simplifiers.DoubleMetaphone
 
toString() - Method in class org.simmetrics.simplifiers.MatchRatingApproach
 
toString() - Method in class org.simmetrics.simplifiers.Metaphone
 
toString() - Method in class org.simmetrics.simplifiers.NonDiacritics
Deprecated.
 
toString() - Method in class org.simmetrics.simplifiers.Nysiis
 
toString() - Method in class org.simmetrics.simplifiers.RefinedSoundex
 
toString() - Method in class org.simmetrics.simplifiers.Soundex
 
toString() - Method in class org.simmetrics.simplifiers.WordCharacters
Deprecated.
 
toString() - Method in class org.simmetrics.tokenizers.QGram
Deprecated.
 
toString() - Method in class org.simmetrics.tokenizers.QGramExtended
Deprecated.
 
toString() - Method in class org.simmetrics.tokenizers.Whitespace
Deprecated.
 
toString() - Method in class org.simmetrics.utils.CachingSimplifier
Deprecated.
 
toString() - Method in class org.simmetrics.utils.CachingTokenizer
Deprecated.
 
toUpperCase() - Static method in class org.simmetrics.simplifiers.Simplifiers
Returns a simplifier that transforms all lower case characters into their upper case equivalent.
toUpperCase(Locale) - Static method in class org.simmetrics.simplifiers.Simplifiers
Returns a simplifier that transforms all lower case characters into their upper case equivalent.
transform(Function<String, String>) - Method in interface org.simmetrics.StringMetricBuilder.CollectionMetricTokenizerStep
Adds a transform step to the metric.
transform(Tokenizer, Function<String, String>) - Static method in class org.simmetrics.tokenizers.Tokenizers
Constructs a new transforming tokenizer.

U

Upper(Locale) - Constructor for class org.simmetrics.simplifiers.Case.Upper
Deprecated.
Constructs a new Upper case simplifier that will use the given locale.
Upper() - Constructor for class org.simmetrics.simplifiers.Case.Upper
Deprecated.
Constructs a new Upper case simplifier.

V

value(int, int) - Method in class org.simmetrics.metrics.functions.AffineGap
 
value(int, int) - Method in class org.simmetrics.metrics.functions.ConstantGap
 
value(int, int) - Method in interface org.simmetrics.metrics.functions.Gap
Returns the penalty for creating a gap from fromIndex to toIndex -1.
value(int, int) - Method in class org.simmetrics.metrics.functions.LinearGap
 

W

whitespace() - Static method in class org.simmetrics.tokenizers.Tokenizers
Returns a tokenizer that splits a string into tokens around whitespace.
Whitespace - Class in org.simmetrics.tokenizers
Deprecated.
Whitespace() - Constructor for class org.simmetrics.tokenizers.Whitespace
Deprecated.
 
with(StringMetric) - Static method in class org.simmetrics.StringMetricBuilder
Starts building a metric with a string metric.
with(ListMetric<String>) - Static method in class org.simmetrics.StringMetricBuilder
Starts building a metric with a list metric.
with(SetMetric<String>) - Static method in class org.simmetrics.StringMetricBuilder
Starts building a metric with a set metric.
WordCharacters - Class in org.simmetrics.simplifiers
Deprecated.
WordCharacters() - Constructor for class org.simmetrics.simplifiers.WordCharacters
Deprecated.
 
A B C D E F G H I J L M N O P Q R S T U V W 
Skip navigation links

Copyright © 2014–2018. All rights reserved.