Vector2

Documentation of 'mikera.vectorz.Vector2' Java class Vector2

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- mikera.arrayz.impl.AbstractArray<java.lang.Double>
- - mikera.vectorz.AVector
  - - mikera.vectorz.impl.APrimitiveVector
    - - mikera.vectorz.Vector2

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<java.lang.Double>, INDArray, IVector
```
public final class Vector2
extends APrimitiveVector
```
Specialised 2D vector

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

double x

double y

Fields
Modifier and Type	Field and Description
`double`	`x`
`double`	`y`

Constructor Summary

Constructors
Constructor and Description

Vector2()

Vector2(double x, double y)

Constructors
Constructor and Description
`Vector2()`
`Vector2(double x, double y)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(AVector v)` Adds another vector to this one
`void`	`add(double constant)` Adds a double value to all elements in this array.
`void`	`add(double dx, double dy)`
`void`	`add(Vector2 v)`
`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(Vector2 v, double factor)`
`void`	`addProduct(Vector2 a, Vector2 b)`
`void`	`addProduct(Vector2 a, Vector2 b, double factor)`
`void`	`applyOp(Op op)` Applies a unary operator to all elements of the array (in-place)
`Vector2`	`clone()` Clones the vector, creating a new mutable copy of all data.
`Vector2`	`complexConjugate()`
`void`	`complexMultiply(Vector2 a)` Complex multiplication by another Vector2, treating an (x,y) vector as the complex value x+iy
`Vector2`	`complexNegation()`
`Vector2`	`complexReciprocal()`
`static Vector2`	`create(AVector v)`
`double`	`dotProduct(AVector a)` 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[] data, int offset)` Fast dot product with a double[] array.
`double`	`dotProduct(Vector2 a)`
`double`	`elementMax()` Returns the maximum element value in this array.
`double`	`elementMin()` Returns the maximum element value in this array.
`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`	`equals(AVector v)` Returns true if this array is exactly equal to a vector.
`boolean`	`equals(Vector2 v)`
`boolean`	`equalsArray(double[] data, int offset)` Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset
`Vector2`	`exactClone()` Returns an exact clone of this vector, i.e.
`void`	`fill(double v)` Fills the entire vector with a given value
`double`	`get(int i)` Returns the double value at the specified position in a 1D vector
`void`	`getElements(double[] data, int offset)` Copies all elements of this array a double array at the specified offset
`double`	`getX()`
`double`	`getY()`
`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.
`double`	`magnitude()` Returns the magnitude (Euclidean length) of the vector
`void`	`multiply(double factor)` Multiplies the vector by a constant factor
`void`	`negate()` Negates all emlements of this vector in place.
`static Vector2`	`of(double... values)`
`static Vector2`	`of(double x, double y)`
`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`	`rotate2D(double angle)` Rotates a 2D vector around the origin by a given angle in radians
`Vector2`	`rotate2DCopy(double angle)` Rotates a 2D vector around the origin by a given angle in radians, returning a new Vector2
`void`	`scaleAdd(double factor, AVector constant)` Scales this vector then adds another vector
`void`	`scaleAdd(double factor, double constant)` Scales this vector and adds a constant to every element
`void`	`scaleAdd(double factor, Vector2 constant)`
`void`	`set(int i, double value)` Sets a value at a given position in a mutable 1D array
`void`	`setValues(double x, double y)`
`void`	`sub(Vector2 v)`
`double[]`	`toDoubleArray()` Copies the elements of this array to a new double[] array.
`void`	`toDoubleBuffer(java.nio.DoubleBuffer dest)` Copies the elements of this INDArray to the specified double buffer.
`Vector2`	`toNormal()` Creates a new mutable vector representing the normalised value of this vector Returns null if the vector cannot be normalised (i.e.
`double`	`unsafeGet(int i)` Like get, but performs no bounds checking.
`void`	`unsafeSet(int i, double value)` Like set, but performs no bounds checking.

Methods inherited from class mikera.vectorz.impl.APrimitiveVector
getT, getZ, isFullyMutable, isMutable, isView, sparse, sparseClone, visitNonZero

Methods inherited from class mikera.vectorz.AVector
abs, absCopy, absDiff, absDiff, absDiff, absDiffCopy, add, add, add, add, add, add, add, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleCopy, addMultipleSparse, addMultipleSparse, addMultipleToArray, addMultipleToArray, addPower, addPower, addProduct, addProduct, addProduct, addProductCopy, addProductCopy, addProductToArray, addProductToArray, addSparse, addSparse, addToArray, addToArray, addToArray, addWeighted, angle, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, broadcastLike, checkIndex, checkLength, checkRange, clamp, clampMax, clampMin, compareTo, compareTo, copy, copyTo, copyTo, copyTo, copyTo, copyTo, crossProduct, crossProduct, dense, denseClone, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divide, divideCopy, divideCopy, divideCopy, divideTo, dotProduct, dotProduct, dotProduct, elementAbsPowSum, elementCount, elementIterator, elementMaxAbs, elementPowSum, elementsEqual, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equalsArray, fillRange, get, get, get, get, get, get, getElement, 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, 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, reciprocal, reciprocalCopy, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateCopy, rotateView, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, scaleToMagnitude, select, selectClone, selectView, set, set, set, set, set, set, set, set, set, set, setApplyOp, setApplyOp, setApplyOp, setElements, setElements, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, setSparse, setSparse, setSparse, 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, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray
add, addApplyOp, addCopy, addInnerProduct, addInnerProduct, addOuterProduct, addOuterProductSparse, addSparse, broadcastCloneLike, broadcastCopyLike, componentCount, density, ensureMutable, epsilonEquals, exp, get, get, getComponent, getComponents, getElements, getElements, getSlices, getSliceViews, isBoolean, isDense, isSparse, scale, set, set, signumCopy, sqrt, sub, sub, withComponents

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.INDArray
addApplyOp, addInnerProduct, addOuterProduct, addOuterProductSparse, addSparse, broadcastCloneLike, broadcastCopyLike, componentCount, ensureMutable, epsilonEquals, exp, get, get, getComponent, getComponents, getElements, getElements, getSlices, getSliceViews, isBoolean, isDense, isSparse, scale, set, set, signumCopy, sqrt, sub, withComponents

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - x
```
public double x
```
  - y
```
public double y
```
- Constructor Detail
  - Vector2
```
public Vector2()
```
  - Vector2
```
public Vector2(double x,
               double y)
```
- Method Detail
  - of
```
public static Vector2 of(double x,
                         double y)
```
  - of
```
public static Vector2 of(double... values)
```
  - create
```
public static Vector2 create(AVector v)
```
  - 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(Vector2 v)
```
  - sub
```
public void sub(Vector2 v)
```
  - addMultiple
```
public void addMultiple(Vector2 v,
                        double factor)
```
  - addProduct
```
public void addProduct(Vector2 a,
                       Vector2 b)
```
  - addProduct
```
public void addProduct(Vector2 a,
                       Vector2 b,
                       double factor)
```
  - dotProduct
```
public double dotProduct(AVector a)
```
    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:
  - dotProduct
```
public double dotProduct(double[] data,
                         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(Vector2 a)
```
  - scaleAdd
```
public void scaleAdd(double factor,
                     double constant)
```
    Description copied from class: AVector
    
    Scales this vector and adds a constant to every element
    
    Specified by:
    
    scaleAdd in interface INDArray
    
    Overrides:
    
    scaleAdd in class AVector
  - scaleAdd
```
public void scaleAdd(double factor,
                     AVector constant)
```
    Description copied from class: AVector
    
    Scales this vector then adds another vector
    
    Overrides:
    
    scaleAdd in class AVector
  - scaleAdd
```
public void scaleAdd(double factor,
                     Vector2 constant)
```
  - complexMultiply
```
public void complexMultiply(Vector2 a)
```
    Complex multiplication by another Vector2, treating an (x,y) vector as the complex value x+iy
    
    Parameters:
    
    a -
  - complexConjugate
```
public Vector2 complexConjugate()
```
  - complexReciprocal
```
public Vector2 complexReciprocal()
```
  - complexNegation
```
public Vector2 complexNegation()
```
  - 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
  - add
```
public void add(double constant)
```
    Description copied from interface: INDArray
    
    Adds a double value to all elements in this array. Implementations may optimize the case of 0.0
    
    Specified by:
    
    add in interface INDArray
    
    Overrides:
    
    add in class AVector
  - add
```
public void add(double dx,
                double dy)
```
  - add
```
public void add(AVector v)
```
    Description copied from class: AVector
    
    Adds another vector to this one
    
    Overrides:
    
    add in class AVector
  - 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
  - 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:
  - elementMax
```
public double elementMax()
```
    Description copied from interface: INDArray
    
    Returns the maximum element value in this array. Throws an error if there are no elements.
    
    Specified by:
    
    elementMax in interface INDArray
    
    Overrides:
    
    elementMax in class AVector
  - elementMin
```
public double elementMin()
```
    Description copied from interface: INDArray
    
    Returns the maximum element value in this array. Throws an error if there are no elements.
    
    Specified by:
    
    elementMin in interface INDArray
    
    Overrides:
    
    elementMin 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
  - magnitude
```
public double magnitude()
```
    Description copied from class: AVector
    
    Returns the magnitude (Euclidean length) of the vector
    
    Overrides:
    
    magnitude 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
  - unsafeGet
```
public double unsafeGet(int i)
```
    Description copied from class: AVector
    
    Like get, but performs no bounds checking. Results are undefined if the index is out of range
    
    Overrides:
    
    unsafeGet in class AVector
  - getElements
```
public void getElements(double[] data,
                        int offset)
```
    Description copied from interface: INDArray
    
    Copies all elements of this array a double array at the specified offset
    
    Specified by:
    
    getElements in interface INDArray
    
    Overrides:
    
    getElements in class AVector
  - toDoubleBuffer
```
public void toDoubleBuffer(java.nio.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
  - toNormal
```
public Vector2 toNormal()
```
    Description copied from class: AVector
    
    Creates a new mutable vector representing the normalised value of this vector Returns null if the vector cannot be normalised (i.e. is a zero length vector)
    
    Overrides:
    
    toNormal in class APrimitiveVector
    
    Returns:
  - 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
  - unsafeSet
```
public void unsafeSet(int i,
                      double value)
```
    Description copied from class: AVector
    
    Like set, but performs no bounds checking. Results are undefined if the index is out of range
    
    Overrides:
    
    unsafeSet in class AVector
  - fill
```
public void fill(double v)
```
    Description copied from class: AVector
    
    Fills the entire vector with a given value
    
    Specified by:
    
    fill in interface INDArray
    
    Overrides:
    
    fill 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
  - rotate2D
```
public void rotate2D(double angle)
```
    Rotates a 2D vector around the origin by a given angle in radians
    
    Parameters:
    
    angle -
  - rotate2DCopy
```
public Vector2 rotate2DCopy(double angle)
```
    Rotates a 2D vector around the origin by a given angle in radians, returning a new Vector2
    
    Parameters:
    
    angle -
  - setValues
```
public void setValues(double x,
                      double y)
```
  - clone
```
public Vector2 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
  - exactClone
```
public Vector2 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
  - equals
```
public boolean equals(AVector v)
```
    Description copied from class: AbstractArray
    
    Returns true if this array is exactly equal to a vector.
    
    Overrides:
    
    equals in class AVector
    
    Returns:
  - equals
```
public boolean equals(Vector2 v)
```
  - 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:

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class Vector2

Field Summary

Constructor Summary

Method Summary

Methods inherited from class mikera.vectorz.impl.APrimitiveVector

Methods inherited from class mikera.vectorz.AVector

Methods inherited from class mikera.arrayz.impl.AbstractArray

Methods inherited from class java.lang.Object

Methods inherited from interface mikera.arrayz.INDArray

Methods inherited from interface java.lang.Iterable

Field Detail

x

y

Constructor Detail

Vector2

Vector2

Method Detail

of

of

create

applyOp

reduce

reduce

isZero

add

sub

addMultiple

addProduct

addProduct

dotProduct

dotProduct

dotProduct

scaleAdd

scaleAdd

scaleAdd

complexMultiply

complexConjugate

complexReciprocal

complexNegation

negate

multiply

add

add

add

length

elementSum

elementProduct

elementMax

elementMin

elementSquaredSum

magnitude

get

unsafeGet

getElements

toDoubleBuffer

toDoubleArray

toNormal

set

unsafeSet

fill

addAt

rotate2D

rotate2DCopy

setValues

clone

getX

getY

exactClone

equals

equals

equalsArray