Module datarush.analytics

Package com.pervasive.datarush.analytics.cluster

Class ComparisonMeasure

java.lang.Object

com.pervasive.datarush.analytics.cluster.ComparisonMeasure

public class ComparisonMeasure
extends Object

Corresponds to the ComparisonMeasure PMML element.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ComparisonMeasure.Builder	Builder for ComparisonMeasure instances.
static class	ComparisonMeasure.Kind	Values of this enumeration correspond to the comparison measure kinds for ComparisonMeasures in clustering models in the PMML specification.

Method Summary

Modifier and Type	Method	Description
static ComparisonMeasure.Builder	builder(AggregationFunctionConstants aggregationFunction, ComparisonMeasure.Kind kind)	Creates a builder that builds ComparisonMeasure instances.
AggregationFunction	getAggregationFunction()	Gets the AggregationFunction used by this ComparisonMeasure instance.
CompareFunction	getCompareFunction()	Gets the CompareFunction of this ComparisonMeasure instance.
ComparisonMeasure.Kind	getKind()	Gets the ComparisonMeasure.Kind of this ComparisonMeasure instance.
double	getPParameter()	Gets the p-parameter value used by this ComparisonMeasure instance.

Methods inherited from class java.lang.Object

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

Method Detail

getAggregationFunction

public AggregationFunction getAggregationFunction()

Gets the AggregationFunction used by this ComparisonMeasure instance.

Returns:

the AggregationFunction used by this ComparisonMeasure instance

getKind

public ComparisonMeasure.Kind getKind()

Gets the ComparisonMeasure.Kind of this ComparisonMeasure instance.

Returns:

the ComparisonMeasure.Kind of this ComparisonMeasure instance

getCompareFunction

public CompareFunction getCompareFunction()

Gets the CompareFunction of this ComparisonMeasure instance.

Returns:

the CompareFunction of this ComparisonMeasure instance

getPParameter

public double getPParameter()

Gets the p-parameter value used by this ComparisonMeasure instance.

Returns:

the p-parameter value used by this ComparisonMeasure instance

builder

public static ComparisonMeasure.Builder builder(AggregationFunctionConstants aggregationFunction,
                                                ComparisonMeasure.Kind kind)

Creates a builder that builds ComparisonMeasure instances. The parameters aggregation function and kind are required parameters. For other parameters defaults will be used: CompareFunction.absDiff will be used as default compare function, p-parameter will be set to Double.NaN.

Parameters:

aggregationFunction - the AggregationFunction

kind - the ComparisonMeasure.Kind

Returns:

ComparisonMeasure.Builder