de.lmu.ifi.dbs.elki.data

Class BitVector

java.lang.Object

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

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

All Implemented Interfaces:

FeatureVector<BitVector,Bit>, NumberVector<BitVector,Bit>, SpatialComparable, ByteBufferSerializer<BitVector>, InspectionUtilFrequentlyScanned, Parameterizable

public class BitVector
extends AbstractNumberVector<BitVector,Bit>
implements ByteBufferSerializer<BitVector>

Provides a BitVector wrapping a BitSet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BitVector.Parameterizer Parameterization class

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	STATIC Static instance.

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.
BitVector	fromByteBuffer(ByteBuffer buffer) Deserialize an object from a byte buffer (e.g. disk)
BitSet	getBits() Returns a copy of the bits currently set in this BitVector.
int	getByteSize(BitVector vec) Get the size of the object in bytes.
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 binary vector space of which this BitVector is an element.
Bit	getValue(int dimension) Returns the value in the specified dimension.
long	longValue(int dimension) Returns the value in the specified dimension as long.
<A> BitVector	newFeatureVector(A array, ArrayAdapter<Bit,A> adapter) Returns a new FeatureVector of V for the given values.
<A> BitVector	newNumberVector(A array, NumberArrayAdapter<?,A> adapter) Instantiate from any number-array like object.
void	toByteBuffer(ByteBuffer buffer, BitVector vec) Serialize the object to a byte array (e.g. disk)
String	toString() Returns a String representation of this BitVector.

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

byteValue, floatValue, getMax, getMin, hashCode, intValue, newNumberVector, shortValue

Methods inherited from class java.lang.Object

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

Field Detail

STATIC

public static final BitVector STATIC

Static instance.

bits

private BitSet bits

Storing the bits.

dimensionality

private 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()

The dimensionality of the binary vector space of which this BitVector is an element.

Specified by:

getDimensionality in interface FeatureVector<BitVector,Bit>

Specified by:

getDimensionality in interface SpatialComparable

Returns:

the number of dimensions of this FeatureVector of V

See Also:

FeatureVector.getDimensionality()

getValue

public Bit getValue(int dimension)

Returns the value in the specified dimension.

Specified by:

getValue in interface FeatureVector<BitVector,Bit>

Parameters:

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

Returns:

the value in the specified dimension

See Also:

FeatureVector.getValue(int)

doubleValue

public double doubleValue(int dimension)

Returns the value in the specified dimension as double.

Specified by:

doubleValue in interface NumberVector<BitVector,Bit>

Parameters:

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

Returns:

the value in the specified dimension

See Also:

NumberVector.doubleValue(int)

longValue

public long longValue(int dimension)

Returns the value in the specified dimension as long.

Specified by:

longValue in interface NumberVector<BitVector,Bit>

Parameters:

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

Returns:

the value in the specified dimension

See Also:

NumberVector.longValue(int)

getColumnVector

public Vector getColumnVector()

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

Specified by:

getColumnVector in interface NumberVector<BitVector,Bit>

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.

Specified by:

toString in interface FeatureVector<BitVector,Bit>

Overrides:

toString in class Object

Returns:

a String representation of the FeatureVector of V

See Also:

Object.toString()

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 AbstractNumberVector<BitVector,Bit>

Parameters:

obj - another Object

Returns:

true if the specified Object is an instance of the same runtime class and is of the identical dimensionality and the values of this AbstractNumberVector are equal to the values of obj in all dimensions, respectively

newFeatureVector

public <A> BitVector newFeatureVector(A array,
                             ArrayAdapter<Bit,A> adapter)

Description copied from interface: FeatureVector

Returns a new FeatureVector of V for the given values.

Specified by:

newFeatureVector in interface FeatureVector<BitVector,Bit>

Type Parameters:

A - Array type

Parameters:

array - the values of the featureVector

adapter - adapter class

Returns:

a new FeatureVector of V for the given values

newNumberVector

public <A> BitVector newNumberVector(A array,
                            NumberArrayAdapter<?,A> adapter)

Description copied from interface: NumberVector

Instantiate from any number-array like object.

Specified by:

newNumberVector in interface NumberVector<BitVector,Bit>

Type Parameters:

A - Array type

Parameters:

array - Array

adapter - Adapter

Returns:

a new NumberVector of N for the given values.

fromByteBuffer

public BitVector fromByteBuffer(ByteBuffer buffer)
                         throws IOException

Description copied from interface: ByteBufferSerializer

Deserialize an object from a byte buffer (e.g. disk)

Specified by:

fromByteBuffer in interface ByteBufferSerializer<BitVector>

Parameters:

buffer - Data array to process

Returns:

Deserialized object

Throws:

IOException

toByteBuffer

public void toByteBuffer(ByteBuffer buffer,
                BitVector vec)
                  throws IOException

Description copied from interface: ByteBufferSerializer

Serialize the object to a byte array (e.g. disk)

Specified by:

toByteBuffer in interface ByteBufferSerializer<BitVector>

Parameters:

buffer - Buffer to serialize to

vec - Object to serialize

Throws:

IOException

getByteSize

public int getByteSize(BitVector vec)

Description copied from interface: ByteBufferSerializer

Get the size of the object in bytes.

Specified by:

getByteSize in interface ByteBufferSerializer<BitVector>

Parameters:

vec - Object to serialize

Returns:

maximum size in serialized form