de.lmu.ifi.dbs.elki.algorithm.result.clustering.biclustering
Class Biclustering<V extends RealVector<V,Double>>

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.algorithm.result.AbstractResult<V>
          de.lmu.ifi.dbs.elki.algorithm.result.clustering.biclustering.Biclustering<V>

Type Parameters:

V - the type of RealVector handled by this Result

All Implemented Interfaces:

Result<V>, Loggable

public class Biclustering<V extends RealVector<V,Double>>
extends AbstractResult<V>

A Biclustering result holds a set of biclusters.

Author:

Arthur Zimek

Field Summary

private List<Bicluster<V>>	biclusters Holds the set of biclusters.
static String	CLUSTER_MARKER Marker for a file name of a cluster.

Fields inherited from class de.lmu.ifi.dbs.elki.algorithm.result.AbstractResult

db, FILE_EXTENSION

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug

Fields inherited from interface de.lmu.ifi.dbs.elki.algorithm.result.Result

SEPARATOR

Constructor Summary

Biclustering(Database<V> database)
Provides a Result.

Method Summary

void	appendBicluster(Bicluster<V> bicluster) Appends the given bicluster to this result.
Bicluster<V>	getBicluster(int clusterIndex) Returns the bicluster with a given index in the result.
void	output(File out, Normalization<V> normalization, List<AttributeSettings> settings) Writes the clustering result to the given file.
void	output(PrintStream outStream, Normalization<V> normalization, List<AttributeSettings> settings) Writes the clustering result to the given stream.
private void	write(Bicluster<V> bicluster, PrintStream out, Normalization<V> normalization, List<AttributeSettings> settings)

Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.result.AbstractResult

getDatabase, writeHeader

Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debugFine, debugFiner, debugFinest, exception, message, progress, progress, progress, verbose, verbose, warning

Methods inherited from class java.lang.Object

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

Field Detail

CLUSTER_MARKER

public static final String CLUSTER_MARKER

Marker for a file name of a cluster.

See Also:

Constant Field Values

biclusters

private List<Bicluster<V extends RealVector<V,Double>>> biclusters

Holds the set of biclusters.

Constructor Detail

Biclustering

public Biclustering(Database<V> database)

Provides a Result.

Parameters:

database - the database where this result is defined on

Method Detail

appendBicluster

public void appendBicluster(Bicluster<V> bicluster)

Appends the given bicluster to this result.

Parameters:

bicluster - the bicluster to be appended

getBicluster

public Bicluster<V> getBicluster(int clusterIndex)

Returns the bicluster with a given index in the result.

Parameters:

clusterIndex - the index of the cluster in the result - cluster appended first has index 0.

Returns:

the bicluster appended as clusterIndex+1^th to this result

output

public void output(PrintStream outStream,
                   Normalization<V> normalization,
                   List<AttributeSettings> settings)
            throws UnableToComplyException

Description copied from interface: Result

Writes the clustering result to the given stream.

Parameters:

outStream - the stream to write to

normalization - Normalization to restore original values according to, if this action is supported - may remain null.

settings - the settings to be written into the header, if this parameter is null, no header will be written

Throws:

UnableToComplyException - if any feature vector is not compatible with values initialized during normalization

See Also:

Result.output(java.io.PrintStream,de.lmu.ifi.dbs.elki.normalization.Normalization,java.util.List)

output

public void output(File out,
                   Normalization<V> normalization,
                   List<AttributeSettings> settings)
            throws UnableToComplyException

Description copied from interface: Result

Writes the clustering result to the given file. Clustering result implementations, which are likely to provide several clusters are supposed to use the filename as prefix for every file to create and to append a proper suffix. In case of occuring IOExceptions the output is expected to be given at the standard-out. Therefore this behaviour should be also achievable by giving a null-Object as parameter.

Specified by:

output in interface Result<V extends RealVector<V,Double>>

Overrides:

output in class AbstractResult<V extends RealVector<V,Double>>

Parameters:

out - file, which designates the location to write the results, or which's name designates the prefix of any locations to write the results, or which could remain null to designate the standard-out as location for output.

normalization - Normalization to restore original values according to, if this action is supported - may remain null.

settings - the settings to be written into the header, if this parameter is null, no header will be written

Throws:

UnableToComplyException - if any feature vector is not compatible with values initialized during normalization

See Also:

Result.output(File,Normalization,List)

write

private void write(Bicluster<V> bicluster,
                   PrintStream out,
                   Normalization<V> normalization,
                   List<AttributeSettings> settings)
            throws NonNumericFeaturesException

Throws:

NonNumericFeaturesException