Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | List of all members
SpellChecker.Net.Search.Spell.StringDistance Interface Reference

Interface for string distances. More...

Inherited by SpellChecker.Net.Search.Spell.JaroWinklerDistance, SpellChecker.Net.Search.Spell.LevenshteinDistance, and SpellChecker.Net.Search.Spell.NGramDistance.

Public Member Functions

float GetDistance (String s1, String s2)
 Returns a float between 0 and 1 based on how similar the specified strings are to one another. Returning a value of 1 means the specified strings are identical and 0 means the string are maximally different.
 

Detailed Description

Interface for string distances.

Definition at line 26 of file StringDistance.cs.

Member Function Documentation

float SpellChecker.Net.Search.Spell.StringDistance.GetDistance ( String  s1,
String  s2 
)

Returns a float between 0 and 1 based on how similar the specified strings are to one another. Returning a value of 1 means the specified strings are identical and 0 means the string are maximally different.

Parameters
s1The first string.
s2The second string.
Returns
a float between 0 and 1 based on how similar the specified strings are to one another.

Implemented in SpellChecker.Net.Search.Spell.JaroWinklerDistance, SpellChecker.Net.Search.Spell.NGramDistance, and SpellChecker.Net.Search.Spell.LevenshteinDistance.


The documentation for this interface was generated from the following file: