HStringSimilarity (com.gengoai:hermes 1.1-SNAPSHOT API)

All Known Implementing Classes:

EmbeddingSimilarity, ExtractorBasedSimilarity
```
public interface HStringSimilarity
```
Interface defining a methodology for computing the similarity between two HString.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`double`	`calculate(@NonNull HString first, @NonNull HString second)`	Calculates the similarity between the two given `HString`
`void`	`fit(@NonNull DocumentCollection corpus)`	In certain cases a HStringSimilarity needs to collect corpus level statistics to determine similarity.

- Method Detail
  - calculate
```
double calculate(@NonNull
                 @NonNull HString first,
                 @NonNull
                 @NonNull HString second)
```
    Calculates the similarity between the two given HString
    
    Parameters:
    
    first - the first HString
    
    second - the second HString
    
    Returns:
    
    the similarity between first and second
  - fit
```
void fit(@NonNull
         @NonNull DocumentCollection corpus)
```
    In certain cases a HStringSimilarity needs to collect corpus level statistics to determine similarity. The fit method allows implementations to perform this logic at a corpus level.
    
    Parameters:
    
    corpus - the corpus to fit the similarity measure to