de.lmu.ifi.dbs.elki.algorithm.clustering.hierarchical

Class PointerHierarchyRepresentationBuilder

java.lang.Object

de.lmu.ifi.dbs.elki.algorithm.clustering.hierarchical.PointerHierarchyRepresentationBuilder

public class PointerHierarchyRepresentationBuilder
extends java.lang.Object

Class to help building a pointer hierarchy.

Since:

0.7.1

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
protected WritableIntegerDataStore	csize Cluster size storage.
protected DBIDs	ids The DBIDs in this result.
protected boolean	isSquared Flag to indicate squared distances.
private static Logging	LOG Class logger.
protected int	mergecount Merge counter (for merge ordering).
protected WritableIntegerDataStore	order Store merge order.
protected WritableDBIDDataStore	parent The parent DBID relation.
protected WritableDoubleDataStore	parentDistance Distance to the parent object.
protected WritableDBIDDataStore	prototypes Prototype storage, may be null.

Constructor Summary

Constructors

Constructor and Description
PointerHierarchyRepresentationBuilder(DBIDs ids, boolean isSquared) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(DBIDRef cur, double distance, DBIDRef par) Add an element to the pointer representation.
void	add(DBIDRef cur, double distance, DBIDRef par, DBIDRef prototype) Add an element to the pointer representation.
PointerHierarchyRepresentationResult	complete() Finalize the result.
double	getDistance(DBIDRef id) Get the current linking distance of an object.
int	getSize(DBIDRef id) Get the cluster size of the current object.
boolean	isLinked(DBIDRef id) Test if an object is already linked.
void	setSize(DBIDRef id, int size) Set the cluster size of an object.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logging LOG

Class logger.

ids

protected final DBIDs ids

The DBIDs in this result.

parent

protected WritableDBIDDataStore parent

The parent DBID relation.

parentDistance

protected WritableDoubleDataStore parentDistance

Distance to the parent object.

csize

protected WritableIntegerDataStore csize

Cluster size storage. May be uninitialized!

order

protected WritableIntegerDataStore order

Store merge order.

mergecount

protected int mergecount

Merge counter (for merge ordering).

prototypes

protected WritableDBIDDataStore prototypes

Prototype storage, may be null.

isSquared

protected boolean isSquared

Flag to indicate squared distances.

Constructor Detail

PointerHierarchyRepresentationBuilder

public PointerHierarchyRepresentationBuilder(DBIDs ids,
                                             boolean isSquared)

Constructor.

Parameters:

ids - IDs

isSquared - Flag to indicate squared distances

Method Detail

add

public void add(DBIDRef cur,
                double distance,
                DBIDRef par)

Add an element to the pointer representation. Important: If an algorithm does not produce links in an increasing fashion, a warning will be issued and the linking distance will be increased. Otherwise, the hierarchy would be misinterpreted when links are executed ordered by their distance.

Parameters:

cur - Current object

distance - Link distance

par - Parent

add

public void add(DBIDRef cur,
                double distance,
                DBIDRef par,
                DBIDRef prototype)

Add an element to the pointer representation. Important: If an algorithm does not produce links in an increasing fashion, a warning will be issued and the linking distance will be increased. Otherwise, the hierarchy would be misinterpreted when links are executed ordered by their distance.

Parameters:

cur - Current object

distance - Link distance

par - Parent

prototype -

complete

public PointerHierarchyRepresentationResult complete()

Finalize the result.

Returns:

Completed result

getSize

public int getSize(DBIDRef id)

Get the cluster size of the current object.

Parameters:

id - Object id

Returns:

Cluster size (initially 1).

setSize

public void setSize(DBIDRef id,
                    int size)

Set the cluster size of an object.

Parameters:

id - Object to set

size - Cluster size

isLinked

public boolean isLinked(DBIDRef id)

Test if an object is already linked.

Parameters:

id - Object

Returns:

true if the object is already linked.

getDistance

public double getDistance(DBIDRef id)

Get the current linking distance of an object.

Parameters:

id - Object

Returns:

Distance, or infinity