mikera.vectorz.impl

Class JoinedArrayVector

java.lang.Object

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

mikera.vectorz.AVector

mikera.vectorz.impl.ASizedVector

mikera.vectorz.impl.AJoinedVector

mikera.vectorz.impl.JoinedArrayVector

All Implemented Interfaces:

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

public final class JoinedArrayVector
extends AJoinedVector

Class representing a join of one or more array segments, i.e. the vector is constructed from a sequence of fixed chunks of double[] arrays

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	abs() Replaces all elements of this array with their absolute values, according to Math.abs(double)
void	add(AVector a) Adds another vector to this one
void	add(double value) Adds a double value to all elements in this array.
void	add(double[] srcData, int srcOffset) Adds to this vector from a given double array.
void	add(int offset, AVector a, int aOffset, int length) Adds a segment of another vector into this one, at the specified offset
void	addAt(int i, double value) Adds a value to a specific element of the vector This function does not perform bounds checking, i.e.
Vector	addCopy(AVector a) Adds a vector element-wise to this vector, returning a new vector.
void	addMultiple(AVector a, double factor) Adds a scaled multiple of another vector to this vector
void	addMultiple(int offset, AVector a, int aOffset, int length, double factor)
void	addMultipleToArray(double factor, int offset, double[] array, int arrayOffset, int length) Adds a multiple of a subvector of this vector into a double array at the specified offset
void	addProduct(AVector a, AVector b, double factor) Adds the element-wise product of two vectors and a constant factor to this vector.
void	addProduct(AVector a, int aOffset, AVector b, int bOffset, double factor) Adds the scaled elementwise product of two vectors to this vector
void	addToArray(int offset, double[] a, int aOffset, int length) Adds a subvector of this vector into a double array at the specified offset
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
void	clamp(double min, double max) Clamps all values in the vector to a given range
int	componentCount() Returns the number of components of this array.
static JoinedArrayVector	create(AVector v)
void	divideTo(double[] target, int offset) Divides the elements in the target array by corresponding elements in this vector
double	dotProduct(ADenseArrayVector v) Returns the dot product of this vector with a target ADenseArrayVector.
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[] arr, int offset) Fast dot product with a double[] array.
double	elementSum() Returns the sum of all elements in a vector
boolean	equalsArray(double[] data, int offset) Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset
JoinedArrayVector	exactClone() Returns an exact clone of this vector, i.e.
void	exp() Computes the function e^x (in-place) for all array elements
void	fill(double value) Fills the entire vector with a given value
double	get(int i) Returns the double value at the specified position in a 1D vector
ArraySubVector	getComponent(int i) Gets a component from the array at the specified index Will throw an error if components are not supported, or if the component is out of bounds as defined by 0 <= k
void	getElements(double[] destArray, 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	isView() Returns true if this vector is of a view type that references other vectors / data.
JoinedArrayVector	join(ADenseArrayVector v)
JoinedArrayVector	join(JoinedArrayVector v)
static AVector	joinVectors(ADenseArrayVector a, ADenseArrayVector b)
static JoinedArrayVector	joinVectors(JoinedArrayVector a, JoinedArrayVector b)
void	log() Computes the natural logarithm (in-place) for all array elements
void	logistic() Computes the logistic function for every element in this vector.
void	multiply(double value) Multiplies the vector by a constant factor
void	multiplyTo(double[] target, int offset) Multiplies the elements in the target array by corresponding elements in this vector
void	negate() Negates all emlements of this vector in place.
long	nonZeroCount() Returns the number of non-zero elements in the array.
int	numArrays()
void	reciprocal() Computes the reciprocal of all elements in this vector.
void	scaleAdd(double factor, double constant) Scales this vector and adds a constant to every element
void	set(AVector v) Sets the vector to equal the value of another vector
void	set(int i, double value) Sets a value at a given position in a mutable 1D array
void	signum() Calculates the signum of all elements of this mutable array Sets each component of the array to its sign value (-1, 0 or 1)
void	sqrt() Computes the square root of all elements in the array
void	square() Squares all elements of the array in place
Vector	subCopy(AVector a) Subtracts a vector element-wise from this vector, returning a new vector.
AVector	subVector(int start, int length) Obtains a sub-vector view that refers to this vector.
void	tanh() Computes the tanh of every element in this vector.
AVector	tryEfficientJoin(AVector v) Attempts to perform an efficient join with a second vector.
double	unsafeGet(int i) Like get, but performs no bounds checking.
void	unsafeSet(int i, double value) Like set, but performs no bounds checking.
void	validate() Validates the internal data structure of the INDArray.
AJoinedVector	withComponents(INDArray... segments) Reconstructs a new joined vector of the same type and shape with the given segments.
static JoinedArrayVector	wrap(ADenseArrayVector v)

Methods inherited from class mikera.vectorz.impl.AJoinedVector

addSparse, applyOp, copyTo, copyTo, copyTo, copyTo, dotProduct, elementSquaredSum, equals, hasUncountable, isMutable, isZero, reduce, reduce, scaleAdd, setElements, setSparse

Methods inherited from class mikera.vectorz.impl.ASizedVector

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

Methods inherited from class mikera.vectorz.AVector

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

Methods inherited from class mikera.arrayz.impl.AbstractArray

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

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, ensureMutable, epsilonEquals, get, get, getComponents, getElements, getElements, getSlices, getSliceViews, isBoolean, isDense, isSparse, scale, set, set, signumCopy, sub

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

create

public static final JoinedArrayVector create(AVector v)

wrap

public static JoinedArrayVector wrap(ADenseArrayVector v)

numArrays

public int numArrays()

getComponent

public ArraySubVector getComponent(int i)

Description copied from interface: INDArray

Gets a component from the array at the specified index Will throw an error if components are not supported, or if the component is out of bounds as defined by 0 <= k

Specified by:

getComponent in interface INDArray

Specified by:

getComponent in class AJoinedVector

Returns:

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 AJoinedVector

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

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

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

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

unsafeSet

public void unsafeSet(int i,
                      double value)

Description copied from class: AVector

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

Overrides:

unsafeSet in class AVector

addAt

public void addAt(int i,
                  double value)

Description copied from class: AVector

Adds a value to a specific element of the vector This function does not perform bounds checking, i.e. is an unsafe operation

Overrides:

addAt 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 AJoinedVector

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

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:

dotProduct

public double dotProduct(ADenseArrayVector v)

Description copied from class: AVector

Returns the dot product of this vector with a target ADenseArrayVector.

Overrides:

dotProduct in class AVector

Returns:

dotProduct

public double dotProduct(double[] arr,
                         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

Overrides:

dotProduct in class AJoinedVector

add

public void add(AVector a)

Description copied from class: AVector

Adds another vector to this one

Overrides:

add in class AVector

addCopy

public Vector addCopy(AVector a)

Description copied from interface: IVector

Adds a vector element-wise to this vector, returning a new vector.

Specified by:

addCopy in interface IVector

Overrides:

addCopy in class AVector

Returns:

subCopy

public Vector subCopy(AVector a)

Description copied from interface: IVector

Subtracts a vector element-wise from this vector, returning a new vector.

Specified by:

subCopy in interface IVector

Overrides:

subCopy in class AVector

Returns:

add

public void add(double[] srcData,
                int srcOffset)

Description copied from class: AVector

Adds to this vector from a given double array.

Overrides:

add in class AVector

add

public void add(int offset,
                AVector a,
                int aOffset,
                int length)

Description copied from class: AVector

Adds a segment of another vector into this one, at the specified offset

Overrides:

add in class AVector

addToArray

public void addToArray(int offset,
                       double[] a,
                       int aOffset,
                       int length)

Description copied from class: AVector

Adds a subvector of this vector into a double array at the specified offset

Overrides:

addToArray in class AVector

addProduct

public void addProduct(AVector a,
                       AVector b,
                       double factor)

Description copied from class: AVector

Adds the element-wise product of two vectors and a constant factor to this vector. Mutates this vector.

Overrides:

addProduct in class AVector

addMultiple

public void addMultiple(AVector a,
                        double factor)

Description copied from class: AVector

Adds a scaled multiple of another vector to this vector

Overrides:

addMultiple in class AVector

addMultiple

public void addMultiple(int offset,
                        AVector a,
                        int aOffset,
                        int length,
                        double factor)

Overrides:

addMultiple in class AVector

addMultipleToArray

public void addMultipleToArray(double factor,
                               int offset,
                               double[] array,
                               int arrayOffset,
                               int length)

Description copied from class: AVector

Adds a multiple of a subvector of this vector into a double array at the specified offset

Overrides:

addMultipleToArray in class AVector

addProduct

public void addProduct(AVector a,
                       int aOffset,
                       AVector b,
                       int bOffset,
                       double factor)

Description copied from class: AVector

Adds the scaled elementwise product of two vectors to this vector

Overrides:

addProduct in class AVector

applyOp

public void applyOp(Op op)

Description copied from interface: INDArray

Applies a unary operator to all elements of the array (in-place)

Specified by:

applyOp in interface INDArray

Overrides:

applyOp in class AVector

getElements

public void getElements(double[] destArray,
                        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

multiplyTo

public void multiplyTo(double[] target,
                       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

divideTo

public void divideTo(double[] target,
                     int offset)

Description copied from class: AVector

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

Overrides:

divideTo in class AVector

offset - The offset into the target array

fill

public void fill(double value)

Description copied from class: AVector

Fills the entire vector with a given value

Specified by:

fill in interface INDArray

Overrides:

fill in class AVector

set

public void set(AVector v)

Description copied from class: AVector

Sets the vector to equal the value of another vector

Overrides:

set in class AVector

multiply

public void multiply(double value)

Description copied from class: AVector

Multiplies the vector by a constant factor

Specified by:

multiply in interface INDArray

Overrides:

multiply in class AVector

Parameters:

value - Factor by which to multiply each component of the vector

scaleAdd

public void scaleAdd(double factor,
                     double constant)

Description copied from class: AVector

Scales this vector and adds a constant to every element

Specified by:

scaleAdd in interface INDArray

Overrides:

scaleAdd in class AVector

clamp

public void clamp(double min,
                  double max)

Description copied from class: AVector

Clamps all values in the vector to a given range

Specified by:

clamp in interface INDArray

Overrides:

clamp in class AVector

reciprocal

public void reciprocal()

Description copied from class: AVector

Computes the reciprocal of all elements in this vector. Mutates this vector

Specified by:

reciprocal in interface INDArray

Overrides:

reciprocal in class AVector

add

public void add(double value)

Description copied from interface: INDArray

Adds a double value to all elements in this array. Implementations may optimize the case of 0.0

Specified by:

add in interface INDArray

Overrides:

add in class AVector

abs

public void abs()

Description copied from interface: INDArray

Replaces all elements of this array with their absolute values, according to Math.abs(double)

Specified by:

abs in interface INDArray

Overrides:

abs in class AVector

exp

public void exp()

Description copied from interface: INDArray

Computes the function e^x (in-place) for all array elements

Specified by:

exp in interface INDArray

Overrides:

exp in class AbstractArray<java.lang.Double>

log

public void log()

Description copied from interface: INDArray

Computes the natural logarithm (in-place) for all array elements

Specified by:

log in interface INDArray

Overrides:

log in class AVector

signum

public void signum()

Description copied from interface: INDArray

Calculates the signum of all elements of this mutable array Sets each component of the array to its sign value (-1, 0 or 1)

Specified by:

signum in interface INDArray

Overrides:

signum in class AVector

square

public void square()

Description copied from interface: INDArray

Squares all elements of the array in place

Specified by:

square in interface INDArray

Overrides:

square in class AVector

tanh

public void tanh()

Description copied from class: AVector

Computes the tanh of every element in this vector. Mutates this vector.

Overrides:

tanh in class AVector

logistic

public void logistic()

Description copied from class: AVector

Computes the logistic function for every element in this vector. Mutates this vector.

Overrides:

logistic in class AVector

sqrt

public void sqrt()

Description copied from interface: INDArray

Computes the square root of all elements in the array

Specified by:

sqrt in interface INDArray

Overrides:

sqrt in class AbstractArray<java.lang.Double>

negate

public void negate()

Description copied from class: AVector

Negates all emlements of this vector in place.

Specified by:

negate in interface INDArray

Overrides:

negate in class AVector

exactClone

public JoinedArrayVector 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

subVector

public AVector subVector(int start,
                         int length)

Description copied from class: AVector

Obtains a sub-vector view that refers to this vector. Changes to the sub-vector will be reflected in this vector

Overrides:

subVector in class AVector

tryEfficientJoin

public AVector tryEfficientJoin(AVector v)

Description copied from class: AVector

Attempts to perform an efficient join with a second vector. An efficient join is guaranteed to be better than a simple JoinedVector(left,right) If possible, returns the joined vector. If not, returns null

Overrides:

tryEfficientJoin in class AVector

join

public JoinedArrayVector join(ADenseArrayVector v)

join

public JoinedArrayVector join(JoinedArrayVector v)

joinVectors

public static JoinedArrayVector joinVectors(JoinedArrayVector a,
                                            JoinedArrayVector b)

joinVectors

public static AVector joinVectors(ADenseArrayVector a,
                                  ADenseArrayVector b)

equalsArray

public boolean equalsArray(double[] data,
                           int offset)

Description copied from class: AVector

Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset

Specified by:

equalsArray in interface INDArray

Overrides:

equalsArray in class AJoinedVector

Parameters:

data - Array of double element values to check for equality

offset - Offset into the data array

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 AVector

componentCount

public int componentCount()

Description copied from interface: INDArray

Returns the number of components of this array. May return 0 if components are not supported

Specified by:

componentCount in interface INDArray

Specified by:

componentCount in class AJoinedVector

Returns:

withComponents

public AJoinedVector withComponents(INDArray... segments)

Description copied from class: AJoinedVector

Reconstructs a new joined vector of the same type and shape with the given segments. The segments must be the same shape as the original segments

Specified by:

withComponents in interface INDArray

Specified by:

withComponents in class AJoinedVector