org.apache.sedona.core.enums

Enum DistanceMetric

java.lang.Object

java.lang.Enum<DistanceMetric>

org.apache.sedona.core.enums.DistanceMetric

All Implemented Interfaces:

Serializable, Comparable<DistanceMetric>

public enum DistanceMetric
extends Enum<DistanceMetric>

The DistanceMetric enum represents the different distance metrics that can be used in the application.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EUCLIDEAN The Euclidean distance metric, also known as straight line distance.
HAVERSINE The Haversine distance metric, which measures the shortest distance between two points on the surface of a sphere.
SPHEROID The Spheroid distance metric, which measures the shortest distance between two points on the surface of a spheroid.

Method Summary

Modifier and Type	Method and Description
static DistanceMetric	valueOf(String name) Returns the enum constant of this type with the specified name.
static DistanceMetric[]	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 DistanceMetric EUCLIDEAN

The Euclidean distance metric, also known as straight line distance.

HAVERSINE

public static final DistanceMetric HAVERSINE

The Haversine distance metric, which measures the shortest distance between two points on the surface of a sphere.

SPHEROID

public static final DistanceMetric SPHEROID

The Spheroid distance metric, which measures the shortest distance between two points on the surface of a spheroid.

Method Detail

values

public static DistanceMetric[] 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 (DistanceMetric c : DistanceMetric.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DistanceMetric 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