mikera.vectorz.impl

Class AArrayVector

java.lang.Object

mikera.arrayz.impl.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.impl.AStridedVector

mikera.vectorz.impl.AArrayVector

All Implemented Interfaces:

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

Direct Known Subclasses:

ArraySubVector, GrowableVector, Vector

public abstract class AArrayVector
extends AStridedVector

Base class for vectors backed by a double[] array with a fixed stride of 1 The double array can be directly accessed for performance purposes

Author:

Mike

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AArrayVector()

Method Summary

Methods

Modifier and Type	Method and Description
void	abs() Sets each component of the vector to its absolute value
void	add(AArrayVector v)
void	add(AArrayVector src, int srcOffset)
void	add(AVector src) Adds another vector to this one
void	add(AVector src, int srcOffset) Adds part another vector to this one, starting at the specified offset in the source vector
void	add(double constant) Adds a double value to all elements in this array
void	add(int offset, AArrayVector src)
void	add(int offset, AArrayVector src, int srcOffset, int length)
void	add(int offset, AVector src) Adds another vector into this one, at the specified offset
void	addAt(int i, double v) Adds a value to a specific element of the vector This function does not perform bounds checking
void	addMultiple(AArrayVector v, double factor)
void	addMultiple(AVector v, double factor) Adds a scaled multiple of another vector to this one
void	addMultipleToArray(double factor, int offset, double[] array, int arrayOffset, int length)
void	addProduct(AVector a, AVector b, double factor)
void	addProduct(AVector a, int aOffset, AVector b, int bOffset, double factor)
void	addProductToArray(double factor, int offset, AArrayVector other, int otherOffset, double[] array, int arrayOffset, int length)
void	addProductToArray(double factor, int offset, AVector other, int otherOffset, double[] array, int arrayOffset, int length)
void	addToArray(int offset, double[] array, int arrayOffset, int length)
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
void	copyTo(double[] data, int offset) Copies a the contents of a vector to a double array at the specified offset
void	copyTo(int offset, AArrayVector dest, int destOffset, int length)
void	copyTo(int start, 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)
void	divide(AVector v)
void	divide(double[] data, int offset)
void	divideTo(double[] data, int offset)
double	dotProduct(AVector v)
double	dotProduct(double[] data, int offset) Fast dot product with a double[] array.
double	elementSum() Returns the sum of all elements in a vector
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
void	fillRange(int offset, int length, double value)
abstract double	get(int i) Returns the double value at the specified position in a 1D vector
void	getElements(double[] dest, int offset) Gets all elements of the array, copying them into a double array
int	getStride() AArrayVector has a fixed stride of 1, which enables efficient operations on arrays
boolean	isPackedArray()
boolean	isView() Returns true if this vector is of a view type that references other vectors / data.
AVector	join(AArrayVector v)
AVector	join(AVector v) Returns a new vector that refers to this vector joined to a second vector
JoinedArrayVector	join(JoinedArrayVector v)
void	log() Computes the natural logarithm (in-place) for all array elements
double	magnitude() Returns the magnitude (Euclidean length) of the vector
double	magnitudeSquared()
void	multiply(AVector v)
void	multiply(double factor) Multiplies the vector by a constant factor
void	multiply(double[] data, int offset)
void	multiplyTo(double[] data, int offset)
long	nonZeroCount() Returns the number of non-zero elements in the array.
void	pow(double exponent) Raises all elements of the array to a specified power
void	reciprocal() Replaces all elements in the array with their reciprocal
void	scaleAdd(double factor, double constant) Scales all elements of the array by a given double value and adds a constant vale
void	set(AVector a) Sets the vector to equal the value of another vector
void	set(AVector a, int offset) Set the vector equal to an offset into another vector
abstract void	set(int i, double value)
void	setElements(double[] values, int offset, int length) Sets all elements in an array using the given double values
void	setRange(int offset, double[] data, int dataOffset, int length) Set a subrange of this vector from a double array
void	signum() Sets each component of the vector to its sign value (-1, 0 or 1)
AScalar	slice(int position) Returns the specified major slice of this array as a view (slice along dimension 0)
void	sqrt() Computes the square root of all elements in the array
void	square() Squares all elements of the vector
ArraySubVector	subVector(int offset, int length) Returns a vector referencing a sub-vector of the current vector
void	toDoubleBuffer(DoubleBuffer dest) Copies the elements of this INDArray to the specified double buffer
abstract double	unsafeGet(int i)
abstract void	unsafeSet(int i, double value)
void	validate() Validates the internal data structure of the INDArray.

Methods inherited from class mikera.vectorz.impl.AStridedVector

add, asDoubleArray, broadcast, broadcastLike, broadcastLike, clone, ensureMutable, getArray, getArrayOffset, getStride, getStrides

Methods inherited from class mikera.vectorz.AVector

add, add, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addProduct, addToArray, addWeighted, angle, applyOp, asElementList, asVector, clampMax, clampMin, compareTo, copyTo, copyTo, copyTo, crossProduct, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, dotProduct, dotProduct, elementCount, elementIterator, elementSquaredSum, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, exactClone, get, get, getLongShape, getShape, getShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, hashCode, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isElementConstrained, isFullyMutable, isMutable, isSameShape, isSameShape, isUnitLengthVector, isZero, iterator, length, logistic, maxAbsElement, multiply, negate, normalise, normaliseMaxAbsElement, outerProduct, outerProduct, projectToPlane, reshape, scale, scaleAdd, scaleToMagnitude, set, set, set, set, set, set, setElements, setValues, slice, sliceCount, sub, sub, sub, subMultiple, tanh, toDoubleArray, toList, toNormal, toString, toVector, zeroCount

Methods inherited from class mikera.arrayz.impl.AbstractArray

broadcastCloneLike, get, getSliceViews, isBoolean, scale, set, set, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.impl.IStridedArray

getShape

Methods inherited from interface mikera.arrayz.INDArray

add, applyOp, asElementList, asVector, broadcastCloneLike, copyTo, dimensionality, divide, divide, elementCount, elementIterator, elementSquaredSum, epsilonEquals, epsilonEquals, equals, exactClone, get, get, get, getLongShape, getShape, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, innerProduct, isBoolean, isElementConstrained, isFullyMutable, isMutable, isSameShape, isZero, multiply, negate, outerProduct, reshape, scale, set, set, set, set, set, setElements, slice, sliceCount, sub, sub, toArray, toDoubleArray, toVector

Constructor Detail

AArrayVector

public AArrayVector()

Method Detail

getStride

public final int getStride()

AArrayVector has a fixed stride of 1, which enables efficient operations on arrays

Specified by:

getStride in class AStridedVector

subVector

public ArraySubVector subVector(int offset,
                       int length)

Returns a vector referencing a sub-vector of the current vector

Overrides:

subVector in class AVector

Parameters:

offset -

length -

Returns:

slice

public AScalar slice(int position)

Description copied from interface: INDArray

Returns the specified major slice of this array as a view (slice along dimension 0)

Specified by:

slice in interface INDArray

Overrides:

slice in class AVector

Returns:

isPackedArray

public boolean isPackedArray()

Specified by:

isPackedArray in interface IStridedArray

Overrides:

isPackedArray in class AStridedVector

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:

toDoubleBuffer

public void toDoubleBuffer(DoubleBuffer dest)

Description copied from interface: INDArray

Copies the elements of this INDArray to the specified double buffer

Specified by:

toDoubleBuffer in interface INDArray

Overrides:

toDoubleBuffer in class AVector

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

fillRange

public void fillRange(int offset,
             int length,
             double value)

Overrides:

fillRange in class AVector

set

public void set(AVector a)

Description copied from class: AVector

Sets the vector to equal the value of another vector

Overrides:

set in class AVector

set

public void set(AVector a,
       int offset)

Description copied from class: AVector

Set the vector equal to an offset into another vector

Overrides:

set in class AVector

setRange

public void setRange(int offset,
            double[] data,
            int dataOffset,
            int length)

Description copied from class: AVector

Set a subrange of this vector from a double array

Overrides:

setRange in class AVector

setElements

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

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

getElements

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

Description copied from interface: INDArray

Gets all elements of the array, copying them into a double array

Specified by:

getElements in interface INDArray

Overrides:

getElements in class AVector

get

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

set

public abstract void set(int i,
       double value)

Specified by:

set in interface INDArray

Specified by:

set in interface IVector

Specified by:

set in class AVector

unsafeGet

public abstract double unsafeGet(int i)

Overrides:

unsafeGet in class AVector

unsafeSet

public abstract void unsafeSet(int i,
             double value)

Overrides:

unsafeSet in class AVector

add

public void add(AVector src)

Description copied from class: AVector

Adds another vector to this one

Overrides:

add in class AVector

add

public void add(AArrayVector v)

add

public void add(AVector src,
       int srcOffset)

Description copied from class: AVector

Adds part another vector to this one, starting at the specified offset in the source vector

Overrides:

add in class AVector

add

public void add(int offset,
       AVector src)

Description copied from class: AVector

Adds another vector into this one, at the specified offset

Overrides:

add in class AVector

add

public void add(int offset,
       AArrayVector src)

add

public void add(int offset,
       AArrayVector src,
       int srcOffset,
       int length)

addMultiple

public void addMultiple(AVector v,
               double factor)

Description copied from class: AVector

Adds a scaled multiple of another vector to this one

Overrides:

addMultiple in class AVector

scaleAdd

public void scaleAdd(double factor,
            double constant)

Description copied from interface: INDArray

Scales all elements of the array by a given double value and adds a constant vale

Specified by:

scaleAdd in interface INDArray

Overrides:

scaleAdd in class AVector

add

public void add(double constant)

Description copied from interface: INDArray

Adds a double value to all elements in this array

Specified by:

add in interface INDArray

Overrides:

add in class AVector

addProduct

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

Overrides:

addProduct in class AVector

addToArray

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

Overrides:

addToArray in class AVector

addProduct

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

Overrides:

addProduct in class AVector

addMultipleToArray

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

Overrides:

addMultipleToArray in class AVector

addProductToArray

public void addProductToArray(double factor,
                     int offset,
                     AVector other,
                     int otherOffset,
                     double[] array,
                     int arrayOffset,
                     int length)

Overrides:

addProductToArray in class AVector

addProductToArray

public void addProductToArray(double factor,
                     int offset,
                     AArrayVector other,
                     int otherOffset,
                     double[] array,
                     int arrayOffset,
                     int length)

Overrides:

addProductToArray in class AVector

add

public void add(AArrayVector src,
       int srcOffset)

addAt

public void addAt(int i,
         double v)

Description copied from class: AVector

Adds a value to a specific element of the vector This function does not perform bounds checking

Overrides:

addAt in class AVector

dotProduct

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

Description copied from class: AVector

Fast dot product with a double[] array.

Overrides:

dotProduct in class AStridedVector

Returns:

dotProduct

public double dotProduct(AVector v)

Overrides:

dotProduct in class AVector

abs

public void abs()

Description copied from class: AVector

Sets each component of the vector to its absolute value

Specified by:

abs in interface INDArray

Overrides:

abs in class AVector

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

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

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

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:

square

public void square()

Description copied from class: AVector

Squares all elements of the vector

Specified by:

square in interface INDArray

Overrides:

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

signum

public void signum()

Sets each component of the vector to its sign value (-1, 0 or 1)

Specified by:

signum in interface INDArray

Overrides:

signum in class AVector

multiply

public void multiply(AVector v)

Overrides:

multiply in class AVector

multiply

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

Overrides:

multiply in class AVector

multiplyTo

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

Overrides:

multiplyTo in class AVector

divide

public void divide(AVector v)

Overrides:

divide in class AVector

divide

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

Overrides:

divide in class AVector

divideTo

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

Overrides:

divideTo in class AVector

copyTo

public void copyTo(int start,
          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,
          AArrayVector dest,
          int destOffset,
          int length)

copyTo

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

Overrides:

copyTo in class AVector

addMultiple

public void addMultiple(AArrayVector v,
               double factor)

magnitudeSquared

public double magnitudeSquared()

Overrides:

magnitudeSquared in class AVector

magnitude

public double magnitude()

Description copied from class: AVector

Returns the magnitude (Euclidean length) of the vector

Overrides:

magnitude in class AVector

Returns:

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

pow

public void pow(double exponent)

Description copied from interface: INDArray

Raises all elements of the array to a specified power

Specified by:

pow in interface INDArray

Overrides:

pow in class AVector

reciprocal

public void reciprocal()

Description copied from interface: INDArray

Replaces all elements in the array with their reciprocal

Specified by:

reciprocal in interface INDArray

Overrides:

reciprocal in class AbstractArray<Double>

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

multiply

public void multiply(double factor)

Description copied from class: AVector

Multiplies the vector by a constant factor

Specified by:

multiply in interface INDArray

Overrides:

multiply in class AVector

Parameters:

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

join

public AVector join(AVector v)

Description copied from class: AVector

Returns a new vector that refers to this vector joined to a second vector

Overrides:

join in class AVector

Returns:

join

public AVector join(AArrayVector v)

join

public JoinedArrayVector join(JoinedArrayVector v)

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