mikera.vectorz

Class BitVector

java.lang.Object

mikera.arrayz.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.BitVector

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AVector>, Iterable<Double>, INDArray, IVector

public final class BitVector
extends AVector

Vector of bits - constrained to 0.0 / 1.0 values Intended for compact representation/storage of binary vectors

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static double	BIT_OFF
static double	BIT_ON
static double	BIT_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
BitVector(AVector source)
BitVector(BitVector source)
BitVector(int length)

Method Summary

Methods

Modifier and Type	Method and Description
AVector	clone() Clones the vector, creating a new copy of all data.
void	copyTo(double[] data, int offset) Copies a the contents of a vector to a double array at the specified offset
static BitVector	createLength(int length)
double	elementSum() Returns the sum of all elements in a vector
BitVector	exactClone() Returns an exact clone of this vector, i.e.
double	get(int i) Returns the double value at the specified position in a 1D vector
boolean	getBit(int i)
boolean	isElementConstrained() Returns true if the IND has additional constraints on element values
boolean	isFullyMutable() Returns true if this vector is fully mutable, i.e.
boolean	isMutable() Returns true if this vector is mutable.
boolean	isView() Returns true if this vector is of a view type that references other vectors / data.
int	length()
long	nonZeroCount() Returns the number of non-zero elements in the array.
static BitVector	of(double... values)
void	set(int i, double value)
String	toString()

Methods inherited from class mikera.vectorz.AVector

abs, add, add, add, add, add, add, addAt, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleToArray, addProduct, addProduct, addProduct, addProductToArray, addProductToArray, addToArray, addToArray, addWeighted, angle, applyOp, applyOp, asElementList, asVector, broadcast, clamp, clampMax, clampMin, compareTo, copyTo, copyTo, copyTo, copyTo, copyTo, countZeros, crossProduct, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divideTo, dotProduct, dotProduct, elementCount, elementSquaredSum, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, fill, fillRange, get, getElements, getLongShape, getShape, getShape, getSlices, getTranspose, getTransposeView, hashCode, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isUnitLengthVector, isZeroVector, iterator, join, magnitude, magnitudeSquared, maxAbsElement, multiply, multiply, multiply, multiply, multiplyTo, negate, normalise, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reshape, scale, scaleAdd, scaleAdd, scaleToMagnitude, set, set, set, set, set, set, set, set, set, setElements, setValues, signum, slice, slice, sliceCount, square, sub, sub, sub, subMultiple, subVector, toArray, toDoubleBuffer, toList, validate

Methods inherited from class mikera.arrayz.AbstractArray

epsilonEquals, epsilonEquals, get, get, getSliceViews, reciprocal, scale, set, set, setElements, toVector

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

epsilonEquals, epsilonEquals, get, get, getSliceViews, reciprocal, scale, set, set, setElements, toVector

Field Detail

BIT_ON

public static final double BIT_ON

See Also:

Constant Field Values

BIT_OFF

public static final double BIT_OFF

See Also:

Constant Field Values

BIT_THRESHOLD

public static final double BIT_THRESHOLD

See Also:

Constant Field Values

Constructor Detail

BitVector

public BitVector(int length)

BitVector

public BitVector(AVector source)

BitVector

public BitVector(BitVector source)

Method Detail

createLength

public static BitVector createLength(int length)

length

public int length()

Specified by:

length in interface IVector

Specified by:

length in class AVector

getBit

public final boolean getBit(int i)

get

public double get(int i)

Description copied from interface: INDArray

Returns the double value at the specified position in a 1D vector

Specified by:

get in interface INDArray

Specified by:

get in interface IVector

Specified by:

get in class AVector

Returns:

elementSum

public double elementSum()

Description copied from class: AVector

Returns the sum of all elements in a vector

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class AVector

Returns:

nonZeroCount

public long nonZeroCount()

Description copied from interface: INDArray

Returns the number of non-zero elements in the array.

Specified by:

nonZeroCount in interface INDArray

Overrides:

nonZeroCount in class AVector

Returns:

isMutable

public boolean isMutable()

Description copied from class: AVector

Returns true if this vector is mutable.

Specified by:

isMutable in interface INDArray

Overrides:

isMutable in class AVector

Returns:

copyTo

public void copyTo(double[] data,
          int offset)

Description copied from class: AVector

Copies a the contents of a vector to a double array at the specified offset

Overrides:

copyTo in class AVector

isFullyMutable

public boolean isFullyMutable()

Description copied from class: AVector

Returns true if this vector is fully mutable, i.e. can contain any unconstrained double values

Specified by:

isFullyMutable in interface INDArray

Overrides:

isFullyMutable in class AVector

Returns:

isElementConstrained

public boolean isElementConstrained()

Description copied from interface: INDArray

Returns true if the IND has additional constraints on element values

Specified by:

isElementConstrained in interface INDArray

Overrides:

isElementConstrained in class AVector

isView

public boolean isView()

Description copied from class: AVector

Returns true if this vector is of a view type that references other vectors / data.

Specified by:

isView in interface INDArray

Overrides:

isView in class AVector

Returns:

set

public void set(int i,
       double value)

Specified by:

set in interface INDArray

Specified by:

set in interface IVector

Specified by:

set in class AVector

clone

public AVector clone()

Description copied from class: AVector

Clones the vector, creating a new copy of all data. The clone is: - not guaranteed to be of the same type. - guaranteed to be fully mutable - guaranteed not to contain a reference (i.e. is a full deep copy)

Specified by:

clone in interface INDArray

Overrides:

clone in class AVector

Returns:

of

public static BitVector of(double... values)

toString

public String toString()

Overrides:

toString in class AVector

exactClone

public BitVector exactClone()

Description copied from class: AVector

Returns an exact clone of this vector, i.e. of the same type

Specified by:

exactClone in interface INDArray

Specified by:

exactClone in class AVector

Returns: