mikera.vectorz

Class ArrayVector

java.lang.Object

mikera.arrayz.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.ArrayVector

All Implemented Interfaces:

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

Direct Known Subclasses:

ArraySubVector, GrowableVector, Vector

public abstract class ArrayVector
extends AVector

Base class for vectors backed by a double[] array. The double array can be directly accessed for performance purposes

Author:

Mike

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ArrayVector()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ArrayVector v)
void	add(ArrayVector 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)
void	add(int offset, ArrayVector src)
void	add(int offset, ArrayVector 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)
void	addMultiple(ArrayVector 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, ArrayVector 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	copyTo(double[] data, int offset) Copies a the contents of a vector to a double array at the specified offset
void	copyTo(int offset, ArrayVector 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	elementSum() Returns the sum of all elements in a vector
void	fillRange(int offset, int length, double value)
abstract double[]	getArray()
abstract int	getArrayOffset()
void	getElements(double[] dest, int offset) Gets all elements of the array, copying them into a double array
boolean	isView() Returns true if this vector is of a view type that references other vectors / data.
AVector	join(ArrayVector v)
AVector	join(AVector v) Returns a new vector that refers to this vector joined to a second vector
JoinedArrayVector	join(JoinedArrayVector v)
double	magnitude() Returns the magnitude (Euclidean length) of the vector
double	magnitudeSquared()
void	multiply(AVector v)
void	multiply(double[] data, int offset)
void	multiplyTo(double[] data, int offset)
void	scaleAdd(double factor, double constant)
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
void	set(int offset, double[] data, int dataOffset, int length) Set part of this vector from a double array
void	setElements(double[] values, int offset, int length)
AScalar	slice(int position)
void	square()
ArraySubVector	subVector(int offset, int length) Returns a vector referencing a sub-vector of the current vector
void	validate() Validates the internal data structure of the INDArray.

Methods inherited from class mikera.vectorz.AVector

abs, add, add, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addProduct, addWeighted, angle, applyOp, asElementList, asVector, broadcast, clamp, clampMax, clampMin, clone, compareTo, copyTo, copyTo, countZeros, crossProduct, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, dotProduct, dotProduct, elementCount, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, exactClone, fill, get, get, getLongShape, getShape, getSlices, hashCode, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isElementConstrained, isFullyMutable, isMutable, isUnitLengthVector, isZeroVector, iterator, length, maxAbsElement, multiply, negate, normalise, normaliseMaxAbsElement, outerProduct, outerProduct, projectToPlane, reshape, scale, scaleAdd, scaleToMagnitude, set, 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

ArrayVector

public ArrayVector()

Method Detail

getArray

public abstract double[] getArray()

getArrayOffset

public abstract int getArrayOffset()

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)

Specified by:

slice in interface INDArray

Overrides:

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

Returns:

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

set

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

Description copied from class: AVector

Set part of this vector from a double array

Overrides:

set in class AVector

setElements

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

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

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(ArrayVector 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,
       ArrayVector src)

add

public void add(int offset,
       ArrayVector 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)

Overrides:

scaleAdd in class AVector

add

public void add(double constant)

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,
                     ArrayVector other,
                     int otherOffset,
                     double[] array,
                     int arrayOffset,
                     int length)

Overrides:

addProductToArray in class AVector

add

public void add(ArrayVector src,
       int srcOffset)

addAt

public void addAt(int i,
         double v)

Overrides:

addAt 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

elementSum

public double elementSum()

Description copied from class: AVector

Returns the sum of all elements in a vector

Overrides:

elementSum in class AVector

Returns:

square

public void square()

Overrides:

square 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,
          ArrayVector 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(ArrayVector 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:

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