Package com.mongodb.client.model.search

Interface GaussSearchScoreExpression

All Superinterfaces:

Bson, SearchScoreExpression

@Sealed
@Beta(CLIENT)
public interface GaussSearchScoreExpression
extends SearchScoreExpression

Since:

4.7

See Also:

• SearchScoreExpression.gaussExpression(double, PathSearchScoreExpression, double)

Field Summary

Fields inherited from interface org.bson.conversions.Bson

DEFAULT_CODEC_REGISTRY

Method Summary

Modifier and Type	Method	Description
GaussSearchScoreExpression	decay(double decay)	Creates a new GaussSearchScoreExpression with the factor by which the output of the Gaussian function must decay at distance scale.
GaussSearchScoreExpression	offset(double offset)	Creates a new GaussSearchScoreExpression which does not decay, i.e., its output stays 1, if the value of the path expression is within the interval [origin - offset; origin + offset].

Methods inherited from interface org.bson.conversions.Bson

toBsonDocument, toBsonDocument

Method Details

offset

GaussSearchScoreExpression offset(double offset)

Creates a new GaussSearchScoreExpression which does not decay, i.e., its output stays 1, if the value of the path expression is within the interval [origin - offset; origin + offset].

Parameters:

offset - The offset from the origin where no decay happens.

Returns:

A new GaussSearchScoreExpression.

decay

GaussSearchScoreExpression decay(double decay)

Creates a new GaussSearchScoreExpression with the factor by which the output of the Gaussian function must decay at distance scale.

Parameters:

decay - The decay.

Returns:

A new GaussSearchScoreExpression.