de.lmu.ifi.dbs.elki.data

Class BitVector

java.lang.Object

de.lmu.ifi.dbs.elki.data.AbstractNumberVector<Bit>

de.lmu.ifi.dbs.elki.data.BitVector

All Implemented Interfaces:

FeatureVector<Bit>, NumberVector<Bit>, SpatialComparable

public class BitVector
extends AbstractNumberVector<Bit>

Provides a BitVector wrapping a BitSet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BitVector.Factory Factory for bit vectors.
static class	BitVector.ShortSerializer Serialization class for dense integer vectors with up to Short.MAX_VALUE dimensions, by using a short for storing the dimensionality.

Field Summary

Fields

Modifier and Type	Field and Description
private BitSet	bits Storing the bits.
private int	dimensionality Dimensionality of this bit vector.
static BitVector.Factory	FACTORY Static instance.
static ByteBufferSerializer<BitVector>	SHORT_SERIALIZER Serializer for up to 2^15-1 dimensions.

Fields inherited from class de.lmu.ifi.dbs.elki.data.AbstractNumberVector

ATTRIBUTE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
BitVector(Bit[] bits) Provides a new BitVector corresponding to the bits in the given array.
BitVector(BitSet bits, int dimensionality) Provides a new BitVector corresponding to the specified bits and of the specified dimensionality.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(BitSet bitset) Returns whether this BitVector contains all bits that are set to true in the specified BitSet.
double	doubleValue(int dimension) Returns the value in the specified dimension as double.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this BitVector.
BitSet	getBits() Returns a copy of the bits currently set in this BitVector.
Vector	getColumnVector() Returns a Vector representing in one column and getDimensionality() rows the values of this BitVector as double values.
int	getDimensionality() The dimensionality of the vector space where of this FeatureVector of V is an element.
Bit	getValue(int dimension) Deprecated.
long	longValue(int dimension) Returns the value in the specified dimension as long.
String	toString() Returns a String representation of this BitVector.

Methods inherited from class de.lmu.ifi.dbs.elki.data.AbstractNumberVector

byteValue, floatValue, getMax, getMin, intValue, shortValue

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final BitVector.Factory FACTORY

Static instance.

SHORT_SERIALIZER

public static final ByteBufferSerializer<BitVector> SHORT_SERIALIZER

Serializer for up to 2^15-1 dimensions.

bits

private final BitSet bits

Storing the bits.

dimensionality

private final int dimensionality

Dimensionality of this bit vector.

Constructor Detail

BitVector

public BitVector(BitSet bits,
         int dimensionality)
          throws IllegalArgumentException

Provides a new BitVector corresponding to the specified bits and of the specified dimensionality.

Parameters:

bits - the bits to be set in this BitVector

dimensionality - the dimensionality of this BitVector

Throws:

IllegalArgumentException - if the specified dimensionality is to small to match the given BitSet

BitVector

public BitVector(Bit[] bits)

Provides a new BitVector corresponding to the bits in the given array.

Parameters:

bits - an array of bits specifying the bits in this bit vector

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.

Returns:

the number of dimensions of this FeatureVector of V

getValue

@Deprecated
public Bit getValue(int dimension)

Deprecated.

Description copied from interface: FeatureVector

Returns the value in the specified dimension.

Parameters:

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

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.

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.

Parameters:

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

Returns:

the value in the specified dimension

getColumnVector

public Vector getColumnVector()

Returns a Vector representing in one column and getDimensionality() rows the values of this BitVector as double values.

Returns:

a Matrix representing in one column and getDimensionality() rows the values of this BitVector as double values

See Also:

NumberVector.getColumnVector()

contains

public boolean contains(BitSet bitset)

Returns whether this BitVector contains all bits that are set to true in the specified BitSet.

Parameters:

bitset - the bits to inspect in this BitVector

Returns:

true if this BitVector contains all bits that are set to true in the specified BitSet, false otherwise

getBits

public BitSet getBits()

Returns a copy of the bits currently set in this BitVector.

Returns:

a copy of the bits currently set in this BitVector

toString

public String toString()

Returns a String representation of this BitVector. The representation is suitable to be parsed by BitVectorLabelParser. 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<Bit>

Overrides:

toString in class Object

Returns:

a String representation of the FeatureVector of V

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this BitVector. This BitVector is equal to the given object, if the object is a BitVector of same dimensionality and with identical bits set.

Overrides:

equals in class Object