Vector2 (vectorz 0.22.0 API)

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

All Implemented Interfaces:

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

Author:

Mike

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

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
`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 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()`
`void`	`copyTo(double[] data, int offset)` Copies a the contents of a vector to a double array at the specified offset
`static Vector2`	`create(AVector v)`
`double`	`dotProduct(AVector a)`
`double`	`dotProduct(double[] data, int offset)` Fast dot product with a double[] array.
`double`	`dotProduct(Vector v)`
`double`	`dotProduct(Vector2 a)`
`double`	`elementSum()` Returns the sum of all elements in a vector
`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
`double`	`getX()`
`double`	`getY()`
`int`	`length()`
`double`	`magnitude()` Returns the magnitude (Euclidean length) of the vector
`double`	`magnitudeSquared()`
`void`	`negate()` Negates all elements in the array
`static Vector2`	`of(double... values)`
`static Vector2`	`of(double x, double y)`
`void`	`rotateInPlace(int angle)` Rorates a 2D vector around the origin by a given angle
`void`	`scaleAdd(double factor, AVector constant)`
`void`	`scaleAdd(double factor, double constant)` Scales all elements of the array by a given double value and adds a constant vale
`void`	`scaleAdd(double factor, Vector2 constant)`
`void`	`set(int i, double value)`
`void`	`setValues(double x, double y)`
`void`	`sub(Vector2 v)`
`void`	`toDoubleBuffer(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

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

Methods inherited from class mikera.vectorz.AVector
abs, add, add, add, add, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleToArray, addProduct, addProduct, addProduct, addProductToArray, addProductToArray, addToArray, addToArray, addWeighted, angle, applyOp, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, clamp, clampMax, clampMin, compareTo, copyTo, copyTo, copyTo, copyTo, copyTo, crossProduct, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divide, divideTo, dotProduct, elementCount, elementIterator, elementSquaredSum, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, fillRange, get, get, getElements, getLongShape, getShape, getShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, hashCode, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isElementConstrained, isSameShape, isSameShape, isUnitLengthVector, isZero, iterator, join, log, logistic, maxAbsElement, multiply, multiply, multiply, multiply, multiplyTo, nonZeroCount, normalise, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reshape, scale, scaleToMagnitude, set, set, set, set, set, set, set, set, setElements, setElements, setRange, setValues, signum, slice, slice, sliceCount, square, sub, sub, sub, subMultiple, subVector, tanh, toDoubleArray, toList, toString, toVector, unsafeGet, unsafeSet, validate, zeroCount

Methods inherited from class mikera.arrayz.impl.AbstractArray
broadcastCloneLike, ensureMutable, exp, get, getSliceViews, isBoolean, reciprocal, scale, set, set, sqrt, toArray

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

Methods inherited from interface mikera.arrayz.INDArray
broadcastCloneLike, ensureMutable, exp, get, getSliceViews, isBoolean, reciprocal, scale, set, set, sqrt, toArray

- 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
  - 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)
```
    Overrides:
    
    dotProduct in class AVector
  - dotProduct
```
public double dotProduct(Vector v)
```
    Overrides:
    
    dotProduct in class AVector
  - dotProduct
```
public double dotProduct(double[] data,
                int offset)
```
    Description copied from class: AVector
    
    Fast dot product with a double[] array.
    
    Overrides:
    
    dotProduct in class AVector
    
    Returns:
  - dotProduct
```
public double dotProduct(Vector2 a)
```
  - 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 AVector
  - scaleAdd
```
public void scaleAdd(double factor,
            AVector constant)
```
    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 interface: INDArray
    
    Negates all elements in the array
    
    Specified by:
    
    negate in interface INDArray
    
    Overrides:
    
    negate in class AVector
  - add
```
public void add(double constant)
```
    Description copied from interface: INDArray
    
    Adds a double value to all elements in this array
    
    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()
```
    Specified by:
    
    length in interface IVector
    
    Specified by:
    
    length in class AVector
  - 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
    
    Returns:
  - 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:
  - 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:
  - 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
  - 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
  - toNormal
```
public Vector2 toNormal()
```
    Description copied from class: AVector
    
    Creates a new mutable vector representing the normalised value of this vector
    
    Overrides:
    
    toNormal in class APrimitiveVector
    
    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
  - 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
    
    Overrides:
    
    addAt in class AVector
  - rotateInPlace
```
public void rotateInPlace(int angle)
```
    Rorates a 2D vector around the origin by a given angle
    
    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 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 class APrimitiveVector
    
    Returns:
  - 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:

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

Field Detail

x

y

Constructor Detail

Vector2

Vector2

Method Detail

of

of

create

applyOp

add

sub

addMultiple

addProduct

addProduct

dotProduct

dotProduct

dotProduct

dotProduct

scaleAdd

scaleAdd

scaleAdd

complexMultiply

complexConjugate

complexReciprocal

complexNegation

negate

add

add

add

length

elementSum

magnitudeSquared

magnitude

get

copyTo

toDoubleBuffer

toNormal

set

fill

addAt

rotateInPlace

setValues

clone

getX

getY

exactClone