de.lmu.ifi.dbs.elki.index.tree.spatial

Class SpatialPointLeafEntry

java.lang.Object

de.lmu.ifi.dbs.elki.index.tree.AbstractLeafEntry

de.lmu.ifi.dbs.elki.index.tree.spatial.SpatialPointLeafEntry

All Implemented Interfaces:

FeatureVector<Number>, NumberVector, SpatialComparable, Entry, LeafEntry, SpatialEntry, Externalizable, Serializable

Direct Known Subclasses:

DeLiCluLeafEntry, RdKNNLeafEntry

public class SpatialPointLeafEntry
extends AbstractLeafEntry
implements SpatialEntry, NumberVector

Represents an entry in a leaf node of a spatial index. A SpatialLeafEntry consists of an id (representing the unique id of the underlying data object) and the values of the underlying data object.

Author:

Elke Achtert

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface de.lmu.ifi.dbs.elki.data.NumberVector

NumberVector.Factory<V extends NumberVector>

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID Serial version.
private double[]	values The values of the underlying data object.

Constructor Summary

Constructors

Constructor and Description
SpatialPointLeafEntry() Empty constructor for serialization purposes.
SpatialPointLeafEntry(DBID id, double[] values) Constructs a new LeafEntry object with the given parameters.
SpatialPointLeafEntry(DBID id, NumberVector vector) Constructor from number vector.

Method Summary

Methods

Modifier and Type	Method and Description
byte	byteValue(int dimension) Returns the value in the specified dimension as byte.
double	doubleValue(int dimension) Returns the value in the specified dimension as double.
float	floatValue(int dimension) Returns the value in the specified dimension as float.
Vector	getColumnVector() Returns a Vector representing in one column and getDimensionality() rows the values of this NumberVector of V.
int	getDimensionality() Returns the dimensionality of the object.
double	getMax(int dimension) Returns the maximum coordinate at the specified dimension.
double	getMin(int dimension) Returns the minimum coordinate at the specified dimension.
Double	getValue(int dimension) Deprecated.
double[]	getValues() Returns the values of the underlying data object of this entry.
int	intValue(int dimension) Returns the value in the specified dimension as int.
long	longValue(int dimension) Returns the value in the specified dimension as long.
void	readExternal(ObjectInput in) Calls the super method and reads the values of this entry from the specified input stream.
short	shortValue(int dimension) Returns the value in the specified dimension as short.
void	writeExternal(ObjectOutput out) Calls the super method and writes the values of this entry to the specified stream.

Methods inherited from class de.lmu.ifi.dbs.elki.index.tree.AbstractLeafEntry

equals, getDBID, hashCode, isLeafEntry, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.lmu.ifi.dbs.elki.index.tree.Entry

isLeafEntry

Methods inherited from interface de.lmu.ifi.dbs.elki.data.FeatureVector

toString

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial version.

See Also:

Constant Field Values

values

private double[] values

The values of the underlying data object.

Constructor Detail

SpatialPointLeafEntry

public SpatialPointLeafEntry()

Empty constructor for serialization purposes.

SpatialPointLeafEntry

public SpatialPointLeafEntry(DBID id,
                     double[] values)

Constructs a new LeafEntry object with the given parameters.

Parameters:

id - the unique id of the underlying data object

values - the values of the underlying data object

SpatialPointLeafEntry

public SpatialPointLeafEntry(DBID id,
                     NumberVector vector)

Constructor from number vector.

Parameters:

id - Object id

vector - Number vector

Method Detail

getDimensionality

public int getDimensionality()

Description copied from interface: SpatialComparable

Returns the dimensionality of the object.

Specified by:

getDimensionality in interface FeatureVector<Number>

Specified by:

getDimensionality in interface SpatialComparable

Returns:

the dimensionality

getMin

public double getMin(int dimension)

Description copied from interface: SpatialComparable

Returns the minimum coordinate at the specified dimension.

Specified by:

getMin in interface SpatialComparable

Parameters:

dimension - the dimension for which the coordinate should be returned, where 0 ≤ dimension < getDimensionality()

Returns:

the minimum coordinate at the specified dimension

getMax

public double getMax(int dimension)

Description copied from interface: SpatialComparable

Returns the maximum coordinate at the specified dimension.

Specified by:

getMax in interface SpatialComparable

Parameters:

dimension - the dimension for which the coordinate should be returned, where 0 ≤ dimension < getDimensionality()

Returns:

the maximum coordinate at the specified dimension

getValues

public double[] getValues()

Returns the values of the underlying data object of this entry.

Returns:

the values of the underlying data object of this entry

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Calls the super method and writes the values of this entry to the specified stream.

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class AbstractLeafEntry

Parameters:

out - the stream to write the object to

Throws:

IOException - Includes any I/O exceptions that may occur

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Calls the super method and reads the values of this entry from the specified input stream.

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class AbstractLeafEntry

Parameters:

in - the stream to read data from in order to restore the object

Throws:

IOException - if I/O errors occur

ClassNotFoundException - If the class for an object being restored cannot be found.

getValue

@Deprecated
public Double getValue(int dimension)

Deprecated.

Description copied from interface: FeatureVector

Returns the value in the specified dimension.

Specified by:

getValue in interface FeatureVector<Number>

Specified by:

getValue in interface NumberVector

Parameters:

dimension - the desired dimension, where 0 ≤ dimension ≤ this.getDimensionality()-1

Returns:

the value in the specified dimension

doubleValue

public double doubleValue(int dimension)

Description copied from interface: NumberVector

Returns the value in the specified dimension as double. Note: this might seem redundant with respect to getValue(dim).doubleValue(), but usually this is much more efficient due to boxing/unboxing cost.

Specified by:

doubleValue in interface NumberVector

Parameters:

dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()

Returns:

the value in the specified dimension

floatValue

public float floatValue(int dimension)

Description copied from interface: NumberVector

Returns the value in the specified dimension as float. Note: this might seem redundant with respect to getValue(dim).floatValue(), but usually this is much more efficient due to boxing/unboxing cost.

Specified by:

floatValue in interface NumberVector

Parameters:

dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()

Returns:

the value in the specified dimension

intValue

public int intValue(int dimension)

Description copied from interface: NumberVector

Returns the value in the specified dimension as int. Note: this might seem redundant with respect to getValue(dim).intValue(), but usually this is much more efficient due to boxing/unboxing cost.

Specified by:

intValue in interface NumberVector

Parameters:

dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()

Returns:

the value in the specified dimension

longValue

public long longValue(int dimension)

Description copied from interface: NumberVector

Returns the value in the specified dimension as long. Note: this might seem redundant with respect to getValue(dim).longValue(), but usually this is much more efficient due to boxing/unboxing cost.

Specified by:

longValue in interface NumberVector

Parameters:

dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()

Returns:

the value in the specified dimension

shortValue

public short shortValue(int dimension)

Description copied from interface: NumberVector

Returns the value in the specified dimension as short. Note: this might seem redundant with respect to getValue(dim).shortValue(), but usually this is much more efficient due to boxing/unboxing cost.

Specified by:

shortValue in interface NumberVector

Parameters:

dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()

Returns:

the value in the specified dimension

byteValue

public byte byteValue(int dimension)

Description copied from interface: NumberVector

Returns the value in the specified dimension as byte. Note: this might seem redundant with respect to getValue(dim).byteValue(), but usually this is much more efficient due to boxing/unboxing cost.

Specified by:

byteValue in interface NumberVector

Parameters:

dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()

Returns:

the value in the specified dimension

getColumnVector

public Vector getColumnVector()

Description copied from interface: NumberVector

Returns a Vector representing in one column and getDimensionality() rows the values of this NumberVector of V.

Specified by:

getColumnVector in interface NumberVector

Returns:

a Matrix representing in one column and getDimensionality() rows the values of this NumberVector of V