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 following distance functions used by clustering models:

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
TypeField
static DistanceFunction euclidean
          Specifies the euclidean distance function.
 
Method Summary
TypeMethod
static DistanceFunction getInstance(int id)
          Returns the DistanceFunction instance specified by id.
static DistanceFunction getInstance(java.lang.String name)
          Returns the DistanceFunction instance specified by name.
static DistanceFunction[] list()
          Returns all DistanceFunction enumerations.
static java.lang.String[] listNames()
          Returns all DistanceFunction names.
 
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 all DistanceFunction names.
Returns:
String[]

list

public static DistanceFunction[] list()
Returns all DistanceFunction enumerations.
Returns:
DistanceFunction[]

getInstance

public static DistanceFunction getInstance(java.lang.String name)
Returns the DistanceFunction instance specified by name.
Parameters:
name - Distance function name (eucledian)
Returns:
DistanceFunction

getInstance

public static DistanceFunction getInstance(int id)
Returns the DistanceFunction instance specified by id.
Parameters:
id - Distance function ID
Returns:
DistanceFunction