mikera.vectorz

Class Vector

java.lang.Object

mikera.arrayz.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.ArrayVector

mikera.vectorz.Vector

All Implemented Interfaces:

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

public final class Vector
extends ArrayVector

General purpose vector of arbitrary length, backed by an internal double[] array

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
double[]	data

Constructor Summary

Constructors

Constructor and Description
Vector(AVector source) Copy constructor from an arbitrary vector

Method Summary

Methods

Modifier and Type	Method and Description
void	abs() Sets each component of the vector to its absolute value
void	add(ArrayVector src, int srcOffset)
void	add(AVector v) Adds another vector to this one
void	add(double constant)
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	addMultiple(Index destToSource, Vector source, double factor) Adds to this vector at taking values from source at the specified indexes which should map from this->source
void	addMultiple(Vector source, Index index, double factor) Adds source vector to this vector at the specified indexes which should map from source->this
void	addProduct(AVector a, AVector b)
void	addProduct(Vector a, Vector b)
void	addProduct(Vector a, Vector b, double factor)
void	addWeighted(ArrayVector v, double factor)
void	addWeighted(AVector v, double factor) Updates a weighted average of this vector with another vector
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
Vector	clone() Clones the vector, creating a new copy of all data.
static Vector	create(AVector a)
static Vector	createLength(int length) Create an empty (zero-filled) vector of a specified length
double	distance(AVector v)
double	distance(Vector v)
double	distanceSquared(Vector v)
double	dotProduct(AVector v)
double	dotProduct(AVector v, Index ix)
double	dotProduct(Vector v)
double	dotProduct(Vector v, Index ix)
double	elementSum() Returns the sum of all elements in a vector
Vector	exactClone() Returns an exact clone of this vector, i.e.
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
double[]	getArray()
int	getArrayOffset()
void	getElements(double[] dest, int offset) Gets all elements of the array, copying them into a double array
boolean	isPackedArray()
boolean	isView() Returns true if this vector is of a view type that references other vectors / data.
int	length()
void	multiply(AVector v)
void	multiply(double factor) Multiplies the vector by a constant factor
void	multiply(Vector v)
long	nonZeroCount() Returns the number of non-zero elements in the array.
static Vector	of(double... values) Create a vector with specific component values.
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(int i, double value)
void	set(int offset, double[] data, int dataOffset, int length) Set part of this vector from a double array
void	signum() Sets each component of the vector to its sign value (-1, 0 or 1)
void	square() Squares all elements of the vector
void	sub(ArrayVector v)
void	sub(ArrayVector src, int srcOffset)
void	sub(AVector v) Subtracts a vector from this vector
static Vector	wrap(double[] source) Wraps a double array into a Vector, does *no defensive copy* so use with caution

Methods inherited from class mikera.vectorz.ArrayVector

add, add, add, add, add, addMultipleToArray, addProduct, addProduct, addProductToArray, addProductToArray, addToArray, copyTo, copyTo, copyTo, copyTo, divide, divide, divideTo, exp, fillRange, join, join, join, log, magnitude, magnitudeSquared, multiply, multiplyTo, pow, reciprocal, set, setElements, slice, sqrt, subVector, toDoubleBuffer, validate

Methods inherited from class mikera.vectorz.AVector

add, add, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addToArray, angle, applyOp, asElementList, asVector, broadcast, clampMax, clampMin, compareTo, copyTo, copyTo, copyTo, countZeros, crossProduct, dimensionality, distanceL1, distanceLinf, distanceSquared, divide, elementCount, elementSquaredSum, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, get, getLongShape, getShape, getShape, getSlices, getTranspose, getTransposeView, hashCode, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isElementConstrained, isFullyMutable, isMutable, isUnitLengthVector, isZeroVector, iterator, maxAbsElement, multiply, negate, normalise, normaliseMaxAbsElement, outerProduct, outerProduct, projectToPlane, reshape, scale, scaleAdd, scaleToMagnitude, set, set, set, set, set, set, setElements, setValues, slice, sliceCount, sub, sub, subMultiple, toArray, toList, toString, toVector

Methods inherited from class mikera.arrayz.AbstractArray

epsilonEquals, epsilonEquals, get, get, getSliceViews, scale, set, set

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

epsilonEquals, epsilonEquals, get, get, getSliceViews, scale, set, set

Field Detail

data

public final double[] data

Constructor Detail

Vector

public Vector(AVector source)

Copy constructor from an arbitrary vector

Parameters:

source -

Method Detail

wrap

public static Vector wrap(double[] source)

Wraps a double array into a Vector, does *no defensive copy* so use with caution

Parameters:

source -

Returns:

of

public static Vector of(double... values)

Create a vector with specific component values. Creates a copy of the value array

Parameters:

values -

Returns:

createLength

public static Vector createLength(int length)

Create an empty (zero-filled) vector of a specified length

Parameters:

length -

Returns:

create

public static Vector create(AVector a)

length

public int length()

Specified by:

length in interface IVector

Specified by:

length 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

Returns:

set

public void set(int i,
       double value)

Specified by:

set in interface INDArray

Specified by:

set in interface IVector

Specified by:

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 ArrayVector

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 ArrayVector

getArray

public double[] getArray()

Specified by:

getArray in class ArrayVector

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 ArrayVector

getArrayOffset

public int getArrayOffset()

Specified by:

getArrayOffset in class ArrayVector

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 ArrayVector

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 ArrayVector

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 ArrayVector

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 ArrayVector

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 ArrayVector

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 ArrayVector

Returns:

signum

public void signum()

Description copied from class: ArrayVector

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

Specified by:

signum in interface INDArray

Overrides:

signum in class ArrayVector

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 ArrayVector

add

public void add(ArrayVector src,
       int srcOffset)

Overrides:

add in class ArrayVector

addMultiple

public void addMultiple(ArrayVector v,
               double factor)

Overrides:

addMultiple in class ArrayVector

add

public void add(AVector v)

Description copied from class: AVector

Adds another vector to this one

Overrides:

add in class ArrayVector

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 ArrayVector

add

public void add(double constant)

Specified by:

add in interface INDArray

Overrides:

add in class ArrayVector

addProduct

public void addProduct(AVector a,
              AVector b)

Overrides:

addProduct in class AVector

addProduct

public void addProduct(Vector a,
              Vector b)

addProduct

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

addAt

public void addAt(int i,
         double v)

Overrides:

addAt in class ArrayVector

sub

public void sub(AVector v)

Description copied from class: AVector

Subtracts a vector from this vector

Overrides:

sub in class AVector

dotProduct

public double dotProduct(AVector v,
                Index ix)

Overrides:

dotProduct in class AVector

dotProduct

public double dotProduct(Vector v,
                Index ix)

dotProduct

public double dotProduct(AVector v)

Overrides:

dotProduct in class AVector

dotProduct

public double dotProduct(Vector v)

distanceSquared

public double distanceSquared(Vector v)

distance

public double distance(Vector v)

distance

public double distance(AVector v)

Overrides:

distance in class AVector

sub

public void sub(ArrayVector v)

sub

public void sub(ArrayVector src,
       int srcOffset)

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 ArrayVector

addWeighted

public void addWeighted(AVector v,
               double factor)

Description copied from class: AVector

Updates a weighted average of this vector with another vector

Overrides:

addWeighted in class AVector

addWeighted

public void addWeighted(ArrayVector v,
               double factor)

addMultiple

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

Description copied from class: AVector

Adds source vector to this vector at the specified indexes which should map from source->this

Overrides:

addMultiple in class AVector

addMultiple

public void addMultiple(Index destToSource,
               Vector source,
               double factor)

Description copied from class: AVector

Adds to this vector at taking values from source at the specified indexes which should map from this->source

Overrides:

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

Parameters:

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

multiply

public void multiply(AVector v)

Overrides:

multiply in class ArrayVector

multiply

public void multiply(Vector v)

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 ArrayVector

Returns:

clone

public Vector clone()

Description copied from class: AVector

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)

Specified by:

clone in interface INDArray

Overrides:

clone in class AVector

Returns:

exactClone

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

isPackedArray

public boolean isPackedArray()

Overrides:

isPackedArray in class ArrayVector