mikera.vectorz

Class AVector

java.lang.Object

mikera.vectorz.AVector

All Implemented Interfaces:

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

Direct Known Subclasses:

ADerivedVector, APrimitiveVector, ArrayVector, ASparseVector, BitVector, ComputedVector, IdenticalElementVector, IndexedArrayVector, IndexedSubVector, JoinedVector, MatrixSubVector, SingleElementVector, WrappedSubVector

public abstract class AVector
extends Object
implements IVector, Cloneable, Comparable<AVector>, Serializable, Iterable<Double>

Main abstract base class for all types of vector Contains default implementations for most vector operations which can be overriden to achieve better performance in derived classes.

Author:

Mike

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AVector()

Method Summary

Methods

Modifier and Type	Method and Description
void	absolute() Sets each component of the vector to its absolute value
void	add(AVector v) Adds another vector to this one
void	add(AVector v, int offset) Adds another vector to this one
void	addMultiple(AVector v, double factor) Adds a scaled multiple of another vector to this one
void	addMultiple(AVector v, double factor, int srcOffset)
void	addMultiple(Vector vector, Index index, double factor)
void	addMultipleToArray(double factor, int offset, double[] array, int arrayOffset, int length)
void	addProduct(AVector a, AVector b)
void	addProduct(AVector a, AVector b, double factor)
void	addProduct(AVector a, int aOffset, AVector b, int bOffset, double factor)
void	addToArray(int offset, double[] array, int arrayOffset, int length)
void	addWeighted(AVector v, double factor) Updates a weighted average of this vector with another vector
double	angle(AVector v) Returns the Euclidean angle between this vector and another vector
List<Double>	asList()
AVector	asVector()
void	clamp(double min, double max) Clamps all values in the vector to a given range
void	clampMax(double max)
void	clampMin(double min)
AVector	clone() Clones the vector, creating a new copy of all data.
int	compareTo(AVector a)
void	copy(int start, int length, AVector dest, int destOffset) Copies a subset of this vector to a vector at the specified offset
void	copyTo(AVector dest, int offset) Copies a the contents of a vector to a vector at the specified offset
void	copyTo(double[] data, int offset) Copies a the contents of a vector to a double array at the specified offset
int	dimensionality()
double	distance(AVector v)
double	distanceL1(AVector v)
double	distanceLinf(AVector v)
double	distanceSquared(AVector v)
void	divide(AVector v)
void	divide(double factor)
void	divide(double[] data, int offset)
void	divideTo(double[] data, int offset)
double	dotProduct(AVector v)
double	dotProduct(AVector v, Index ix)
double	elementSum() Returns the sum of all elements in a vector
boolean	epsilonEquals(AVector v)
boolean	epsilonEquals(AVector v, double tolerance)
boolean	equals(Object o) Test for equality on vectors.
void	fill(double value) Fills the entire vector with a given value
void	fillRange(int offset, int length, double value)
double	get(int... indexes)
abstract double	get(int i)
int	hashCode()
void	interpolate(AVector a, AVector b, double alpha)
void	interpolate(AVector v, double alpha)
boolean	isFullyMutable() Returns true if this vector is fully mutable, i.e.
boolean	isMutable() Returns true if this vector is mutable.
boolean	isReference() Returns true if this vector is of a type that references other vectors / data.
boolean	isUnitLengthVector() Returns true if the vector has unit length
boolean	isZeroVector() Returns true if this vector is a zero vector (all components zero)
Iterator<Double>	iterator()
AVector	join(AVector second) Returns a new vector that refers to this vector joined to a second vector
abstract int	length()
double	magnitude() Returns the magnitude (Euclidean length) of the vector
double	magnitudeSquared()
double	maxAbsElement() Returns the maximum absolute element of a vector
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)
void	negate()
double	normalise()
double	normaliseMaxAbsElement() Normalises so that the maximum absolute element is 1.0 Returns the previous maximum absolute element.
void	projectToPlane(AVector normal, double distance)
INDArray	reshape(int... dimensions)
void	scale(AVector v) Scales the vector by another vector of the same size
void	scale(double factor) Scales the vector by a scalar factor
void	scaleAdd(double factor, AVector v)
double	scaleToMagnitude(double targetMagnitude) Scales the vector up to a specific target magnitude
void	set(AVector a) Sets the vector to equal the value of another vector
void	set(AVector v, Index indexes) sets the vector using values indexed from 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	set(IVector vector)
void	setValues(double... values)
void	sub(AVector v) Subtracts a vector from this vector
void	subMultiple(AVector v, double factor) Subtracts a scaled multiple of another vector from this vector
AVector	subVector(int offset, int length) Obtains a sub-vector that refers to this vector.
double[]	toArray()
List<Double>	toList()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AVector

public AVector()

Method Detail

length

public abstract int length()

Specified by:

length in interface IVector

get

public abstract double get(int i)

Specified by:

get in interface IVector

set

public abstract void set(int i,
       double value)

Specified by:

set in interface IVector

dimensionality

public int dimensionality()

Specified by:

dimensionality in interface INDArray

get

public double get(int... indexes)

Specified by:

get in interface INDArray

subVector

public AVector subVector(int offset,
                int length)

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

join

public AVector join(AVector second)

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

Parameters:

second -

Returns:

compareTo

public int compareTo(AVector a)

Specified by:

compareTo in interface Comparable<AVector>

equals

public boolean equals(Object o)

Test for equality on vectors. Returns true iff all values in the vector are identical

Overrides:

equals in class Object

toList

public List<Double> toList()

epsilonEquals

public boolean epsilonEquals(AVector v)

epsilonEquals

public boolean epsilonEquals(AVector v,
                    double tolerance)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

copyTo

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

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

toArray

public double[] toArray()

copyTo

public void copyTo(AVector dest,
          int offset)

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

copy

public void copy(int start,
        int length,
        AVector dest,
        int destOffset)

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

fill

public void fill(double value)

Fills the entire vector with a given value

Parameters:

value -

fillRange

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

clamp

public void clamp(double min,
         double max)

Clamps all values in the vector to a given range

Parameters:

value -

clampMax

public void clampMax(double max)

clampMin

public void clampMin(double min)

multiply

public void multiply(double factor)

Multiplies the vector by a constant factor

Parameters:

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

multiply

public void multiply(AVector v)

multiply

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

multiplyTo

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

divide

public void divide(double factor)

divide

public void divide(AVector v)

divide

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

divideTo

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

absolute

public void absolute()

Sets each component of the vector to its absolute value

scale

public void scale(double factor)

Scales the vector by a scalar factor

Parameters:

factor -

scale

public void scale(AVector v)

Scales the vector by another vector of the same size

Parameters:

v -

scaleToMagnitude

public double scaleToMagnitude(double targetMagnitude)

Scales the vector up to a specific target magnitude

Returns:

the old magnitude of the vector

scaleAdd

public void scaleAdd(double factor,
            AVector v)

interpolate

public void interpolate(AVector v,
               double alpha)

interpolate

public void interpolate(AVector a,
               AVector b,
               double alpha)

magnitudeSquared

public double magnitudeSquared()

dotProduct

public double dotProduct(AVector v)

dotProduct

public double dotProduct(AVector v,
                Index ix)

magnitude

public double magnitude()

Returns the magnitude (Euclidean length) of the vector

Returns:

distanceSquared

public double distanceSquared(AVector v)

distance

public double distance(AVector v)

distanceL1

public double distanceL1(AVector v)

distanceLinf

public double distanceLinf(AVector v)

maxAbsElement

public double maxAbsElement()

Returns the maximum absolute element of a vector

Returns:

normaliseMaxAbsElement

public double normaliseMaxAbsElement()

Normalises so that the maximum absolute element is 1.0 Returns the previous maximum absolute element.

elementSum

public double elementSum()

Returns the sum of all elements in a vector

Returns:

angle

public double angle(AVector v)

Returns the Euclidean angle between this vector and another vector

Returns:

angle in radians

normalise

public double normalise()

negate

public void negate()

set

public void set(AVector a)

Sets the vector to equal the value of another vector

set

public void set(AVector a,
       int offset)

Set the vector equal to an offset into another vector

Parameters:

a -

offset -

setValues

public void setValues(double... values)

clone

public AVector clone()

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)

Overrides:

clone in class Object

asVector

public AVector asVector()

Specified by:

asVector in interface INDArray

reshape

public INDArray reshape(int... dimensions)

Specified by:

reshape in interface INDArray

isReference

public boolean isReference()

Returns true if this vector is of a type that references other vectors / data.

Returns:

isMutable

public boolean isMutable()

Returns true if this vector is mutable.

Returns:

isFullyMutable

public boolean isFullyMutable()

Returns true if this vector is fully mutable, i.e. can contain any unconstrained double values

Returns:

add

public void add(AVector v)

Adds another vector to this one

Parameters:

v -

add

public void add(AVector v,
       int offset)

Adds another vector to this one

Parameters:

v -

addProduct

public void addProduct(AVector a,
              AVector b)

addProduct

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

addMultiple

public void addMultiple(AVector v,
               double factor)

Adds a scaled multiple of another vector to this one

Parameters:

v -

addMultiple

public void addMultiple(AVector v,
               double factor,
               int srcOffset)

addWeighted

public void addWeighted(AVector v,
               double factor)

Updates a weighted average of this vector with another vector

Parameters:

v -

sub

public void sub(AVector v)

Subtracts a vector from this vector

Parameters:

v -

isZeroVector

public boolean isZeroVector()

Returns true if this vector is a zero vector (all components zero)

Returns:

isUnitLengthVector

public boolean isUnitLengthVector()

Returns true if the vector has unit length

Returns:

projectToPlane

public void projectToPlane(AVector normal,
                  double distance)

subMultiple

public void subMultiple(AVector v,
               double factor)

Subtracts a scaled multiple of another vector from this vector

Parameters:

v -

toString

public String toString()

Overrides:

toString in class Object

asList

public List<Double> asList()

iterator

public Iterator<Double> iterator()

Specified by:

iterator in interface Iterable<Double>

set

public void set(IVector vector)

addMultiple

public void addMultiple(Vector vector,
               Index index,
               double factor)

set

public void set(AVector v,
       Index indexes)

sets the vector using values indexed from another vector

addToArray

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

addMultipleToArray

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

addProduct

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