Package adams.flow.container

Class MOAClusteringContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.MOAClusteringContainer

All Implemented Interfaces:

adams.core.CloneHandler<adams.flow.container.Container>, adams.core.GlobalInfoSupporter, adams.data.spreadsheet.SpreadSheetSupporter, adams.flow.container.Container, Serializable

public class MOAClusteringContainer
extends adams.flow.container.AbstractContainer

A container for clusterings made by a clusterer.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz), Corey Sterling (coreytsterling at gmail dot com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	VALUE_CLUSTER	the identifier for the Cluster.
static String	VALUE_DISTRIBUTION	the identifier for the Distribution.
static String	VALUE_INSTANCE	the identifier for the Instance.
static String	VALUE_LOGDENSITY	the identifier for the LogDensity.
static String	VALUE_LOGDENSITYPERCLUSTER	the identifier for the LogDensityPerCluster.
static String	VALUE_LOGJOINTDENSITIES	the identifier for the LogJointDensities.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
MOAClusteringContainer()	Initializes the container.
MOAClusteringContainer(com.yahoo.labs.samoa.instances.Instance inst, int cluster, double[] dist)	Initializes the container.
MOAClusteringContainer(com.yahoo.labs.samoa.instances.Instance inst, int cluster, double[] dist, double logDensity, double[] logDensityPerCluster, double[] logJointDensities)	Initializes the container.

Method Summary

Modifier and Type	Method	Description
protected void	initHelp()	Initializes the help strings.
boolean	isValid()	Checks whether the setup of the container is valid.
Iterator<String>	names()	Returns all value names that can be used (theoretically).

Methods inherited from class adams.flow.container.AbstractContainer

addAdditionalName, addHelp, addHelp, addHelp, checkDefaultConstructor, getClone, getHelp, getValue, getValue, globalInfo, hasHelp, hasValue, isValidName, removeAdditionalName, setValue, store, stored, toSpreadSheet, toString

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_INSTANCE

public static final String VALUE_INSTANCE

the identifier for the Instance.

See Also:

Constant Field Values

VALUE_CLUSTER

public static final String VALUE_CLUSTER

the identifier for the Cluster.

See Also:

Constant Field Values

VALUE_DISTRIBUTION

public static final String VALUE_DISTRIBUTION

the identifier for the Distribution.

See Also:

Constant Field Values

VALUE_LOGDENSITY

public static final String VALUE_LOGDENSITY

the identifier for the LogDensity.

See Also:

Constant Field Values

VALUE_LOGDENSITYPERCLUSTER

public static final String VALUE_LOGDENSITYPERCLUSTER

the identifier for the LogDensityPerCluster.

See Also:

Constant Field Values

VALUE_LOGJOINTDENSITIES

public static final String VALUE_LOGJOINTDENSITIES

the identifier for the LogJointDensities.

See Also:

Constant Field Values

Constructor Detail

MOAClusteringContainer

public MOAClusteringContainer()

Initializes the container.

Only used for generating help information.

MOAClusteringContainer

public MOAClusteringContainer(com.yahoo.labs.samoa.instances.Instance inst,
                              int cluster,
                              double[] dist)

Initializes the container.

Parameters:

inst - the instance that was used for prediction

dist - the cluster distribution

cluster - the chosen cluster

MOAClusteringContainer

public MOAClusteringContainer(com.yahoo.labs.samoa.instances.Instance inst,
                              int cluster,
                              double[] dist,
                              double logDensity,
                              double[] logDensityPerCluster,
                              double[] logJointDensities)

Initializes the container.

Parameters:

inst - the instance that was used for prediction

cluster - the chosen cluster

dist - the cluster distribution

logDensity - the log density

logDensityPerCluster - the log density per cluster

logJointDensities - the log joint densities

Method Detail

initHelp

protected void initHelp()

Initializes the help strings.

Overrides:

initHelp in class adams.flow.container.AbstractContainer

names

public Iterator<String> names()

Returns all value names that can be used (theoretically).

Specified by:

names in interface adams.flow.container.Container

Specified by:

names in class adams.flow.container.AbstractContainer

Returns:

enumeration over all possible value names

isValid

public boolean isValid()

Checks whether the setup of the container is valid.

Specified by:

isValid in interface adams.flow.container.Container

Specified by:

isValid in class adams.flow.container.AbstractContainer

Returns:

true if all the necessary values are available