com.pervasive.datarush.analytics.cluster

Enum CompareFunction

java.lang.Object

java.lang.Enum<CompareFunction>

com.pervasive.datarush.analytics.cluster.CompareFunction

All Implemented Interfaces:

Serializable, Comparable<CompareFunction>

public enum CompareFunction
extends Enum<CompareFunction>

Values of this enumeration correspond to the compare functions for clustering models in the PMML specification.

Enum Constant Summary

Enum Constants

Enum Constant and Description
absDiff
delta
equal
gaussSim
table

Method Summary

Modifier and Type	Method and Description
abstract double	apply(double x, double y, double s) Applies the function to the provided values.
static CompareFunction	valueOf(String name) Returns the enum constant of this type with the specified name.
static CompareFunction[]	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

absDiff

public static final CompareFunction absDiff

gaussSim

public static final CompareFunction gaussSim

delta

public static final CompareFunction delta

equal

public static final CompareFunction equal

table

public static final CompareFunction table

Method Detail

values

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

Returns:

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

valueOf

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

apply

public abstract double apply(double x,
                             double y,
                             double s)

Applies the function to the provided values.

Parameters:

x - the value to be compared

y - the value to compare x with

s - similarity scale

Returns:

the distance or similarity value computed by this function