de.lmu.ifi.dbs.elki.database.relation

Class MaterializedDoubleRelation

java.lang.Object

de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

de.lmu.ifi.dbs.elki.database.relation.AbstractRelation<java.lang.Double>

de.lmu.ifi.dbs.elki.database.relation.MaterializedDoubleRelation

All Implemented Interfaces:

DatabaseQuery, DoubleRelation, ModifiableRelation<java.lang.Double>, Relation<java.lang.Double>, HierarchicalResult, Result

public class MaterializedDoubleRelation
extends AbstractRelation<java.lang.Double>
implements DoubleRelation

Represents a single representation. This is attached to a DBIDs object, which you are supposed to manage first. I.e. put the new DBID in, then invoke set(), remove the DBID, then delete().

Since:

0.4.0

Author:

Erich Schubert

Nested Class Summary

Nested classes/interfaces inherited from interface de.lmu.ifi.dbs.elki.database.relation.DoubleRelation

DoubleRelation.Consumer

Field Summary

Fields

Modifier and Type	Field and Description
private DoubleDataStore	content Map to hold the objects of the database.
private StaticDBIDs	ids The DBIDs this is supposed to be defined for.
private static Logging	LOG Class logger.
private java.lang.String	name The relation name.
private java.lang.String	shortname The relation name (short version)

Fields inherited from interface de.lmu.ifi.dbs.elki.database.query.DatabaseQuery

HINT_BULK, HINT_EXACT, HINT_HEAVY_USE, HINT_NO_CACHE, HINT_OPTIMIZED_ONLY, HINT_SINGLE

Constructor Summary

Constructors

Constructor and Description
MaterializedDoubleRelation(DBIDs ids) Constructor.
MaterializedDoubleRelation(DBIDs ids, java.lang.String name) Constructor.
MaterializedDoubleRelation(DBIDs ids, java.lang.String name, DoubleDataStore content) Constructor.
MaterializedDoubleRelation(java.lang.String name, java.lang.String shortname, DoubleDataStore content, DBIDs ids) Constructor.

Method Summary

Modifier and Type	Method and Description
void	delete(DBIDRef id) Delete an objects values.
double	doubleValue(DBIDRef id) Get the representation of an object.
SimpleTypeInformation<java.lang.Double>	getDataTypeInformation() Get the data type of this representation
StaticDBIDs	getDBIDs() Get the IDs the query is defined for.
protected Logging	getLogger() Get the class logger.
java.lang.String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
java.lang.String	getShortName() A short name for the result, useful for file names.
void	insert(DBIDRef id, java.lang.Double val) Deprecated.
DBIDIter	iterDBIDs() Get an iterator access to the DBIDs.
void	set(DBIDRef id, double val) Set an object representation.
int	size() Get the number of DBIDs.

Methods inherited from class de.lmu.ifi.dbs.elki.database.relation.AbstractRelation

getDistanceQuery, getKNNQuery, getRangeQuery, getRKNNQuery, getSimilarityQuery, getSimilarityRangeQuery

Methods inherited from class de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

addChildResult, getHierarchy, setHierarchy

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.database.relation.DoubleRelation

forEachDouble, get

Methods inherited from interface de.lmu.ifi.dbs.elki.database.relation.Relation

forEach, getDistanceQuery, getKNNQuery, getKNNQuery, getRangeQuery, getRangeQuery, getRKNNQuery, getRKNNQuery, getSimilarityQuery, getSimilarityRangeQuery, getSimilarityRangeQuery

Methods inherited from interface de.lmu.ifi.dbs.elki.result.HierarchicalResult

getHierarchy, setHierarchy

Field Detail

LOG

private static final Logging LOG

Class logger.

content

private final DoubleDataStore content

Map to hold the objects of the database.

ids

private final StaticDBIDs ids

The DBIDs this is supposed to be defined for. Note: we only keep an unmodifiable reference.

name

private java.lang.String name

The relation name.

shortname

private java.lang.String shortname

The relation name (short version)

Constructor Detail

MaterializedDoubleRelation

public MaterializedDoubleRelation(DBIDs ids)

Constructor.

Parameters:

ids - IDs

MaterializedDoubleRelation

public MaterializedDoubleRelation(DBIDs ids,
                                  java.lang.String name)

Constructor.

Parameters:

ids - IDs

name - Name

MaterializedDoubleRelation

public MaterializedDoubleRelation(DBIDs ids,
                                  java.lang.String name,
                                  DoubleDataStore content)

Constructor.

Parameters:

ids - IDs

name - Name

content - Content

MaterializedDoubleRelation

public MaterializedDoubleRelation(java.lang.String name,
                                  java.lang.String shortname,
                                  DoubleDataStore content,
                                  DBIDs ids)

Constructor.

Parameters:

name - Name

shortname - Short name of the result

content - Content

ids - IDs

Method Detail

doubleValue

public double doubleValue(DBIDRef id)

Description copied from interface: DoubleRelation

Get the representation of an object.

Specified by:

doubleValue in interface DoubleRelation

Parameters:

id - Object ID

Returns:

object instance

set

public void set(DBIDRef id,
                double val)

Description copied from interface: DoubleRelation

Set an object representation.

Specified by:

set in interface DoubleRelation

Parameters:

id - Object ID

val - Value

insert

@Deprecated
public void insert(DBIDRef id,
                               java.lang.Double val)

Deprecated.

Description copied from interface: ModifiableRelation

Set (or insert) an object representation.

Specified by:

insert in interface DoubleRelation

Specified by:

insert in interface ModifiableRelation<java.lang.Double>

Parameters:

id - Object ID

val - Value

delete

public void delete(DBIDRef id)

Delete an objects values.

Specified by:

delete in interface ModifiableRelation<java.lang.Double>

Parameters:

id - ID to delete

getDBIDs

public StaticDBIDs getDBIDs()

Description copied from interface: Relation

Get the IDs the query is defined for. If possible, prefer Relation.iterDBIDs().

Specified by:

getDBIDs in interface Relation<java.lang.Double>

Returns:

IDs this is defined for

iterDBIDs

public DBIDIter iterDBIDs()

Description copied from interface: Relation

Get an iterator access to the DBIDs. To iterate over all IDs, use the following code fragment:

 
 for(DBIDIter iter = relation.iterDBIDs(); iter.valid(); iter.advance()) {
    relation.get(iter); // Get the current element
 }
 
 

Specified by:

iterDBIDs in interface Relation<java.lang.Double>

Returns:

iterator for the DBIDs.

size

public int size()

Description copied from interface: Relation

Get the number of DBIDs.

Specified by:

size in interface Relation<java.lang.Double>

Returns:

Size

getDataTypeInformation

public SimpleTypeInformation<java.lang.Double> getDataTypeInformation()

Description copied from interface: Relation

Get the data type of this representation

Specified by:

getDataTypeInformation in interface Relation<java.lang.Double>

Returns:

Data type

getLongName

public java.lang.String getLongName()

Description copied from interface: Result

A "pretty" name for the result, for use in titles, captions and menus.

Specified by:

getLongName in interface Result

Returns:

result name

getShortName

public java.lang.String getShortName()

Description copied from interface: Result

A short name for the result, useful for file names.

Specified by:

getShortName in interface Result

Returns:

result name

getLogger

protected Logging getLogger()

Description copied from class: AbstractRelation

Get the class logger.

Specified by:

getLogger in class AbstractRelation<java.lang.Double>

Returns:

Logger