All Packages Class Hierarchy This Package Previous Next Index WEKA's home
Class weka.clusterers.Clusterer
java.lang.Object
|
+----weka.clusterers.Clusterer
- public abstract class Clusterer
- extends java.lang.Object
- implements java.lang.Cloneable, java.io.Serializable
Abstract clusterer.
- Version:
- $Revision: 1.8 $
- Author:
- Mark Hall (mhall@cs.waikato.ac.nz)
Clusterer()
-
buildClusterer(Instances)
- Generates a clusterer.
clusterInstance(Instance)
- Classifies a given instance.
forName(String, String[])
- Creates a new instance of a clusterer given it's class name and
(optional) arguments to pass to it's setOptions method.
makeCopies(Clusterer, int)
- Creates copies of the current clusterer.
numberOfClusters()
- Returns the number of clusters.
Clusterer
public Clusterer()
buildClusterer
public abstract void buildClusterer(Instances data) throws java.lang.Exception
Generates a clusterer. Has to initialize all fields of the clusterer
that are not being set via options.
- Parameters:
data
- set of instances serving as training data
- Throws:
- java.lang.Exception - if the clusterer has not been
generated successfully
clusterInstance
public abstract int clusterInstance(Instance instance) throws java.lang.Exception
Classifies a given instance.
- Parameters:
instance
- the instance to be assigned to a cluster
- Returns:
- the number of the assigned cluster as an interger
if the class is enumerated, otherwise the predicted value
- Throws:
- java.lang.Exception - if instance could not be classified
successfully
numberOfClusters
public abstract int numberOfClusters() throws java.lang.Exception
Returns the number of clusters.
- Returns:
- the number of clusters generated for a training dataset.
- Throws:
- java.lang.Exception - if number of clusters could not be returned
successfully
forName
public static Clusterer forName(java.lang.String clustererName,
java.lang.String options[]) throws java.lang.Exception
Creates a new instance of a clusterer given it's class name and
(optional) arguments to pass to it's setOptions method. If the
clusterer implements OptionHandler and the options parameter is
non-null, the clusterer will have it's options set.
- Parameters:
searchName
- the fully qualified class name of the clusterer
options
- an array of options suitable for passing to setOptions. May
be null.
- Returns:
- the newly created search object, ready for use.
- Throws:
- java.lang.Exception - if the clusterer class name is invalid, or the
options supplied are not acceptable to the clusterer.
makeCopies
public static Clusterer[] makeCopies(Clusterer model,
int num) throws java.lang.Exception
Creates copies of the current clusterer. Note that this method
now uses Serialization to perform a deep copy, so the Clusterer
object must be fully Serializable. Any currently built model will
now be copied as well.
- Parameters:
model
- an example clusterer to copy
num
- the number of clusterer copies to create.
- Returns:
- an array of clusterers.
- Throws:
- java.lang.Exception - if an error occurs
All Packages Class Hierarchy This Package Previous Next Index WEKA's home