Class SimilarityNormalizer

java.lang.Object

io.micronaut.data.runtime.operations.internal.sql.SimilarityNormalizer

@Internal
public final class SimilarityNormalizer
extends Object

Converts dialect-specific vector scores into normalized similarities and back.

Since:

5.0.0

Method Summary

Modifier and Type	Method	Description
static SimilarityNormalizer	forScoringFunction(ScoringFunction scoringFunction)	Resolves normalizer for a scoring function.
double	getScore(double similarityValue)	Converts normalized similarity into score.
double	getSimilarity(double scoreValue)	Converts score into normalized similarity.
static SimilarityNormalizer	identity()	Returns identity score/similarity normalization.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

identity

public static SimilarityNormalizer identity()

Returns identity score/similarity normalization.

Returns:

identity normalizer

forScoringFunction

public static SimilarityNormalizer forScoringFunction(ScoringFunction scoringFunction)

Resolves normalizer for a scoring function.

Parameters:

scoringFunction - scoring function

Returns:

matching normalizer or identity when no explicit mapping exists

getSimilarity

public double getSimilarity(double scoreValue)

Converts score into normalized similarity.

Parameters:

scoreValue - raw score value

Returns:

normalized similarity value

getScore

public double getScore(double similarityValue)

Converts normalized similarity into score.

Parameters:

similarityValue - normalized similarity value

Returns:

raw score value