mikera.vectorz

Class Vector4

java.lang.Object

mikera.arrayz.impl.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.impl.APrimitiveVector

mikera.vectorz.Vector4

All Implemented Interfaces:

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

public final class Vector4
extends APrimitiveVector

Specialised 4D vector

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
double	t
double	x
double	y
double	z

Constructor Summary

Constructors

Constructor and Description
Vector4()
Vector4(double... values)
Vector4(double x, double y, double z, double t)
Vector4(Vector4 source)

Method Summary

Modifier and Type	Method and Description
void	add(AVector v) Adds another vector to this one
void	add(double dx, double dy, double dz, double dt)
void	add(Vector4 a)
void	addAt(int i, double value) Adds a value to a specific element of the vector This function does not perform bounds checking, i.e.
void	addMultiple(AVector v, double factor) Adds a scaled multiple of another vector to this vector
void	addMultiple(double dx, double dy, double dz, double dt, double factor)
void	addMultiple(Vector4 v, double factor)
void	addProduct(Vector4 a, Vector4 b)
void	addProduct(Vector4 a, Vector4 b, double factor)
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
Vector4	clone() Clones the vector, creating a new mutable copy of all data.
double	dotProduct(AVector v) Returns the dot product of this vector with another vector The vectors must have the same length: if not the result is undefined
double	dotProduct(double[] as, int offset) Fast dot product with a double[] array.
double	dotProduct(Vector4 a)
double	elementProduct() Returns the product of all elements in the array.
double	elementSquaredSum() Returns the sum of squared elements in this array.
double	elementSum() Returns the sum of all elements in a vector
boolean	equalsArray(double[] data, int offset) Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset
Vector4	exactClone() Returns an exact clone of this vector, i.e.
double	get(int i) Returns the double value at the specified position in a 1D vector
void	getElements(double[] data, int offset) Gets all elements of the array, copying them into a double array at the specified offset
double	getT()
double	getX()
double	getY()
double	getZ()
boolean	isZero() Returns true if this vector is a zero vector (all components zero)
int	length() Returns the length of a vector, in terms of the number of elements.
void	multiply(double factor) Multiplies the vector by a constant factor
void	negate() Negates all emlements of this vector in place.
static Vector4	of(double... values)
static Vector4	of(double x, double y, double z, double t)
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	set(int i, double value) Sets a value at a given position in a mutable 1D array
void	set(Vector4 a)
void	setValues(double x, double y, double z, double t)
double[]	toDoubleArray() Copies the elements of this array to a new double[] array.
void	toDoubleBuffer(DoubleBuffer dest) Copies the elements of this INDArray to the specified double buffer

Methods inherited from class mikera.vectorz.impl.APrimitiveVector

isFullyMutable, isMutable, isView, sparse, sparseClone, toNormal

Methods inherited from class mikera.vectorz.AVector

abs, absCopy, add, add, add, add, add, add, add, add, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, 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, checkIndex, checkLength, checkRange, checkSameLength, checkSameLength, checkSameLength, clamp, clampMax, clampMin, compareTo, copy, copyTo, copyTo, copyTo, copyTo, copyTo, crossProduct, crossProduct, dense, denseClone, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divide, divideCopy, divideCopy, divideTo, dotProduct, dotProduct, dotProduct, elementAbsPowSum, elementCount, elementIterator, elementMax, elementMin, elementPowSum, elementsEqual, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, fill, fillRange, get, get, get, get, get, getElements, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isElementConstrained, isRangeZero, isSameShape, isSameShape, isUnitLengthVector, isUnitLengthVector, iterator, join, join, join, log, logistic, magnitude, magnitudeSquared, maxAbsElement, maxAbsElementIndex, maxElement, maxElementIndex, minElement, minElementIndex, multiply, multiply, multiply, multiply, multiplyCopy, multiplyCopy, multiplyCopy, multiplyTo, mutable, negateCopy, nonSparseIndex, nonZeroCount, nonZeroIndices, nonZeroValues, normalise, normaliseCopy, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateCopy, rotateView, rotateView, scale, scaleAdd, scaleAdd, scaleAdd, scaleAdd, scaleCopy, scaleToMagnitude, select, selectClone, selectView, set, set, set, set, set, set, set, set, set, set, setElements, setElements, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, shiftCopy, signum, slice, slice, sliceCount, sliceValue, softmax, softmaxCopy, sqrtCopy, square, squareCopy, sub, sub, subArray, subAt, subCopy, subCopy, subMultiple, subVector, tanh, toList, toSliceArray, toString, toStringFull, toVector, tryEfficientJoin, unsafeGet, unsafeSet, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray

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

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, componentCount, ensureMutable, exp, get, get, get, getComponent, getComponents, getElements, getElements, getSlices, getSliceViews, isBoolean, isDense, isSparse, reciprocal, reciprocalCopy, scale, set, set, signumCopy, sqrt, sub, toArray, withComponents

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

x

public double x

y

public double y

z

public double z

t

public double t

Constructor Detail

Vector4

public Vector4()

Vector4

public Vector4(Vector4 source)

Vector4

public Vector4(double x,
               double y,
               double z,
               double t)

Vector4

public Vector4(double... values)

Method Detail

of

public static Vector4 of(double x,
                         double y,
                         double z,
                         double t)

of

public static Vector4 of(double... values)

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

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

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

add

public void add(double dx,
                double dy,
                double dz,
                double dt)

add

public void add(AVector v)

Description copied from class: AVector

Adds another vector to this one

Overrides:

add in class AVector

add

public void add(Vector4 a)

set

public void set(Vector4 a)

negate

public void negate()

Description copied from class: AVector

Negates all emlements of this vector in place.

Specified by:

negate in interface INDArray

Overrides:

negate 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

addMultiple

public void addMultiple(double dx,
                        double dy,
                        double dz,
                        double dt,
                        double factor)

addMultiple

public void addMultiple(AVector v,
                        double factor)

Description copied from class: AVector

Adds a scaled multiple of another vector to this vector

Overrides:

addMultiple in class AVector

addMultiple

public void addMultiple(Vector4 v,
                        double factor)

addProduct

public void addProduct(Vector4 a,
                       Vector4 b)

addProduct

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

dotProduct

public double dotProduct(Vector4 a)

dotProduct

public double dotProduct(double[] as,
                         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(AVector v)

Description copied from class: AVector

Returns the dot product of this vector with another vector The vectors must have the same length: if not the result is undefined

Overrides:

dotProduct in class AVector

Returns:

length

public int length()

Description copied from interface: IVector

Returns the length of a vector, in terms of the number of elements. For Euclidean length, use magnitude() instead

Specified by:

length in interface IVector

Specified by:

length in class AVector

Returns:

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

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

elementProduct

public double elementProduct()

Description copied from interface: INDArray

Returns the product of all elements in the array.

Specified by:

elementProduct in interface INDArray

Overrides:

elementProduct in class AVector

Returns:

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

set

public void set(int i,
                double value)

Description copied from interface: INDArray

Sets a value at a given position in a mutable 1D array

Specified by:

set in interface INDArray

Specified by:

set in interface IVector

Specified by:

set in class AVector

addAt

public void addAt(int i,
                  double value)

Description copied from class: AVector

Adds a value to a specific element of the vector This function does not perform bounds checking, i.e. is an unsafe operation

Overrides:

addAt in class AVector

setValues

public void setValues(double x,
                      double y,
                      double z,
                      double t)

getElements

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

Description copied from interface: INDArray

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

Specified by:

getElements in interface INDArray

Overrides:

getElements in class AVector

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

toDoubleArray

public double[] toDoubleArray()

Description copied from interface: INDArray

Copies the elements of this array to a new double[] array.

Specified by:

toDoubleArray in interface INDArray

Overrides:

toDoubleArray in class AVector

clone

public Vector4 clone()

Description copied from class: AVector

Clones the vector, creating a new mutable 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

Specified by:

clone in interface IVector

Specified by:

clone in class APrimitiveVector

getX

public double getX()

Overrides:

getX in class APrimitiveVector

getY

public double getY()

Overrides:

getY in class APrimitiveVector

getZ

public double getZ()

Overrides:

getZ in class APrimitiveVector

getT

public double getT()

Overrides:

getT in class APrimitiveVector

exactClone

public Vector4 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 APrimitiveVector

Returns:

A clone of the original array

equalsArray

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

Parameters:

data - Array of double element values to check for equality

offset - Offset into the data array

Returns: