mikera.vectorz

Class GrowableVector

java.lang.Object

mikera.arrayz.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.ArrayVector

mikera.vectorz.GrowableVector

All Implemented Interfaces:

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

public final class GrowableVector
extends ArrayVector

Implements a growable vector, intended for incrementally building vectors Note that getting the underlying array or a subVector is unsafe, since the underlying array may be discarded as the vector is grown.

Author:

Mike

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GrowableVector()
GrowableVector(AVector v)

Method Summary

Methods

Modifier and Type	Method and Description
void	append(AVector v)
void	append(double v)
AVector	build() Function to build a fixed-size vector containing a copy of data once the GrowableVector is constructed
void	clear()
GrowableVector	clone() Clones the vector, creating a new copy of all data.
int	currentCapacity()
void	ensureCapacity(int capacity)
GrowableVector	exactClone() Returns an exact clone of this vector, i.e.
double	get(int i)
double[]	getArray() Gets the current underlying array of the GrowableVector.
int	getArrayOffset()
boolean	isView() Returns true if this vector is of a view type that references other vectors / data.
int	length()
static GrowableVector	ofInitialCapacity(int capacity) Returns a new, empty GrowableVector with the specified initial capacity
void	set(int i, double value)
void	validate() Validates the internal data structure of the INDArray.

Methods inherited from class mikera.vectorz.ArrayVector

abs, add, add, add, add, add, add, add, add, addAt, addMultiple, addMultiple, addMultipleToArray, addProduct, addProduct, addProductToArray, addProductToArray, addToArray, applyOp, copyTo, copyTo, copyTo, copyTo, divide, divide, divideTo, elementSum, fillRange, getElements, join, join, join, magnitude, magnitudeSquared, multiply, multiply, multiplyTo, scaleAdd, set, set, set, setElements, slice, square, subVector

Methods inherited from class mikera.vectorz.AVector

add, add, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addProduct, addWeighted, angle, applyOp, asElementList, asVector, broadcast, clamp, clampMax, clampMin, compareTo, copyTo, copyTo, countZeros, crossProduct, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, dotProduct, dotProduct, elementCount, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, fill, get, getLongShape, getShape, getSlices, hashCode, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isElementConstrained, isFullyMutable, isMutable, isUnitLengthVector, isZeroVector, iterator, maxAbsElement, multiply, negate, normalise, normaliseMaxAbsElement, outerProduct, outerProduct, projectToPlane, reshape, scale, scaleAdd, scaleToMagnitude, set, set, set, set, set, setValues, signum, sliceCount, sub, sub, sub, subMultiple, toArray, toList, toString

Methods inherited from class mikera.arrayz.AbstractArray

get, get, scale, set, set, setElements

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

get, get, scale, set, set, setElements

Constructor Detail

GrowableVector

public GrowableVector(AVector v)

GrowableVector

public GrowableVector()

Method Detail

ofInitialCapacity

public static GrowableVector ofInitialCapacity(int capacity)

Returns a new, empty GrowableVector with the specified initial capacity

getArray

public double[] getArray()

Gets the current underlying array of the GrowableVector. Since this array may be discarded by the GrowableVector, it is not safe to assume that it will continue to be a valid reference if the GrowableVector is changed.

Specified by:

getArray in class ArrayVector

getArrayOffset

public int getArrayOffset()

Specified by:

getArrayOffset in class ArrayVector

length

public int length()

Specified by:

length in interface IVector

Specified by:

length in class AVector

currentCapacity

public int currentCapacity()

ensureCapacity

public void ensureCapacity(int capacity)

get

public double get(int i)

Specified by:

get in interface INDArray

Specified by:

get in interface IVector

Specified by:

get in class AVector

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

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 ArrayVector

Returns:

append

public void append(double v)

append

public void append(AVector v)

build

public AVector build()

Function to build a fixed-size vector containing a copy of data once the GrowableVector is constructed

Returns:

clone

public GrowableVector 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:

clear

public void clear()

exactClone

public GrowableVector 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:

validate

public void validate()

Description copied from interface: INDArray

Validates the internal data structure of the INDArray. Throws an exception on failure. Failure indicates a serious bug and/or data corruption.

Specified by:

validate in interface INDArray

Overrides:

validate in class ArrayVector