Package org.elasticsearch.xpack.esql.expression.function.vector

Class Hamming

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<Expression>

org.elasticsearch.xpack.esql.core.expression.Expression

org.elasticsearch.xpack.esql.core.expression.function.Function

org.elasticsearch.xpack.esql.core.expression.function.scalar.ScalarFunction

org.elasticsearch.xpack.esql.core.expression.function.scalar.BinaryScalarFunction

org.elasticsearch.xpack.esql.expression.function.vector.VectorSimilarityFunction

org.elasticsearch.xpack.esql.expression.function.vector.Hamming

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, EvaluatorMapper, BlockLoaderExpression, VectorFunction

public class Hamming
extends VectorSimilarityFunction

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.expression.function.blockloader.BlockLoaderExpression

BlockLoaderExpression.PushedBlockLoaderExpression

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper

EvaluatorMapper.ToEvaluator

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final NamedWriteableRegistry.Entry	ENTRY
static final DenseVectorFieldMapper.SimilarityFunction	EVALUATOR_SIMILARITY_FUNCTION
static final DenseVectorFieldMapper.SimilarityFunction	SIMILARITY_FUNCTION

Fields inherited from class org.elasticsearch.xpack.esql.core.expression.function.scalar.ScalarFunction

MAX_BYTES_REF_RESULT_SIZE

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
Hamming(Source source, Expression left, Expression right)

Method Summary

Modifier and Type	Method	Description
static float	calculateSimilarity(byte[] leftScratch, byte[] rightScratch)
DenseVectorFieldMapper.SimilarityFunction	getEvaluatorSimilarityFunction()
DenseVectorFieldMapper.SimilarityFunction	getSimilarityFunction()	Returns the similarity function to be used for evaluating the similarity between two vectors.
String	getWriteableName()
protected NodeInfo<? extends Expression>	info()
protected BinaryScalarFunction	replaceChildren(Expression newLeft, Expression newRight)

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.vector.VectorSimilarityFunction

dataType, fold, resolveType, toEvaluator, tryPushToFieldLoading

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.scalar.BinaryScalarFunction

foldable, left, replaceChildren, right, writeTo

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function

arguments, equals, functionName, hashCode, nodeString, nullable

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, canonicalize, childrenResolved, propertiesToString, references, resolved, semanticEquals, semanticHash, toString, typeResolved

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformDown, transformDown, transformDown, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper

fold

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

SIMILARITY_FUNCTION

public static final DenseVectorFieldMapper.SimilarityFunction SIMILARITY_FUNCTION

EVALUATOR_SIMILARITY_FUNCTION

public static final DenseVectorFieldMapper.SimilarityFunction EVALUATOR_SIMILARITY_FUNCTION

Constructor Details

Hamming

public Hamming(Source source,
 Expression left,
 Expression right)

Method Details

getSimilarityFunction

public DenseVectorFieldMapper.SimilarityFunction getSimilarityFunction()

Description copied from class: VectorSimilarityFunction

Returns the similarity function to be used for evaluating the similarity between two vectors.

Specified by:

getSimilarityFunction in class VectorSimilarityFunction

getEvaluatorSimilarityFunction

public DenseVectorFieldMapper.SimilarityFunction getEvaluatorSimilarityFunction()

Overrides:

getEvaluatorSimilarityFunction in class VectorSimilarityFunction

replaceChildren

protected BinaryScalarFunction replaceChildren(Expression newLeft,
 Expression newRight)

Specified by:

replaceChildren in class BinaryScalarFunction

info

protected NodeInfo<? extends Expression> info()

Specified by:

info in class Node<Expression>

getWriteableName

public String getWriteableName()

calculateSimilarity

public static float calculateSimilarity(byte[] leftScratch,
 byte[] rightScratch)