DistanceMeasure (Dataflow Library Distribution Project 8.0.0-98 API)

java.lang.Object
- java.lang.Enum<DistanceMeasure>
- - com.pervasive.datarush.analytics.cluster.kmeans.DistanceMeasure

All Implemented Interfaces:

Serializable, Comparable<DistanceMeasure>
```
public enum DistanceMeasure
extends Enum<DistanceMeasure>
```
Enum of distance measure that can be used to build a k-means model.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`COSINE_SIMILARITY`	Cosine similarity is used to calculate the distance between two points.
`EUCLIDEAN`	Euclidean distance is used to calculate the distance between two points.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static DistanceMeasure`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static DistanceMeasure[]`	`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
  - EUCLIDEAN
```
public static final DistanceMeasure EUCLIDEAN
```
    Euclidean distance is used to calculate the distance between two points.
  - COSINE_SIMILARITY
```
public static final DistanceMeasure COSINE_SIMILARITY
```
    Cosine similarity is used to calculate the distance between two points.
- Method Detail
  - values
```
public static DistanceMeasure[] 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 (DistanceMeasure c : DistanceMeasure.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DistanceMeasure 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