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

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

Type Parameters:

V - the type of RealVector handled by this Result

All Implemented Interfaces:

Loggable

public class Bicluster<V extends RealVector<V,Double>>
extends AbstractLoggable

Wrapper class to provide the basic properties of a bicluster.

Author:

Arthur Zimek

Field Summary

private int[]	colIDs The ids of the rows included in the bicluster.
private Database<V>	database The database this bilcuster is defined for.
private int[]	invertedRows The ids of inverted rows.
private Result<V>	model The underlying bicluster model.
private int[]	rowIDs The ids of the rows included in the bicluster.

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

debug

Constructor Summary

Bicluster(int[] rowIDs, int[] colIDs, Database<V> database)
Defines a new bicluster for given parameters.

Method Summary

void	appendModel(Result<V> model) Associates the given model with this bicluster.
List<String>	headerInformation() Returns a list containing header information for printed outputs.
Result<V>	model() Returns the model associated with this bicluster.
Iterator<V>	rowIterator() Provides an iterator for the row ids.
void	setInvertedRows(int[] invertedRows) Sets the ids of the inverted rows.
int	size() The size of the cluster.
void	sortIDs() Sorts the row and column ids (and - if applicable - the ids of inverted rows) in ascending order.

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

rowIDs

private int[] rowIDs

The ids of the rows included in the bicluster.

colIDs

private int[] colIDs

The ids of the rows included in the bicluster.

invertedRows

private int[] invertedRows

The ids of inverted rows.

database

private Database<V extends RealVector<V,Double>> database

The database this bilcuster is defined for.

model

private Result<V extends RealVector<V,Double>> model

The underlying bicluster model.

Constructor Detail

Bicluster

public Bicluster(int[] rowIDs,
                 int[] colIDs,
                 Database<V> database)

Defines a new bicluster for given parameters.

Parameters:

rowIDs - the ids of the rows included in the bicluster

colIDs - the ids of the rows included in the bicluster

database - the database this bilcuster is defined for

Method Detail

setInvertedRows

public void setInvertedRows(int[] invertedRows)

Sets the ids of the inverted rows.

Parameters:

invertedRows - the ids of the inverted rows

sortIDs

public void sortIDs()

Sorts the row and column ids (and - if applicable - the ids of inverted rows) in ascending order.

size

public int size()

The size of the cluster. The size of a bicluster is the number of included rows.

Returns:

the size of the bicluster, i.e., the number or rows included in the bicluster

model

public Result<V> model()

Returns the model associated with this bicluster.

Returns:

the model associated with this bicluster

appendModel

public void appendModel(Result<V> model)

Associates the given model with this bicluster.

Parameters:

model - the model to associate with this bicluster

rowIterator

public Iterator<V> rowIterator()

Provides an iterator for the row ids. Note that the iterator is not guaranteed to touch all elements if the sortIDs() is called during the lifetime of the iterator.

Returns:

an iterator for the row ids

headerInformation

public List<String> headerInformation()

Returns a list containing header information for printed outputs.

Returns:

a list containing header information for printed outputs