mikera.vectorz

Class BitVector

java.lang.Object

mikera.arrayz.impl.AbstractArray<java.lang.Double>

mikera.vectorz.AVector

mikera.vectorz.impl.ASizedVector

mikera.vectorz.impl.ABooleanVector

mikera.vectorz.BitVector

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<java.lang.Double>, INDArray, IVector

public final class BitVector
extends ABooleanVector

Boolean vector backed by densely packed single bits - constrained to 0.0 / 1.0 values Setting the BitVector will set to 1.0 for any positive values (true) and 0.0 otherwise (false) Intended for compact representation/storage of boolean vectors

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(int length)

Method Summary

Modifier and Type	Method and Description
static BitVector	create(AVector source)
static BitVector	createLength(int length)
double	dotProduct(AVector v) Returns the dot product of this vector with another vector The vectors must have the same length: if not the result is undefined
double	dotProduct(double[] data, int offset) Fast dot product with a double[] array.
double	elementMax() Returns the maximum element value in this array.
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
void	getElements(double[] data, int offset) Copies all elements of this array a double array at the specified offset
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.
boolean	isZero() Returns true if this vector is a zero vector (all components zero)
Vector	multiplyCopy(AVector v) Multiplies a vector element-wise with this vector, returning a new vector.
void	multiplyTo(double[] data, int offset) Multiplies the elements in the target array by corresponding elements in this vector
long	nonZeroCount() Returns the number of non-zero elements in the array.
static BitVector	of(double... values)
void	set(int i, double value) Sets a value at a given position in a mutable 1D array
java.lang.String	toString()
double	unsafeGet(int i) Like get, but performs no bounds checking.

Methods inherited from class mikera.vectorz.impl.ABooleanVector

elementAbsPowSum, elementPowSum, elementSquaredSum, hasUncountable, isBoolean, isElementConstrained

Methods inherited from class mikera.vectorz.impl.ASizedVector

checkIndex, checkLength, checkRange, elementCount, equalsArray, equalsArray, get, getShape, getShapeClone, isSameShape, length, sliceCount, visitNonZero

Methods inherited from class mikera.vectorz.AVector

abs, absCopy, absDiff, absDiff, absDiff, absDiffCopy, add, add, add, add, add, add, add, add, add, addAt, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleCopy, addMultipleSparse, addMultipleSparse, addMultipleToArray, addMultipleToArray, addPower, addPower, addProduct, addProduct, addProduct, addProductCopy, addProductCopy, addProductToArray, addProductToArray, addSparse, addSparse, addToArray, addToArray, addToArray, addWeighted, angle, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, broadcastLike, clamp, clampMax, clampMin, clone, compareTo, compareTo, copy, copyTo, copyTo, copyTo, copyTo, copyTo, crossProduct, crossProduct, dense, denseClone, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divide, divideCopy, divideCopy, divideCopy, divideTo, dotProduct, dotProduct, dotProduct, elementIterator, elementMaxAbs, elementMin, elementProduct, elementsEqual, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, fill, fillRange, get, get, get, get, get, getElement, getElements, getElements, getLongShape, getShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, hashCode, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isRangeZero, isSameShape, isUnitLengthVector, isUnitLengthVector, iterator, join, join, join, log, logistic, magnitude, magnitudeSquared, maxAbsElement, maxAbsElementIndex, maxElement, maxElementIndex, minElement, minElementIndex, multiply, multiply, multiply, multiply, multiply, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, nonSparseIndex, nonZeroIndices, nonZeroValues, normalise, normaliseCopy, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reciprocal, reciprocalCopy, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateCopy, rotateView, rotateView, scale, scaleAdd, scaleAdd, scaleAdd, scaleAdd, scaleCopy, scaleToMagnitude, select, selectClone, selectView, set, set, set, set, set, set, set, set, set, set, setApplyOp, setApplyOp, setApplyOp, setElements, setElements, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, setSparse, setSparse, setSparse, shiftCopy, signum, slice, slice, sliceValue, softmax, softmaxCopy, sparse, sparseClone, sqrtCopy, square, squareCopy, sub, sub, subArray, subAt, subCopy, subCopy, subMultiple, subVector, tanh, toDoubleArray, toDoubleBuffer, toList, toNormal, toSliceArray, toStringFull, toVector, tryEfficientJoin, unsafeSet, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray

add, addApplyOp, addCopy, addInnerProduct, addInnerProduct, addOuterProduct, addOuterProductSparse, addSparse, broadcastCloneLike, broadcastCopyLike, componentCount, density, ensureMutable, epsilonEquals, exp, get, get, getComponent, getComponents, getElements, getElements, getSlices, getSliceViews, isDense, isSparse, scale, set, set, signumCopy, sqrt, sub, sub, withComponents

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.INDArray

addApplyOp, addInnerProduct, addOuterProduct, addOuterProductSparse, addSparse, broadcastCloneLike, broadcastCopyLike, componentCount, ensureMutable, epsilonEquals, exp, get, get, getComponent, getComponents, getElements, getElements, getSlices, getSliceViews, isDense, isSparse, scale, set, set, signumCopy, sqrt, sub, withComponents

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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)

Method Detail

createLength

public static BitVector createLength(int length)

create

public static BitVector create(AVector source)

unsafeGet

public double unsafeGet(int i)

Description copied from class: AVector

Like get, but performs no bounds checking. Results are undefined if the index is out of range

Overrides:

unsafeGet in class AVector

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

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 ABooleanVector

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

isZero

public boolean isZero()

Description copied from class: AVector

Returns true if this vector is a zero vector (all components zero)

Specified by:

isZero in interface INDArray

Overrides:

isZero in class AVector

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

elementMax

public double elementMax()

Description copied from interface: INDArray

Returns the maximum element value in this array. Throws an error if there are no elements.

Specified by:

elementMax in interface INDArray

Overrides:

elementMax in class AVector

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

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

dotProduct

public double dotProduct(double[] data,
                         int offset)

Description copied from class: AVector

Fast dot product with a double[] array. Performs no bounds checking. Likely to be faster than most other dot product operations

Specified by:

dotProduct in class AVector

dotProduct

public double dotProduct(AVector v)

Description copied from class: AVector

Returns the dot product of this vector with another vector The vectors must have the same length: if not the result is undefined

Overrides:

dotProduct in class AVector

Returns:

multiplyTo

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

Description copied from class: AVector

Multiplies the elements in the target array by corresponding elements in this vector

Overrides:

multiplyTo in class AVector

offset - The offset into the target array

multiplyCopy

public Vector multiplyCopy(AVector v)

Description copied from interface: IVector

Multiplies a vector element-wise with this vector, returning a new vector.

Specified by:

multiplyCopy in interface IVector

Overrides:

multiplyCopy in class AVector

Returns:

getElements

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

Description copied from interface: INDArray

Copies all elements of this array a double array at the specified offset

Specified by:

getElements in interface INDArray

Overrides:

getElements in class AVector

set

public void set(int i,
                double value)

Description copied from interface: INDArray

Sets a value at a given position in a mutable 1D array

Specified by:

set in interface INDArray

Specified by:

set in interface IVector

Specified by:

set in class AVector

of

public static BitVector of(double... values)

toString

public java.lang.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:

A clone of the original array