Index (Simmetrics Core 4.1.1 API)

A B C D E F G H I J L M N O P Q R S T 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: Calculates the block distance and similarity over two multisets.
BlockDistance() - Constructor for class org.simmetrics.metrics.BlockDistance
blockDistance() - Static method in class org.simmetrics.metrics.StringDistances: Returns a string distance metric that uses a Tokenizers.whitespace() and the BlockDistance metric.
blockDistance() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a block distance similarity metric over tokens in a string.
build() - Method in interface org.simmetrics.builders.StringDistanceBuilder.BuildStep: Builds a distance with the given steps.
build() - Method in interface org.simmetrics.builders.StringDistanceBuilder.CollectionDistanceTokenizerStep: Builds a string distance metric that will use the given simplification, tokenization and filtering steps.
build() - Method in interface org.simmetrics.builders.StringDistanceBuilder.StringDistanceInitialSimplifierStep: Builds a distance with the given simplifier.
build() - Method in interface org.simmetrics.builders.StringDistanceBuilder.StringDistanceSimplifierStep: Builds a distance with the given simplifier.
build() - Method in interface org.simmetrics.builders.StringMetricBuilder.BuildStep: Builds a metric with the given steps.
build() - Method in interface org.simmetrics.builders.StringMetricBuilder.CollectionMetricTokenizerStep: Builds a similarity metric that will use the given simplification, tokenization and filtering steps.
build() - Method in interface org.simmetrics.builders.StringMetricBuilder.StringMetricInitialSimplifierStep: Builds a metric with the given simplifier.
build() - Method in interface org.simmetrics.builders.StringMetricBuilder.StringMetricSimplifierStep: Builds a metric with the given simplifier.

C

cacheStrings(Cache<String, String>) - Method in interface org.simmetrics.builders.StringDistanceBuilder.CollectionDistanceSimplifierStep: Sets a cache for simplification chain.
cacheStrings(Cache<String, String>) - Method in interface org.simmetrics.builders.StringDistanceBuilder.StringDistanceSimplifierStep: Sets a cache for simplification chain.
cacheStrings(Cache<String, String>) - Method in interface org.simmetrics.builders.StringMetricBuilder.CollectionMetricSimplifierStep: Sets a cache for simplification chain.
cacheStrings(Cache<String, String>) - Method in interface org.simmetrics.builders.StringMetricBuilder.StringMetricSimplifierStep: Sets a cache for simplification chain.
cacheTokens(Cache<String, T>) - Method in interface org.simmetrics.builders.StringDistanceBuilder.CollectionDistanceTokenizerStep: Sets a cache for tokenization chain.
cacheTokens(Cache<String, T>) - Method in interface org.simmetrics.builders.StringMetricBuilder.CollectionMetricTokenizerStep: Sets a cache for tokenization chain.
Caverphone1 - Class in org.simmetrics.simplifiers: Deprecated.
will be removed due to a lack of a good use case
Caverphone1() - Constructor for class org.simmetrics.simplifiers.Caverphone1: Deprecated.
Caverphone2 - Class in org.simmetrics.simplifiers: Deprecated.
will be removed due to a lack of a good use case
Caverphone2() - Constructor for class org.simmetrics.simplifiers.Caverphone2: Deprecated.
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: Deprecated.
will be removed due to a lack of a good use case
ColognePhonetic() - Constructor for class org.simmetrics.simplifiers.ColognePhonetic: Deprecated.
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(Multiset<T>, Multiset<T>) - Method in class org.simmetrics.metrics.BlockDistance
compare(Multiset<T>, Multiset<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.Dice
compare(Multiset<T>, Multiset<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(Multiset<T>, Multiset<T>) - Method in class org.simmetrics.metrics.GeneralizedJaccard
compare(Multiset<T>, Multiset<T>) - Method in class org.simmetrics.metrics.GeneralizedOverlapCoefficient
compare(T, T) - Method in class org.simmetrics.metrics.Identity
compare(Set<T>, Set<T>) - Method in class org.simmetrics.metrics.Jaccard
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(String, String) - Method in class org.simmetrics.metrics.LongestCommonSubsequence
compare(String, String) - Method in class org.simmetrics.metrics.LongestCommonSubstring
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(Multiset<T>, Multiset<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 class org.simmetrics.metrics.TanimotoCoefficient
compare(Multiset<T>, Multiset<T>) - Method in interface org.simmetrics.MultisetMetric: Measures the similarity between multisets a and b.
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.
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: Calculates the cosine similarity over two multisets.
CosineSimilarity() - Constructor for class org.simmetrics.metrics.CosineSimilarity
cosineSimilarity() - Static method in class org.simmetrics.metrics.StringDistances: Returns a distance metric that uses a Tokenizers.whitespace() and the CosineSimilarity metric.
cosineSimilarity() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a cosine similarity metric over tokens in a string.
create(Metric<String>) - Static method in class org.simmetrics.metrics.StringMetrics: Deprecated.
Use StringMetricBuilder in favor of directly constructing a metric.
create(Metric<String>, Simplifier) - Static method in class org.simmetrics.metrics.StringMetrics: Deprecated.
Use StringMetricBuilder in favor of directly constructing a metric.
createForListMetric(Metric<List<String>>, Simplifier, Tokenizer) - Static method in class org.simmetrics.metrics.StringMetrics: Deprecated.
Use StringMetricBuilder in favor of directly constructing a metric.
createForListMetric(Metric<List<String>>, Tokenizer) - Static method in class org.simmetrics.metrics.StringMetrics: Deprecated.
Use StringMetricBuilder in favor of directly constructing a metric.
createForMultisetMetric(Metric<Multiset<String>>, Simplifier, Tokenizer) - Static method in class org.simmetrics.metrics.StringMetrics: Deprecated.
Use StringMetricBuilder in favor of directly constructing a metric.
createForMultisetMetric(Metric<Multiset<String>>, Tokenizer) - Static method in class org.simmetrics.metrics.StringMetrics: Deprecated.
Use StringMetricBuilder in favor of directly constructing a metric.
createForSetMetric(Metric<Set<String>>, Simplifier, Tokenizer) - Static method in class org.simmetrics.metrics.StringMetrics: Deprecated.
Use StringMetricBuilder in favor of directly constructing a metric.
createForSetMetric(Metric<Set<String>>, Tokenizer) - Static method in class org.simmetrics.metrics.StringMetrics: Deprecated.
Use StringMetricBuilder in favor of directly constructing a 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: Deprecated.
will be removed due to a lack of a good use case
DaitchMokotoffSoundex() - Constructor for class org.simmetrics.simplifiers.DaitchMokotoffSoundex: Deprecated.

Creates a new instance with ASCII-folding enabled.
DaitchMokotoffSoundex(boolean) - Constructor for class org.simmetrics.simplifiers.DaitchMokotoffSoundex: Deprecated.

Creates a new DaitchMokotoffSoundex simplifier.
DamerauLevenshtein - Class in org.simmetrics.metrics: Calculates the Damerau-Levenshtein similarity and distance 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.metrics.StringDistances: Returns a string distance metric that uses a DamerauLevenshtein metric.
damerauLevenshtein() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a Damerau-Levenshtein similarity metric over tokens in a string.
Dice<T> - Class in org.simmetrics.metrics: Calculates the Dice similarity coefficient and distance over two sets.
Dice() - Constructor for class org.simmetrics.metrics.Dice
dice() - Static method in class org.simmetrics.metrics.StringDistances: Returns a string distance metric that uses a Tokenizers.whitespace() and the Dice metric.
dice() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a Dice similarity metric over tokens in a string.
Distance<T> - Interface in org.simmetrics: Measures the unnormalized dissimilarity 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(Multiset<T>, Multiset<T>) - Method in class org.simmetrics.metrics.BlockDistance
distance(Multiset<T>, Multiset<T>) - Method in class org.simmetrics.metrics.CosineSimilarity
distance(String, String) - Method in class org.simmetrics.metrics.DamerauLevenshtein
distance(Set<T>, Set<T>) - Method in class org.simmetrics.metrics.Dice
distance(Multiset<T>, Multiset<T>) - Method in class org.simmetrics.metrics.EuclideanDistance
distance(Multiset<T>, Multiset<T>) - Method in class org.simmetrics.metrics.GeneralizedJaccard
distance(T, T) - Method in class org.simmetrics.metrics.Identity
distance(Set<T>, Set<T>) - Method in class org.simmetrics.metrics.Jaccard
distance(String, String) - Method in class org.simmetrics.metrics.Jaro
distance(String, String) - Method in class org.simmetrics.metrics.JaroWinkler
distance(String, String) - Method in class org.simmetrics.metrics.Levenshtein
distance(String, String) - Method in class org.simmetrics.metrics.LongestCommonSubsequence
distance(String, String) - Method in class org.simmetrics.metrics.LongestCommonSubstring
distance(Set<T>, Set<T>) - Method in class org.simmetrics.metrics.OverlapCoefficient
distance(Multiset<T>, Multiset<T>) - Method in class org.simmetrics.metrics.SimonWhite
distance(Multiset<E>, Multiset<E>) - Method in interface org.simmetrics.MultisetDistance: Measures the distance between multisets a and b.
distance(Set<E>, Set<E>) - Method in interface org.simmetrics.SetDistance: Measures the distance between sets a and b.
distance(String, String) - Method in interface org.simmetrics.StringDistance: Measures the distance between string a and b.
DoubleMetaphone - Class in org.simmetrics.simplifiers: Deprecated.
will be removed due to a lack of a good use case
DoubleMetaphone() - Constructor for class org.simmetrics.simplifiers.DoubleMetaphone: Deprecated.

Creates an instance of this DoubleMetaphone encoder
DoubleMetaphone(int, boolean) - Constructor for class org.simmetrics.simplifiers.DoubleMetaphone: Deprecated.

Creates an instance of the DoubleMetaphone simplifier with a maxCodeLength.

E

EuclideanDistance<T> - Class in org.simmetrics.metrics: Calculates the Euclidean distance and similarity over two multisets.
EuclideanDistance() - Constructor for class org.simmetrics.metrics.EuclideanDistance
euclideanDistance() - Static method in class org.simmetrics.metrics.StringDistances: Returns a string distance metric that uses a Tokenizers.whitespace() and the EuclideanDistance metric.
euclideanDistance() - Static method in class org.simmetrics.metrics.StringMetrics: Returns an Euclidean distance similarity metric over tokens in a string.

F

filter(Predicate<String>) - Method in interface org.simmetrics.builders.StringDistanceBuilder.CollectionDistanceTokenizerStep: Adds a filter step to the distance.
filter(Predicate<String>) - Method in interface org.simmetrics.builders.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.
GeneralizedJaccard<T> - Class in org.simmetrics.metrics: Calculates the generalized Jaccard distance and similarity coefficient over two multisets.
GeneralizedJaccard() - Constructor for class org.simmetrics.metrics.GeneralizedJaccard
generalizedJaccard() - Static method in class org.simmetrics.metrics.StringDistances: Returns a string distance metric that uses a Tokenizers.whitespace() and the GeneralizedJaccard metric.
generalizedJaccard() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a generalized Jaccard similarity metric over tokens in a string.
GeneralizedOverlapCoefficient<T> - Class in org.simmetrics.metrics: The generalized overlap coefficient measures the overlap between two multisets.
GeneralizedOverlapCoefficient() - Constructor for class org.simmetrics.metrics.GeneralizedOverlapCoefficient

H

HammingDistance - Class in org.simmetrics.metrics: Calculates the Hamming distance distance between lists and strings.
hammingDistance() - Static method in class org.simmetrics.metrics.StringDistances: Returns a string distance metric that uses the HammingDistance metric.

I

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

J

Jaccard<T> - Class in org.simmetrics.metrics: Calculates the Jaccard distance and similarity coefficient over two multisets.
Jaccard() - Constructor for class org.simmetrics.metrics.Jaccard
jaccard() - Static method in class org.simmetrics.metrics.StringDistances: Returns a string distance metric that uses a Tokenizers.whitespace() and the Jaccard metric.
jaccard() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a Jaccard similarity metric over tokens in a string.
Jaro - Class in org.simmetrics.metrics: Calculates the Jaro distance (similarity) over two strings.
Jaro() - Constructor for class org.simmetrics.metrics.Jaro
jaro() - Static method in class org.simmetrics.metrics.StringDistances: Returns a string distance metric that uses the Jaro metric.
jaro() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a Jaro string similarity metric.
JaroWinkler - Class in org.simmetrics.metrics: Calculates the Jaro-Winkler distance (similarity) over 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.metrics.StringDistances: Returns a string distance metric that uses the JaroWinkler metric.
jaroWinkler() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a Jaro-Winkler string similarity metric.

L

Levenshtein - Class in org.simmetrics.metrics: Calculates the Levenshtein distance and similarity over 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.metrics.StringDistances: Returns a string distance metric that uses the Levenshtein metric.
levenshtein() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a Levenshtein string similarity 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 unnormalized dissimilarity 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.
LongestCommonSubsequence - Class in org.simmetrics.metrics: Applies the longest common subsequence algorithm to calculate the similarity and distance between two strings.
LongestCommonSubsequence() - Constructor for class org.simmetrics.metrics.LongestCommonSubsequence
longestCommonSubsequence() - Static method in class org.simmetrics.metrics.StringDistances: Returns a string distance metric that uses the LongestCommonSubsequence metric.
longestCommonSubsequence() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a string similarity metric that uses the LongestCommonSubsequence metric.
LongestCommonSubstring - Class in org.simmetrics.metrics: Applies the longest common substring algorithm to calculate the similarity and distance between two strings.
LongestCommonSubstring() - Constructor for class org.simmetrics.metrics.LongestCommonSubstring
longestCommonSubstring() - Static method in class org.simmetrics.metrics.StringDistances: Returns a string distance metric that uses the LongestCommonSubstring metric.
longestCommonSubstring() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a similarity metric that uses the LongestCommonSubstring metric.

M

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: Deprecated.
will be removed due to a lack of a good use case
MatchRatingApproach() - Constructor for class org.simmetrics.simplifiers.MatchRatingApproach: 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
Metaphone - Class in org.simmetrics.simplifiers: Deprecated.
will be removed due to a lack of a good use case
Metaphone() - Constructor for class org.simmetrics.simplifiers.Metaphone: Deprecated.

Creates an instance of the Metaphone simplifier
Metaphone(int) - Constructor for class org.simmetrics.simplifiers.Metaphone: Deprecated.

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
MongeElkan - Class in org.simmetrics.metrics: Calculates the normalized Monge-Elkan distance (similarity) over two strings.
MongeElkan(StringMetric) - Constructor for class org.simmetrics.metrics.MongeElkan: Constructs a Monge-Elkan metric with metric.
mongeElkan() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a normalized Monge-Elkan metric over tokens in a string.
MultisetDistance<E> - Interface in org.simmetrics: Measures the unnormalized dissimilarity between two arbitrary multisets containing elements of the same type.
MultisetMetric<T> - Interface in org.simmetrics: Measures the similarity between two arbitrary multisets containing elements of the same type.

N

NeedlemanWunch - Class in org.simmetrics.metrics: Applies the Needleman-Wunsch algorithm to calculate the similarity 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.metrics.StringMetrics: Returns a Needleman-Wunch string similarity metric.
normalize(Normalizer.Form) - Static method in class org.simmetrics.simplifiers.Simplifiers: Returns a simplifier that normalizes the input into a composed or decomposed form
Nysiis - Class in org.simmetrics.simplifiers: Deprecated.
will be removed due to a lack of a good use case
Nysiis() - Constructor for class org.simmetrics.simplifiers.Nysiis: Deprecated.

Creates an instance of the Nysiis encoder with strict mode (original form), i.e.
Nysiis(boolean) - Constructor for class org.simmetrics.simplifiers.Nysiis: Deprecated.

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.builders - package org.simmetrics.builders
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
OverlapCoefficient<T> - Class in org.simmetrics.metrics: The overlap coefficient measures the overlap between two sets.
OverlapCoefficient() - Constructor for class org.simmetrics.metrics.OverlapCoefficient
overlapCoefficient() - Static method in class org.simmetrics.metrics.StringDistances: Returns a string distance metric that uses a Tokenizers.whitespace() and the OverlapCoefficient distance metric.
overlapCoefficient() - Static method in class org.simmetrics.metrics.StringMetrics: Returns an overlap coefficient similarity metric over tokens in a string.

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(int) - Static method in class org.simmetrics.tokenizers.Tokenizers: Returns a q-gram tokenizer for a variable q.
qGramsDistance() - Static method in class org.simmetrics.metrics.StringDistances: Returns a string distance metric that uses a Tokenizers.qGramWithPadding(int) for q=3 and the BlockDistance metric.
qGramsDistance() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a q-grams distance similarity metric.
qGramWithFilter(int) - Static method in class org.simmetrics.tokenizers.Tokenizers: Returns a q-gram tokenizer for a variable q.The tokenizer will return an empty collection if the input is empty or shorter then q.
qGramWithPadding(int) - Static method in class org.simmetrics.tokenizers.Tokenizers: Returns a q-gram tokenizer for a variable q.
qGramWithPadding(int, String) - Static method in class org.simmetrics.tokenizers.Tokenizers: Returns a q-gram tokenizer for a variable q.
qGramWithPadding(int, String, String) - Static method in class org.simmetrics.tokenizers.Tokenizers: Returns a q-gram tokenizer for a variable q.The q-gram is extended beyond the length of the string with padding.

R

RefinedSoundex - Class in org.simmetrics.simplifiers: Deprecated.
will be removed due to a lack of a good use case
RefinedSoundex() - Constructor for class org.simmetrics.simplifiers.RefinedSoundex: Deprecated.
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

SetDistance<E> - Interface in org.simmetrics: Measures the unnormalized dissimilarity between two arbitrary sets containing elements of the same type.
SetMetric<T> - Interface in org.simmetrics: Measures the similarity between two arbitrary sets containing elements of the same type.
SimonWhite<T> - Class in org.simmetrics.metrics: Calculates the Dice similarity coefficient and distance over two multisets.
SimonWhite() - Constructor for class org.simmetrics.metrics.SimonWhite
simonWhite() - Static method in class org.simmetrics.metrics.StringDistances: Returns a string distance metric that uses a Tokenizers.whitespace() followed by a Tokenizers.qGramWithPadding(int) for q=2 and the SimonWhite metric.
simonWhite() - Static method in class org.simmetrics.metrics.StringMetrics: Returns a Simon White similarity metric.
Simplifier - Interface in org.simmetrics.simplifiers: Transforms a string into a simpler form.
Simplifiers - Class in org.simmetrics.simplifiers: Construct simple simplifiers or chain multiple simplifiers into a single simplifier.
simplify(Simplifier) - Method in interface org.simmetrics.builders.StringDistanceBuilder.CollectionDistanceInitialSimplifierStep: Adds a simplifier to the distance.
simplify(Simplifier) - Method in interface org.simmetrics.builders.StringDistanceBuilder.CollectionDistanceSimplifierStep: Adds a simplifier to the distance.
simplify(Simplifier) - Method in interface org.simmetrics.builders.StringDistanceBuilder.StringDistanceInitialSimplifierStep: Adds a simplifier to the distance.
simplify(Simplifier) - Method in interface org.simmetrics.builders.StringDistanceBuilder.StringDistanceSimplifierStep: Adds a simplifier to the distance.
simplify(Simplifier) - Method in interface org.simmetrics.builders.StringMetricBuilder.CollectionMetricInitialSimplifierStep: Adds a simplifier to the metric.
simplify(Simplifier) - Method in interface org.simmetrics.builders.StringMetricBuilder.CollectionMetricSimplifierStep: Adds a simplifier to the metric.
simplify(Simplifier) - Method in interface org.simmetrics.builders.StringMetricBuilder.StringMetricInitialSimplifierStep: Adds a simplifier to the metric.
simplify(Simplifier) - Method in interface org.simmetrics.builders.StringMetricBuilder.StringMetricSimplifierStep: Adds a simplifier to the metric.
simplify(String) - Method in class org.simmetrics.simplifiers.Caverphone1: Deprecated.
simplify(String) - Method in class org.simmetrics.simplifiers.Caverphone2: Deprecated.
simplify(String) - Method in class org.simmetrics.simplifiers.ColognePhonetic: Deprecated.
simplify(String) - Method in class org.simmetrics.simplifiers.DaitchMokotoffSoundex: Deprecated.
simplify(String) - Method in class org.simmetrics.simplifiers.DoubleMetaphone: Deprecated.
simplify(String) - Method in class org.simmetrics.simplifiers.MatchRatingApproach: Deprecated.
simplify(String) - Method in class org.simmetrics.simplifiers.Metaphone: Deprecated.
simplify(String) - Method in class org.simmetrics.simplifiers.Nysiis: Deprecated.
simplify(String) - Method in class org.simmetrics.simplifiers.RefinedSoundex: Deprecated.
simplify(String) - Method in interface org.simmetrics.simplifiers.Simplifier: Simplifiers the input string.
simplify(String) - Method in class org.simmetrics.simplifiers.Soundex: Deprecated.
SmithWaterman - Class in org.simmetrics.metrics: Applies the Smith-Waterman algorithm to calculate the similarity 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.metrics.StringMetrics: Returns a Smith-Waterman string similarity metric.
SmithWatermanGotoh - Class in org.simmetrics.metrics: Applies the Smith-Waterman algorithm to calculate the similarity 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.metrics.StringMetrics: Returns a Smith-Waterman-Gotoh string similarity metric.
soundex() - Static method in class org.simmetrics.metrics.StringMetrics: Deprecated.
will be removed due to a lack of a good use case
Soundex - Class in org.simmetrics.simplifiers: Deprecated.
will be removed due to a lack of a good use case
Soundex() - Constructor for class org.simmetrics.simplifiers.Soundex: Deprecated.
StringDistance - Interface in org.simmetrics: Measures the unnormalized dissimilarity between two Strings.
StringDistanceBuilder - Class in org.simmetrics.builders: Convenience tool to build string distance metrics.
StringDistanceBuilder.BuildStep - Interface in org.simmetrics.builders
StringDistanceBuilder.CollectionDistanceInitialSimplifierStep<T extends Collection<String>> - Interface in org.simmetrics.builders
StringDistanceBuilder.CollectionDistanceInitialTokenizerStep<T extends Collection<String>> - Interface in org.simmetrics.builders
StringDistanceBuilder.CollectionDistanceSimplifierStep<T extends Collection<String>> - Interface in org.simmetrics.builders
StringDistanceBuilder.CollectionDistanceTokenizerStep<T extends Collection<String>> - Interface in org.simmetrics.builders
StringDistanceBuilder.StringDistanceInitialSimplifierStep - Interface in org.simmetrics.builders
StringDistanceBuilder.StringDistanceSimplifierStep - Interface in org.simmetrics.builders
StringDistances - Class in org.simmetrics.metrics: Utility class for string distance metrics.
StringDistances() - Constructor for class org.simmetrics.metrics.StringDistances
StringMetric - Interface in org.simmetrics: Measures the similarity between two strings.
StringMetricBuilder - Class in org.simmetrics.builders: Convenience tool to build string similarity metrics.
StringMetricBuilder.BuildStep - Interface in org.simmetrics.builders
StringMetricBuilder.CollectionMetricInitialSimplifierStep<T extends Collection<String>> - Interface in org.simmetrics.builders
StringMetricBuilder.CollectionMetricInitialTokenizerStep<T extends Collection<String>> - Interface in org.simmetrics.builders
StringMetricBuilder.CollectionMetricSimplifierStep<T extends Collection<String>> - Interface in org.simmetrics.builders
StringMetricBuilder.CollectionMetricTokenizerStep<T extends Collection<String>> - Interface in org.simmetrics.builders
StringMetricBuilder.StringMetricInitialSimplifierStep - Interface in org.simmetrics.builders
StringMetricBuilder.StringMetricSimplifierStep - Interface in org.simmetrics.builders
StringMetrics - Class in org.simmetrics.metrics: Utility class for string similarity metrics.
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

TanimotoCoefficient<T> - Class in org.simmetrics.metrics: Calculates the Tanimoto similarity coefficient over two sets.
TanimotoCoefficient() - Constructor for class org.simmetrics.metrics.TanimotoCoefficient
tokenize(Tokenizer) - Method in interface org.simmetrics.builders.StringDistanceBuilder.CollectionDistanceInitialSimplifierStep: Adds a tokenization step to the distance.
tokenize(Tokenizer) - Method in interface org.simmetrics.builders.StringDistanceBuilder.CollectionDistanceInitialTokenizerStep: Adds a tokenization step to the distance.
tokenize(Tokenizer) - Method in interface org.simmetrics.builders.StringDistanceBuilder.CollectionDistanceSimplifierStep: Adds a tokenization step to the distance.
tokenize(Tokenizer) - Method in interface org.simmetrics.builders.StringDistanceBuilder.CollectionDistanceTokenizerStep: Adds a tokenization step to the distance.
tokenize(Tokenizer) - Method in interface org.simmetrics.builders.StringMetricBuilder.CollectionMetricInitialSimplifierStep: Adds a tokenization step to the metric.
tokenize(Tokenizer) - Method in interface org.simmetrics.builders.StringMetricBuilder.CollectionMetricInitialTokenizerStep: Adds a tokenization step to the metric.
tokenize(Tokenizer) - Method in interface org.simmetrics.builders.StringMetricBuilder.CollectionMetricSimplifierStep: Adds a tokenization step to the metric.
tokenize(Tokenizer) - Method in interface org.simmetrics.builders.StringMetricBuilder.CollectionMetricTokenizerStep: Adds a tokenization step to the metric.
Tokenizer - Interface in org.simmetrics.tokenizers: A tokenizer divides an input string into tokens.
Tokenizers - Class in org.simmetrics.tokenizers: Construct simple tokenizers, chains multiple tokenizers into a single tokenizer or creates a tokenizers that apply filters and transforms to tokens.
tokenizeToList(String) - Method in interface org.simmetrics.tokenizers.Tokenizer: Return tokenized version of a string as a list of tokens.
tokenizeToMultiset(String) - Method in class org.simmetrics.tokenizers.AbstractTokenizer
tokenizeToMultiset(String) - Method in interface org.simmetrics.tokenizers.Tokenizer: Return tokenized version of a string as a multiset of tokens.
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.
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.Dice
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.GeneralizedJaccard
toString() - Method in class org.simmetrics.metrics.GeneralizedOverlapCoefficient
toString() - Method in class org.simmetrics.metrics.Identity
toString() - Method in class org.simmetrics.metrics.Jaccard
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.LongestCommonSubsequence
toString() - Method in class org.simmetrics.metrics.LongestCommonSubstring
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.metrics.TanimotoCoefficient
toString() - Method in class org.simmetrics.simplifiers.Caverphone1: Deprecated.
toString() - Method in class org.simmetrics.simplifiers.Caverphone2: Deprecated.
toString() - Method in class org.simmetrics.simplifiers.ColognePhonetic: Deprecated.
toString() - Method in class org.simmetrics.simplifiers.DaitchMokotoffSoundex: Deprecated.
toString() - Method in class org.simmetrics.simplifiers.DoubleMetaphone: Deprecated.
toString() - Method in class org.simmetrics.simplifiers.MatchRatingApproach: Deprecated.
toString() - Method in class org.simmetrics.simplifiers.Metaphone: Deprecated.
toString() - Method in class org.simmetrics.simplifiers.Nysiis: Deprecated.
toString() - Method in class org.simmetrics.simplifiers.RefinedSoundex: Deprecated.
toString() - Method in class org.simmetrics.simplifiers.Soundex: 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.builders.StringDistanceBuilder.CollectionDistanceTokenizerStep: Adds a transform step to the distance.
transform(Function<String, String>) - Method in interface org.simmetrics.builders.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.

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.
with(StringDistance) - Static method in class org.simmetrics.builders.StringDistanceBuilder: Starts building a distance metric with a string distance metric.
with(ListDistance<String>) - Static method in class org.simmetrics.builders.StringDistanceBuilder: Starts building a distance with a list distance.
with(SetDistance<String>) - Static method in class org.simmetrics.builders.StringDistanceBuilder: Starts building a distance with a set distance.
with(MultisetDistance<String>) - Static method in class org.simmetrics.builders.StringDistanceBuilder: Starts building a distance with a multiset distance.
with(StringMetric) - Static method in class org.simmetrics.builders.StringMetricBuilder: Starts building a metric with a string similarity metric.
with(ListMetric<String>) - Static method in class org.simmetrics.builders.StringMetricBuilder: Starts building a metric with a list metric.
with(SetMetric<String>) - Static method in class org.simmetrics.builders.StringMetricBuilder: Starts building a metric with a set metric.
with(MultisetMetric<String>) - Static method in class org.simmetrics.builders.StringMetricBuilder: Starts building a metric with a multiset metric.

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