Package com.azure.resourcemanager.cosmos.models

Class DistanceFunction

java.lang.Object

com.azure.core.util.ExpandableStringEnum<DistanceFunction>

com.azure.resourcemanager.cosmos.models.DistanceFunction

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class DistanceFunction
extends com.azure.core.util.ExpandableStringEnum<DistanceFunction>

The distance function to use for distance calculation in between vectors.

Field Summary

Fields

Modifier and Type	Field	Description
static final DistanceFunction	COSINE	Static value cosine for DistanceFunction.
static final DistanceFunction	DOTPRODUCT	Static value dotproduct for DistanceFunction.
static final DistanceFunction	EUCLIDEAN	Static value euclidean for DistanceFunction.

Constructor Summary

Constructors

Constructor	Description
DistanceFunction()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static DistanceFunction	fromString(String name)	Creates or finds a DistanceFunction from its string representation.
static Collection<DistanceFunction>	values()	Gets known DistanceFunction values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

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

Field Details

EUCLIDEAN

public static final DistanceFunction EUCLIDEAN

Static value euclidean for DistanceFunction.

COSINE

public static final DistanceFunction COSINE

Static value cosine for DistanceFunction.

DOTPRODUCT

public static final DistanceFunction DOTPRODUCT

Static value dotproduct for DistanceFunction.

Constructor Details

DistanceFunction

@Deprecated
public DistanceFunction()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of DistanceFunction value.

Method Details

fromString

public static DistanceFunction fromString(String name)

Creates or finds a DistanceFunction from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding DistanceFunction.

values

public static Collection<DistanceFunction> values()

Gets known DistanceFunction values.

Returns:

known DistanceFunction values.