Vector3 (Vectorz 0.62.0 API)

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AVector>, Iterable<Double>, INDArray, IVector
```
public final class Vector3
extends APrimitiveVector
```
Specialised 3D vector Represents a point in 3D x,y,z space.

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

double x

double y

double z

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

Constructor Summary

Constructors
Constructor and Description
`Vector3()`
`Vector3(AVector v)`
`Vector3(double... values)`
`Vector3(double x, double y, double z)`
`Vector3(Vector3 source)`

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, double dz)`
`void`	`add(Vector3 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.
`Vector3`	`addCopy(AVector v)` Adds a vector element-wise to this vector, returning a new vector.
`Vector3`	`addCopy(Vector3 v)`
`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 factor)`
`void`	`addMultiple(Vector3 v, double factor)`
`void`	`addProduct(Vector3 a, Vector3 b)`
`void`	`addProduct(Vector3 a, Vector3 b, double factor)`
`double`	`angle(AVector v)` Returns the Euclidean angle between this vector and another vector
`double`	`angle(Vector3 v)`
`void`	`applyOp(Op op)` Applies a unary operator to all elements of the array (in-place)
`Vector3`	`clone()` Clones the vector, creating a new mutable copy of all data.
`Vector3`	`copy()` Returns a defensive copy of the array data.
`static Vector3`	`create(AVector v)`
`static Vector3`	`create(Object o)`
`void`	`crossProduct(AVector a)` Computes the crossProduct of this vector with another vector, and stores the result in this vector.
`void`	`crossProduct(Vector3 a)` Computes the crossProduct of this vector with another vector, and stores the result in this vector.
`double`	`distance(AVector v)` Returns the Euclidean distance to another vector.
`double`	`distance(Vector3 v)`
`double`	`distanceSquared(Vector3 v)`
`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[] data, int offset)` Fast dot product with a double[] array.
`double`	`dotProduct(Vector3 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`	`equals(AVector v)`
`boolean`	`equals(Vector3 v)`
`boolean`	`equalsArray(double[] data, int offset)` Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset
`Vector3`	`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)` Gets all elements of the array, copying them into a double array at the specified offset
`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.
`double`	`magnitude()` Returns the magnitude (Euclidean length) of the vector
`void`	`multiply(double d)` Multiplies the vector by a constant factor
`Vector3`	`multiplyCopy(double d)` Returns a copy of the array with all elements multiplied by a single constant value
`void`	`negate()` Negates all emlements of this vector in place.
`Vector3`	`negateCopy()` Negates all elements in the array, returning a new array
`double`	`normalise()` Normalises this vector to a magnitude of 1.0 Has no effect on a zero-length vector (i.e.
`static Vector3`	`of(double... values)`
`static Vector3`	`of(double x, double y, double z)`
`void`	`projectToPlane(AVector normal, double distance)` Projects the vector to the plane defined by: x.normal=distance
`void`	`projectToPlane(Vector3 normal, double distance)`
`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`	`scaleAdd(double factor, AVector constant)`
`void`	`scaleAdd(double factor, double constant)` Scales this vector and adds a constant to every element
`void`	`scaleAdd(double factor, Vector3 constant)`
`void`	`set(AVector v)` Sets the vector to equal the value of another vector
`void`	`set(int i, double value)` Sets a value at a given position in a mutable 1D array
`void`	`set(Vector3 a)`
`void`	`setValues(double x, double y, double z)`
`void`	`sub(Vector3 v)`
`void`	`subMultiple(Vector3 v, double factor)`
`void`	`subtractMultiple(Vector3 v, double factor)`
`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
`Vector3`	`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)`
`void`	`unsafeSet(int i, double value)`

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

Methods inherited from class mikera.vectorz.AVector
abs, absCopy, add, add, add, add, add, add, add, addAt, 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, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, broadcastLike, checkDimension, checkIndex, checkLength, checkRange, checkSameLength, checkSameLength, checkSameLength, clamp, clampMax, clampMin, compareTo, copyTo, copyTo, copyTo, copyTo, copyTo, dense, denseClone, dimensionality, 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, equalsArray, 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, magnitudeSquared, maxAbsElement, maxAbsElementIndex, maxElement, maxElementIndex, minElement, minElementIndex, multiply, multiply, multiply, multiply, multiplyCopy, multiplyCopy, multiplyTo, mutable, nonSparseIndex, nonZeroCount, nonZeroIndices, nonZeroValues, normaliseCopy, normaliseMaxAbsElement, outerProduct, outerProduct, pow, 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, 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, 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
```
- Constructor Detail
  - Vector3
```
public Vector3()
```
  - Vector3
```
public Vector3(Vector3 source)
```
  - Vector3
```
public Vector3(double x,
               double y,
               double z)
```
  - Vector3
```
public Vector3(double... values)
```
  - Vector3
```
public Vector3(AVector v)
```
- Method Detail
  - 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
  - normalise
```
public double normalise()
```
    Description copied from class: AVector
    
    Normalises this vector to a magnitude of 1.0 Has no effect on a zero-length vector (i.e. it will remain zero)
    
    Specified by:
    
    normalise in interface IVector
    
    Overrides:
    
    normalise in class AVector
    
    Returns:
    
    the magnitude of the original vector
  - of
```
public static Vector3 of(double x,
                         double y,
                         double z)
```
  - of
```
public static Vector3 of(double... values)
```
  - create
```
public static Vector3 create(Object o)
```
  - create
```
public static Vector3 create(AVector v)
```
  - 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
  - angle
```
public double angle(AVector v)
```
    Description copied from class: AVector
    
    Returns the Euclidean angle between this vector and another vector
    
    Overrides:
    
    angle in class AVector
    
    Returns:
    
    angle in radians
  - angle
```
public double angle(Vector3 v)
```
  - add
```
public void add(double dx,
                double dy,
                double dz)
```
  - 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
  - distanceSquared
```
public double distanceSquared(Vector3 v)
```
  - distance
```
public double distance(Vector3 v)
```
  - distance
```
public double distance(AVector v)
```
    Description copied from class: AVector
    
    Returns the Euclidean distance to another vector.
    
    Overrides:
    
    distance in class AVector
    
    Returns:
  - magnitude
```
public double magnitude()
```
    Description copied from class: AVector
    
    Returns the magnitude (Euclidean length) of the vector
    
    Overrides:
    
    magnitude in class AVector
    
    Returns:
  - set
```
public void set(Vector3 a)
```
  - multiply
```
public void multiply(double d)
```
    Description copied from class: AVector
    
    Multiplies the vector by a constant factor
    
    Specified by:
    
    multiply in interface INDArray
    
    Overrides:
    
    multiply in class AVector
    
    Parameters:
    
    d - Factor by which to multiply each component of the vector
  - multiplyCopy
```
public Vector3 multiplyCopy(double d)
```
    Description copied from interface: INDArray
    
    Returns a copy of the array with all elements multiplied by a single constant value
    
    Specified by:
    
    multiplyCopy in interface INDArray
    
    Overrides:
    
    multiplyCopy in class AVector
    
    Parameters:
    
    d - A scalar factor
    
    Returns:
    
    A new array, with all element values scaled by the given factor
  - addMultiple
```
public void addMultiple(double dx,
                        double dy,
                        double dz,
                        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(Vector3 v,
                        double factor)
```
  - addProduct
```
public void addProduct(Vector3 a,
                       Vector3 b)
```
  - addProduct
```
public void addProduct(Vector3 a,
                       Vector3 b,
                       double factor)
```
  - subtractMultiple
```
public void subtractMultiple(Vector3 v,
                             double factor)
```
  - add
```
public void add(AVector v)
```
    Description copied from class: AVector
    
    Adds another vector to this one
    
    Overrides:
    
    add in class AVector
  - addCopy
```
public Vector3 addCopy(AVector v)
```
    Description copied from interface: IVector
    
    Adds a vector element-wise to this vector, returning a new vector.
    
    Specified by:
    
    addCopy in interface IVector
    
    Overrides:
    
    addCopy in class AVector
    
    Returns:
  - addCopy
```
public Vector3 addCopy(Vector3 v)
```
  - add
```
public void add(Vector3 v)
```
  - sub
```
public void sub(Vector3 v)
```
  - subMultiple
```
public void subMultiple(Vector3 v,
                        double factor)
```
  - dotProduct
```
public double dotProduct(Vector3 a)
```
  - 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:
  - 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
  - crossProduct
```
public void crossProduct(AVector a)
```
    Description copied from class: AVector
    
    Computes the crossProduct of this vector with another vector, and stores the result in this vector. Both vectors must have length 3.
    
    Overrides:
    
    crossProduct in class AVector
  - crossProduct
```
public void crossProduct(Vector3 a)
```
    Description copied from class: AVector
    
    Computes the crossProduct of this vector with another vector, and stores the result in this vector. Both vectors must have length 3.
    
    Overrides:
    
    crossProduct in class AVector
  - projectToPlane
```
public void projectToPlane(AVector normal,
                           double distance)
```
    Description copied from class: AVector
    
    Projects the vector to the plane defined by: x.normal=distance
    
    Overrides:
    
    projectToPlane in class AVector
    
    Parameters:
    
    normal - A Vector of unit length
  - projectToPlane
```
public void projectToPlane(Vector3 normal,
                           double distance)
```
  - 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:
  - 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)
```
    Overrides:
    
    scaleAdd in class AVector
  - scaleAdd
```
public void scaleAdd(double factor,
                     Vector3 constant)
```
  - 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
  - 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)
```
    Overrides:
    
    unsafeGet in class AVector
  - set
```
public void set(AVector v)
```
    Description copied from class: AVector
    
    Sets the vector to equal the value of another vector
    
    Overrides:
    
    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
  - 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)
```
    Overrides:
    
    unsafeSet 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)
```
  - 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
  - negateCopy
```
public Vector3 negateCopy()
```
    Description copied from interface: INDArray
    
    Negates all elements in the array, returning a new array
    
    Specified by:
    
    negateCopy in interface INDArray
    
    Overrides:
    
    negateCopy in class AVector
  - 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
  - toNormal
```
public Vector3 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:
  - clone
```
public Vector3 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
  - copy
```
public Vector3 copy()
```
    Description copied from interface: INDArray
    
    Returns a defensive copy of the array data. Use this if the original array might change and you need a defensive copy. May return the same array if the original was immutable, otherwise will return a defensive copy.
    
    Specified by:
    
    copy in interface INDArray
    
    Overrides:
    
    copy in class AVector
  - 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
  - exactClone
```
public Vector3 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)
```
    Overrides:
    
    equals in class AVector
  - equals
```
public boolean equals(Vector3 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:

Class Vector3

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

z

Constructor Detail

Vector3

Vector3

Vector3

Vector3

Vector3

Method Detail

applyOp

reduce

reduce

normalise

of

of

create

create

isZero

angle

angle

add

elementSquaredSum

distanceSquared

distance

distance

magnitude

set

multiply

multiplyCopy

addMultiple

addMultiple

addMultiple

addProduct

addProduct

subtractMultiple

add

addCopy

addCopy

add

sub

subMultiple

dotProduct

dotProduct

dotProduct

crossProduct

crossProduct

projectToPlane

projectToPlane

length

elementSum

elementProduct

scaleAdd

scaleAdd

scaleAdd

add

get

unsafeGet

set

fill

set

unsafeSet

addAt

setValues

negate

negateCopy

getElements

toDoubleBuffer

toDoubleArray