mikera.vectorz.impl

Class AJoinedVector

java.lang.Object

mikera.arrayz.impl.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.impl.ASizedVector

mikera.vectorz.impl.AJoinedVector

All Implemented Interfaces:

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

Direct Known Subclasses:

JoinedArrayVector, JoinedMultiVector, JoinedVector

public abstract class AJoinedVector
extends ASizedVector

Base class for joined vectors Joined vectors are represented as the concatenation of a number of segments.

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields inherited from class mikera.vectorz.impl.ASizedVector

length

Constructor Summary

Constructors

Constructor and Description
AJoinedVector(int length)

Method Summary

Modifier and Type	Method and Description
void	applyOp(Op2 op, AVector b) Applies a binary operator to this vector and a second vector
abstract int	componentCount() Returns the number of components of this array.
void	copyTo(AVector dest, int offset) Copies a the contents of a vector to a vector at the specified offset
void	copyTo(int offset, AVector dest, int destOffset, int length) Copies a subset of this vector to a vector at the specified offset
void	copyTo(int offset, double[] dest, int destOffset, int length) Copies a subset of this vector to a specified destination array offset
void	copyTo(int offset, double[] dest, int destOffset, int length, int stride) Copies a subset of this vector to a specified destination array offset using the given stride.
double	dotProduct(double[] data, int offset) Fast dot product with a double[] array.
double	dotProduct(double[] data, int offset, int stride) Fast dot product with a double[] array and a stride.
double	elementSquaredSum() Returns the sum of squared elements in this array.
double	elementSum() Returns the sum of all elements in a vector
boolean	equals(AVector a)
boolean	equalsArray(double[] values, int offset) Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset
abstract AVector	getComponent(int k) 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
boolean	hasUncountable() Returns true if any element is this array is NaN or infinite
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)
double	reduce(Op2 op) Reduces over all elements of the array in row-major order.
double	reduce(Op2 op, double init) Reduces over all elements of the array in row-major order.
void	scaleAdd(double factor, AVector b, double bfactor, double constant) Scales all elements of the array by a given double value, adds a scaled second vector and adds a constant value
void	setElements(double[] values, int offset) Sets all elements in an array using the given double values
abstract AJoinedVector	withComponents(INDArray... segments) Reconstructs a new joined vector of the same type and shape with the given segments.

Methods inherited from class mikera.vectorz.impl.ASizedVector

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

Methods inherited from class mikera.vectorz.AVector

abs, absCopy, add, add, add, add, add, add, add, add, add, addAt, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleCopy, addMultipleToArray, addMultipleToArray, addPower, addPower, addPower, addProduct, addProduct, addProduct, addProductCopy, addProductCopy, addProductToArray, addProductToArray, addToArray, addToArray, addToArray, addWeighted, angle, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, broadcastLike, checkDimension, checkSameLength, clamp, clampMax, clampMin, clone, compareTo, copy, copyTo, crossProduct, crossProduct, dense, denseClone, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divide, divideCopy, divideCopy, divideTo, dotProduct, dotProduct, dotProduct, elementAbsPowSum, elementIterator, elementMax, elementMin, elementPowSum, elementProduct, elementsEqual, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, exactClone, fill, fillRange, get, get, get, get, get, getElements, getElements, getElements, getLongShape, getShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, hashCode, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isElementConstrained, isFullyMutable, 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, multiplyCopy, multiplyTo, mutable, negate, negateCopy, nonSparseIndex, nonZeroCount, nonZeroIndices, nonZeroValues, normalise, normaliseCopy, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateCopy, rotateView, rotateView, scale, scaleAdd, scaleAdd, scaleAdd, scaleCopy, scaleToMagnitude, select, selectClone, selectView, set, set, set, set, set, set, set, set, set, set, set, setElements, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, 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, toString, toStringFull, toVector, tryEfficientJoin, unsafeGet, unsafeSet, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray

add, addInnerProduct, addInnerProduct, addOuterProduct, broadcastCloneLike, broadcastCopyLike, checkMutable, density, ensureMutable, exp, get, get, get, getComponents, getElements, getElements, getSlices, getSliceViews, isBoolean, isDense, isSparse, reciprocal, reciprocalCopy, scale, set, set, signumCopy, sqrt, sub, sub, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

addOuterProduct, broadcastCloneLike, broadcastCopyLike, checkMutable, ensureMutable, exp, get, get, get, getComponents, getElements, getElements, getSlices, getSliceViews, isBoolean, isDense, isSparse, reciprocal, reciprocalCopy, scale, set, set, signumCopy, sqrt, sub, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AJoinedVector

public AJoinedVector(int length)

Method Detail

componentCount

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

Overrides:

componentCount in class AbstractArray<Double>

Returns:

getComponent

public abstract AVector getComponent(int k)

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

Overrides:

getComponent in class AbstractArray<Double>

Returns:

withComponents

public abstract AJoinedVector withComponents(INDArray... segments)

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

Overrides:

withComponents in class AbstractArray<Double>

Parameters:

aVectors -

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

setElements

public void setElements(double[] values,
                        int offset)

Description copied from interface: INDArray

Sets all elements in an array using the given double values

Specified by:

setElements in interface INDArray

Overrides:

setElements in class AVector

Parameters:

values - Element values in a double[] array. There must be at least as many element values as elements in this array.

offset - Position in the values array from which to start taking values.

copyTo

public void copyTo(AVector dest,
                   int offset)

Description copied from class: AVector

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

Overrides:

copyTo in class AVector

copyTo

public void copyTo(int offset,
                   AVector dest,
                   int destOffset,
                   int length)

Description copied from class: AVector

Copies a subset of this vector to a vector at the specified offset

Overrides:

copyTo in class AVector

copyTo

public void copyTo(int offset,
                   double[] dest,
                   int destOffset,
                   int length)

Description copied from class: AVector

Copies a subset of this vector to a specified destination array offset

Overrides:

copyTo in class AVector

copyTo

public void copyTo(int offset,
                   double[] dest,
                   int destOffset,
                   int length,
                   int stride)

Description copied from class: AVector

Copies a subset of this vector to a specified destination array offset using the given stride. Unsafe operation: performs no bounds checking

Overrides:

copyTo in class AVector

equals

public boolean equals(AVector a)

Overrides:

equals in class AVector

equalsArray

public boolean equalsArray(double[] values,
                           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 ASizedVector

Parameters:

values - Array of double element values to check for equality

offset - Offset into the data array

Returns:

scaleAdd

public void scaleAdd(double factor,
                     AVector b,
                     double bfactor,
                     double constant)

Description copied from class: AVector

Scales all elements of the array by a given double value, adds a scaled second vector and adds a constant value

Overrides:

scaleAdd in class AVector

elementSquaredSum

public double elementSquaredSum()

Description copied from interface: INDArray

Returns the sum of squared elements in this array.

Specified by:

elementSquaredSum in interface INDArray

Overrides:

elementSquaredSum 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

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

hasUncountable

public boolean hasUncountable()

Description copied from class: AbstractArray

Returns true if any element is this array is NaN or infinite

Specified by:

hasUncountable in interface INDArray

Overrides:

hasUncountable in class AVector

Returns:

True if any element is this array is NaN or infinite, false otherwise

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(double[] data,
                         int offset,
                         int stride)

Description copied from class: AVector

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

Overrides:

dotProduct in class AVector

applyOp

public void applyOp(Op2 op,
                    AVector b)

Description copied from class: AVector

Applies a binary operator to this vector and a second vector

Overrides:

applyOp in class AVector

reduce

public double reduce(Op2 op,
                     double init)

Description copied from interface: INDArray

Reduces over all elements of the array in row-major order. Applies the operator to the initial/previous result at each step. Returns the final result.

Specified by:

reduce in interface INDArray

Overrides:

reduce in class AVector

reduce

public double reduce(Op2 op)

Description copied from interface: INDArray

Reduces over all elements of the array in row-major order. Applies the operator to the previous result at each step. Returns the final result.

Specified by:

reduce in interface INDArray

Overrides:

reduce in class AVector