javax.datamining.clustering
Class AggregationFunction

java.lang.Object
  |
  +--javax.datamining.Enum
        |
        +--javax.datamining.clustering.AggregationFunction

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class AggregationFunction

extends Enum

AggregationFunction describes the aggregation function to be used to determine the similarity between two cases (outer comparison function). An aggregation function aggregates the similarity values of two cases calculated using an attribute comparison function (inner comparison function). Depending on the attribute type, the aggregated value is optimal if it is 0 for distance measure, or greater values indicate optimal fit for similarity measure.

Given that W_i, X_i, and Y_i are attribute weight, and two values of an attribute and c(X_i,Y_i) is the attribute comparison function, aggregation function for numerical data can be:

1. euclidean: kind=distance
2. squaredEuclidean: kind=distance (also known as squared)
3. chebychev: kind=distance (also known as maximum)
4. cityBlock: also known as sum
5. minkovski: p-parameter>0
   For binary or categorical data, let two individuals X and Y compare their values for each attribute, and
   • a11 = number of times where X_i=1 and Y_i=1
   • a10 = number of times where X_i=1 and Y_i=0
   • a01 = number of times where X_i=0 and Y_i=1
   • a00 = number of times where X_i=0 and Y_i=0
   1. simpleMatching : kind=similarity min=0 max=1
   2. jaccard: kind=similarity
   3. tanimoto: kind=similarity min=0 max=1
   4. binarySimilarity: kind=similarity

   Author:

   JSR-73 Java Data Mining Expert Group

   See Also:

   Serialized Form

   Field Summary

   static AggregationFunction	binarySimilarity
   static AggregationFunction	chebychev
   static AggregationFunction	cityBlock
   static AggregationFunction	euclidean
   static AggregationFunction	jaccard
   static AggregationFunction	minkowski
   static AggregationFunction	simpleMatching
   static AggregationFunction	squaredEuclidean
   static AggregationFunction	systemDefault
   static AggregationFunction	systemDetermined
   static AggregationFunction	tanimoto

   Method Summary

   static void	addExtension(java.lang.String name) Adds a vendor extension name to AggregationFunction.
   static AggregationFunction	valueOf(java.lang.String name) Returns an instance of AggregationFunction corresponding to the specified name.
   static AggregationFunction[]	values() Returns a list of all AggregationFunction enumerations defined.

   Methods inherited from class javax.datamining.Enum

   compareTo, equals, name

   Methods inherited from class java.lang.Object

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

   Field Detail

   binarySimilarity

   public static final AggregationFunction binarySimilarity

   chebychev

   public static final AggregationFunction chebychev

   cityBlock

   public static final AggregationFunction cityBlock

   euclidean

   public static final AggregationFunction euclidean

   jaccard

   public static final AggregationFunction jaccard

   minkowski

   public static final AggregationFunction minkowski

   simpleMatching

   public static final AggregationFunction simpleMatching

   squaredEuclidean

   public static final AggregationFunction squaredEuclidean

   systemDefault

   public static final AggregationFunction systemDefault

   systemDetermined

   public static final AggregationFunction systemDetermined

   tanimoto

   public static final AggregationFunction tanimoto

   Method Detail

   addExtension

   public static void addExtension(java.lang.String name)
                            throws JDMException

   Adds a vendor extension name to AggregationFunction.

   Parameters:

   name - The name of the unique vendor extension

   Throws:

   JDMException - When name is an invalid string or redundant to existing standard enums.

   valueOf

   public static AggregationFunction valueOf(java.lang.String name)
                                      throws JDMException

   Returns an instance of AggregationFunction corresponding to the specified name.

   Parameters:

   name - The name of the enumeration value

   Returns:

   AggregationFunction - The instance of the specified enumeration.

   Throws:

   JDMException - When name is not valid.

   values

   public static AggregationFunction[] values()

   Returns a list of all AggregationFunction enumerations defined.

   Returns:

   AggregationFunction[]