IndexParam.MetricType (milvus-sdk-java 2.6.15 API)

java.lang.Object
- java.lang.Enum<IndexParam.MetricType>
- - io.milvus.v2.common.IndexParam.MetricType

All Implemented Interfaces:

Serializable, Comparable<IndexParam.MetricType>

Enclosing class:

IndexParam
```
public static enum IndexParam.MetricType
extends Enum<IndexParam.MetricType>
```

Enum Constant Summary

Enum Constants
Enum Constant	Description
`BM25`
`COSINE`
`HAMMING`
`INVALID`
`IP`
`JACCARD`
`L2`
`MAX_SIM`
`MAX_SIM_COSINE`
`MAX_SIM_HAMMING`
`MAX_SIM_IP`
`MAX_SIM_JACCARD`
`MAX_SIM_L2`
`MHJACCARD`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static IndexParam.MetricType`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static IndexParam.MetricType[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INVALID

public static final IndexParam.MetricType INVALID

L2

public static final IndexParam.MetricType L2

IP

public static final IndexParam.MetricType IP

COSINE

public static final IndexParam.MetricType COSINE

HAMMING

public static final IndexParam.MetricType HAMMING

JACCARD

public static final IndexParam.MetricType JACCARD

MHJACCARD

public static final IndexParam.MetricType MHJACCARD

BM25

public static final IndexParam.MetricType BM25

MAX_SIM

public static final IndexParam.MetricType MAX_SIM

MAX_SIM_COSINE

public static final IndexParam.MetricType MAX_SIM_COSINE

MAX_SIM_IP

public static final IndexParam.MetricType MAX_SIM_IP

MAX_SIM_L2

public static final IndexParam.MetricType MAX_SIM_L2

MAX_SIM_JACCARD

public static final IndexParam.MetricType MAX_SIM_JACCARD

MAX_SIM_HAMMING

public static final IndexParam.MetricType MAX_SIM_HAMMING

Method Detail
- values
```
public static IndexParam.MetricType[] values()
```
  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (IndexParam.MetricType c : IndexParam.MetricType.values())
    System.out.println(c);
```
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static IndexParam.MetricType valueOf(String name)
```
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
  
  Parameters:
  
  name - the name of the enum constant to be returned.
  
  Returns:
  
  the enum constant with the specified name
  
  Throws:
  
  IllegalArgumentException - if this enum type has no constant with the specified name
  
  NullPointerException - if the argument is null