Index
All Classes and Interfaces|All Packages|Serialized Form
A
- add(String) - Method in class approdictio.dict.NgramDict
- add(String, int) - Method in class approdictio.dict.Didyoumean
-
adds a term together with its assigned weight.
- add(T) - Method in interface approdictio.dict.Dictionary
-
adds the given value to the dictionary.
- add(V) - Method in class approdictio.dict.BKTree
-
adds the value to the tree.
- addFile(Reader, char) - Method in class approdictio.dict.Didyoumean
-
feeds
Didyoumeanwith terms and weights from aReader. - addFile(String, char, String) - Method in class approdictio.dict.Didyoumean
-
feeds the
Didyoumeanwith terms and weights from a file. - Approdictio - Search tag in Overview
- Section
- approdictio.dict - package approdictio.dict
-
Dictionaries for approximate lookup.
- approdictio.levenshtein - package approdictio.levenshtein
-
Levensthein metric with customizable cost functions.
B
- BKStableLookup<W> - Class in approdictio.dict
-
is an iterator that returns lookup results in a
BKTreeaccording to an order provided. - BKStableLookup(BKTree<W>, W, int, Comparator<W>) - Constructor for class approdictio.dict.BKStableLookup
-
creates an iterator to extract values from the given
BKTreethat have at mostmaxDistdistance to thequeryValueaccording to the tree's metric. - BKTree<V> - Class in approdictio.dict
-
a dictionary implementation using Burkhard Keller Trees.
- BKTree(IntMetric<V>) - Constructor for class approdictio.dict.BKTree
-
creates a BKTree to store objects of type T while using the metric provided to organize lookup.
C
- caseIgnore - Static variable in class approdictio.levenshtein.CostFunctions
-
is a
LevenCostsimplementation that ignores character case. - CostFunctions - Class in approdictio.levenshtein
-
provides several implementations of
LevenCosts.
D
- d - Variable in class approdictio.dict.ResultElem
-
the distance of this value from the queried value
- d(String, String) - Method in class approdictio.dict.LengthMetric
- d(String, String) - Method in class approdictio.levenshtein.LevenshteinMetric
-
computes the Levenshtein edit distance between the given strings according to the cost function provided at construction of this object.
- d(T, T) - Method in interface approdictio.dict.IntMetric
-
computes the distance between the two given objects.
- defaultCosts - Static variable in class approdictio.levenshtein.CostFunctions
-
provides the default implementation of
LevenCostswhere all operations have cost 1. - Dictionary<T,
DTYPE> - Interface in approdictio.dict -
defines a dictionary for approximate lookup.
- Didyoumean - Class in approdictio.dict
-
is an implementation of a did you mean based on a
Dictionary.
F
- FileFormatException - Exception Class in approdictio.dict
-
is the exception thrown if a file read does contain format errors.
- FileFormatException(String, int) - Constructor for exception class approdictio.dict.FileFormatException
- FileFormatException(String, int, Throwable) - Constructor for exception class approdictio.dict.FileFormatException
G
- getDictClass() - Method in class approdictio.dict.Didyoumean
-
to support inspection and debugging, the class (not the object) of the internally used
Dictionaryis returned. - getFilename() - Method in exception class approdictio.dict.FileFormatException
- getLineNo() - Method in exception class approdictio.dict.FileFormatException
-
the number of the line with the error
- getMessage() - Method in exception class approdictio.dict.FileFormatException
H
- hasNext() - Method in class approdictio.dict.BKStableLookup
I
- insdelCost(char) - Method in interface approdictio.levenshtein.LevenCosts
-
must provide the cost of inserting or deleting a given character.
- instanceBKTree(IntMetric<String>) - Static method in class approdictio.dict.Didyoumean
-
creates a
Didyoumeanbacked by aBKTree. - instanceNgramDict(int, IntMetric<String>) - Static method in class approdictio.dict.Didyoumean
-
creates a
Didyoumeanbacked by anNgramDict. - IntMetric<T> - Interface in approdictio.dict
-
defines a function to compute an integer valued metric.
L
- LengthMetric - Class in approdictio.dict
-
is a trivial example of
IntMetricthat uses the difference of string length as the distance value. - LengthMetric() - Constructor for class approdictio.dict.LengthMetric
- LevenCosts - Interface in approdictio.levenshtein
-
Defines the methods necessary to parameterize the cost of the
LevenshteinMetric. - LevenshteinMetric - Class in approdictio.levenshtein
-
is an implementation of the Levenshtein edit distance (or metric).
- LevenshteinMetric() - Constructor for class approdictio.levenshtein.LevenshteinMetric
-
provides a metric with the default costs as provided by
CostFunctions.defaultCosts. - LevenshteinMetric(LevenCosts) - Constructor for class approdictio.levenshtein.LevenshteinMetric
-
creates a metric based on the given costs for edit operations.
- lookup(String, Integer) - Method in class approdictio.dict.Didyoumean
-
looks up the word in the internal
Dictionaryand then filters for the term with the heighest weight according to the weights provied whenadding a term. - lookup(String, Integer) - Method in class approdictio.dict.NgramDict
- lookup(T, DTYPE) - Method in interface approdictio.dict.Dictionary
-
looks up
queryValuein the dictionary and returns values that are sufficiently similar or close to the query value according to the givenlimit. - lookup(V, Integer) - Method in class approdictio.dict.BKTree
-
looks up the given value and returns all values stored that are at most
maxDistaway from the given value. - lookupDistinct(String, Integer) - Method in class approdictio.dict.Didyoumean
-
like
lookup()but never returns theworditself, even if it is in the dictionary. - lookupDistinct(String, Integer) - Method in class approdictio.dict.NgramDict
- lookupDistinct(T, DTYPE) - Method in interface approdictio.dict.Dictionary
-
looks up
queryValuein the dictionary and returns similar values, but never thequeryValueitself. - lookupDistinct(V, Integer) - Method in class approdictio.dict.BKTree
N
- next() - Method in class approdictio.dict.BKStableLookup
- NgramDict - Class in approdictio.dict
-
a dictionary for fast approximate lookup of words.
- NgramDict(int, IntMetric<String>) - Constructor for class approdictio.dict.NgramDict
-
creates a dictionary that uses n-grams with
ngramLencharacters.
R
- remove() - Method in class approdictio.dict.BKStableLookup
-
is not supported.
- ResultElem<T,
DTYPE> - Class in approdictio.dict -
defines result elements returned by
lookup().
S
- setComputeTimeoutMillis(long) - Method in class approdictio.dict.BKStableLookup
-
restrict the maximum compute time for all
BKStableLookup.next()calls to the given timeout. - setFilename(String) - Method in exception class approdictio.dict.FileFormatException
- substCost(char, char) - Method in interface approdictio.levenshtein.LevenCosts
-
must provide the cost of replacing one character with the other.
T
- toString() - Method in class approdictio.dict.ResultElem
V
- value - Variable in class approdictio.dict.ResultElem
-
the value found in the
Dictionary
All Classes and Interfaces|All Packages|Serialized Form