javax.datamining.data
Interface CategoryMatrix

All Known Subinterfaces:
ConfusionMatrix, CostMatrix, SimilarityMatrix

public interface CategoryMatrix

A CategoryMatrix represents a matrix whose axes are categories. This class supports the confusion matrix, an output of the test task for a classification model; the cost matrix, an input to the build task for a classification model; and the similarity matrix used in clustering.

Author:
JSR-73 Java Data Mining Expert Group

Method Summary
 java.util.Collection getCategories()
          Returns a collection of category values used to represent the axes of the matrix.
 CategorySet getCategorySet()
          Returns the category set that contains categories used in the matrix.
 java.lang.Double getValue(java.lang.Object rowCategoryValue, java.lang.Object columnCategoryValue)
          Returns the value in the specified entry.
 

Method Detail

getCategories

public java.util.Collection getCategories()
Returns a collection of category values used to represent the axes of the matrix.

The categories are returned as objects of type integer, double, or string.

Returns:
Collection

getCategorySet

public CategorySet getCategorySet()
Returns the category set that contains categories used in the matrix.

Returns:
CategorySet

getValue

public java.lang.Double getValue(java.lang.Object rowCategoryValue,
                                 java.lang.Object columnCategoryValue)
                          throws JDMException
Returns the value in the specified entry.

Parameters:
rowCategoryValue - The row index of the entry in the matrix.
columnCategoryValue - The column index of the entry in the matrix.
Returns:
Double
Throws:
JDMException