Package elki.data

Class ByteVector

java.lang.Object

elki.data.ByteVector

All Implemented Interfaces:

FeatureVector<java.lang.Number>, NumberVector, SpatialComparable

public class ByteVector
extends java.lang.Object
implements NumberVector

Vector using byte[] storage.

Since:

0.6.0

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ByteVector.Factory	Factory for Byte vectors.
static class	ByteVector.ShortSerializer	Serialization class for dense Byte vectors with up to Short.MAX_VALUE dimensions, by using a short for storing the dimensionality.
static class	ByteVector.SmallSerializer	Serialization class for dense Byte vectors with up to 127 dimensions, by using a byte for storing the dimensionality.

Field Summary

Fields

Modifier and Type	Field	Description
static ByteBufferSerializer<ByteVector>	BYTE_SERIALIZER	Serializer for up to 127 dimensions.
static ByteBufferSerializer<ByteVector>	SHORT_SERIALIZER	Serializer for up to 2^15-1 dimensions.
static ByteVector.Factory	STATIC	Static instance (object factory).
private byte[]	values	Keeps the values of the real vector.

Fields inherited from interface elki.data.FeatureVector

TYPE

Fields inherited from interface elki.data.NumberVector

ATTRIBUTE_SEPARATOR, FIELD, FIELD_1D, FIELD_2D, VARIABLE_LENGTH

Constructor Summary

Constructors

Modifier	Constructor	Description
	ByteVector(byte[] values)	Create an ByteVector consisting of the given Byte values.
private	ByteVector(byte[] values, boolean nocopy)	Private constructor.

Method Summary

Modifier and Type	Method	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.
int	getDimensionality()	The dimensionality of the vector space where of this FeatureVector of V is an element.
java.lang.Byte	getValue(int dimension)	Deprecated.
byte[]	getValues()	Get a copy of the raw byte[] array.
long	longValue(int dimension)	Returns the value in the specified dimension as long.
double[]	toArray()	Returns a double array copy of this vector.
java.lang.String	toString()	Returns a String representation of the FeatureVector of V as a line that is suitable to be printed in a sequential file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface elki.data.NumberVector

floatValue, getMax, getMin, intValue, shortValue

Field Detail

STATIC

public static final ByteVector.Factory STATIC

Static instance (object factory).

BYTE_SERIALIZER

public static final ByteBufferSerializer<ByteVector> BYTE_SERIALIZER

Serializer for up to 127 dimensions.

SHORT_SERIALIZER

public static final ByteBufferSerializer<ByteVector> SHORT_SERIALIZER

Serializer for up to 2^15-1 dimensions.

values

private final byte[] values

Keeps the values of the real vector.

Constructor Detail

ByteVector

private ByteVector(byte[] values,
                   boolean nocopy)

Private constructor. NOT for public use.

Parameters:

values - Value data

nocopy - Flag to use without copying.

ByteVector

public ByteVector(byte[] values)

Create an ByteVector consisting of the given Byte values.

Parameters:

values - the values to be set as values of the ByteVector

Method Detail

getDimensionality

public int getDimensionality()

Description copied from interface: FeatureVector

The dimensionality of the vector space where of this FeatureVector of V is an element.

Specified by:

getDimensionality in interface FeatureVector<java.lang.Number>

Specified by:

getDimensionality in interface SpatialComparable

Returns:

the number of dimensions of this FeatureVector of V

getValue

@Deprecated
public java.lang.Byte getValue(int dimension)

Deprecated.

Description copied from interface: FeatureVector

Returns the value in the specified dimension.

Specified by:

getValue in interface FeatureVector<java.lang.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

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

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

getValues

public byte[] getValues()

Get a copy of the raw byte[] array.

Returns:

copy of values array.

toArray

public double[] toArray()

Description copied from interface: NumberVector

Returns a double array copy of this vector.

Specified by:

toArray in interface NumberVector

Returns:

Copy as double[]

toString

public java.lang.String toString()

Description copied from interface: FeatureVector

Returns a String representation of the FeatureVector of V as a line that is suitable to be printed in a sequential file.

Specified by:

toString in interface FeatureVector<java.lang.Number>

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the FeatureVector of V