oracle.dmt.odm
Class DistanceFunction

java.lang.Object
  |
  +--oracle.dmt.odm.Enum
        |
        +--oracle.dmt.odm.DistanceFunction

All Implemented Interfaces:

java.io.Serializable

public class DistanceFunction

extends Enum

The enumeration class DistanceFunction is used to represent the distance functions used by clustering models.

The semantics of the value are as follows:

• euclidean - The distance between two points X=(x1,...,xm) and Y=(y1,...,ym) is given by: d = sum(x-y)^2.

Since:

9.2.0

See Also:

Serialized Form

Field Summary

static DistanceFunction

euclidean Specifies the euclidean distance function.

Method Summary

static DistanceFunction	getInstance(int id) Returns DistanceFunction enumeration object corresponding to the specified ID.
static DistanceFunction	getInstance(java.lang.String name) Returns DistanceFunction enumeration object corresponding to the specified name.
static DistanceFunction[]	list() Returns the list of all DistanceFunction enumerations defined.
static java.lang.String[]	listNames() Returns the list of names of all DistanceFunction enumerations defined.

Methods inherited from class oracle.dmt.odm.Enum

getEnum, getID, isEqual

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

euclidean

public static final DistanceFunction euclidean

Specifies the euclidean distance function.

Method Detail

listNames

public static java.lang.String[] listNames()

Returns the list of names of all DistanceFunction enumerations defined.

Returns:

array of names for the DistanceFunction enumeration

list

public static DistanceFunction[] list()

Returns the list of all DistanceFunction enumerations defined.

Returns:

array of enumeration values for the DistanceFunction enumeration

getInstance

public static DistanceFunction getInstance(java.lang.String name)

Returns DistanceFunction enumeration object corresponding to the specified name.

Parameters:

name - Distance function name (eucledian)

Returns:

instance of the DistanceFunction enumeration object corresponding to the given name, null if there is no enumeration for this name.

getInstance

public static DistanceFunction getInstance(int id)

Returns DistanceFunction enumeration object corresponding to the specified ID.

Parameters:

id - Distance function ID

Returns:

instance of the DistanceFunction enumeration object corresponding to the given id, null if there is no enumeration for id.