Vector3 (vectorz 0.23.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

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
`void`	`addMultiple(AVector v, double factor)` Adds a scaled multiple of another vector to this one
`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.
`static Vector3`	`create(AVector v)`
`static Vector3`	`create(Object o)`
`void`	`crossProduct(AVector a)`
`void`	`crossProduct(Vector3 a)`
`double`	`distance(AVector v)`
`double`	`distance(Vector3 v)`
`double`	`distanceSquared(Vector3 v)`
`double`	`dotProduct(AVector a)`
`double`	`dotProduct(double[] data, int offset)` Fast dot product with a double[] array.
`double`	`dotProduct(Vector v)`
`double`	`dotProduct(Vector3 a)`
`double`	`elementSum()` Returns the sum of all elements in a vector
`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
`double`	`getX()`
`double`	`getY()`
`double`	`getZ()`
`int`	`length()`
`double`	`magnitude()` Returns the magnitude (Euclidean length) of the vector
`double`	`magnitudeSquared()`
`void`	`negate()` Negates all elements in the 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)`
`void`	`projectToPlane(Vector3 normal, double distance)`
`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)`
`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)`
`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

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

Methods inherited from class mikera.vectorz.AVector
abs, add, add, add, add, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleToArray, addProduct, addProduct, addProduct, addProductToArray, addProductToArray, addToArray, addToArray, addWeighted, applyOp, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, clamp, clampMax, clampMin, compareTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, dimensionality, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divide, divideTo, dotProduct, elementCount, elementIterator, elementSquaredSum, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, equalsArray, fillRange, get, get, get, getLongShape, getShape, getShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, hashCode, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isElementConstrained, isSameShape, isSameShape, isUnitLengthVector, isZero, iterator, join, log, logistic, maxAbsElement, multiply, multiply, multiply, multiply, multiplyTo, mutable, nonZeroCount, normaliseMaxAbsElement, outerProduct, outerProduct, pow, 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
```
  - 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
  - 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)
    
    Overrides:
    
    normalise in class AVector
    
    Returns:
  - 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)
```
  - 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)
```
  - magnitudeSquared
```
public double magnitudeSquared()
```
    Overrides:
    
    magnitudeSquared in class AVector
  - distanceSquared
```
public double distanceSquared(Vector3 v)
```
  - distance
```
public double distance(Vector3 v)
```
  - distance
```
public double distance(AVector v)
```
    Overrides:
    
    distance 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:
  - set
```
public void set(Vector3 a)
```
  - 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 one
    
    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
  - 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 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:
  - crossProduct
```
public void crossProduct(AVector a)
```
    Overrides:
    
    crossProduct in class AVector
  - crossProduct
```
public void crossProduct(Vector3 a)
```
  - projectToPlane
```
public void projectToPlane(AVector normal,
                  double distance)
```
    Overrides:
    
    projectToPlane in class AVector
  - projectToPlane
```
public void projectToPlane(Vector3 normal,
                  double distance)
```
  - 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:
  - 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
    
    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
    
    Returns:
  - 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)
```
    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
    
    Overrides:
    
    addAt in class AVector
  - setValues
```
public void setValues(double x,
             double y,
             double z)
```
  - 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
  - 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
    
    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
  - toNormal
```
public Vector3 toNormal()
```
    Description copied from class: AVector
    
    Creates a new mutable vector representing the normalised value of this 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 class APrimitiveVector
    
    Returns:
  - 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:

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

Field Detail

x

y

z

Constructor Detail

Vector3

Vector3

Vector3

Vector3

Vector3

Method Detail

applyOp

normalise

of

of

create

create

angle

angle

add

magnitudeSquared

distanceSquared

distance

distance

magnitude

set

addMultiple

addMultiple

addMultiple

addProduct

addProduct

subtractMultiple

add

add

sub

subMultiple

dotProduct

dotProduct

dotProduct

dotProduct

crossProduct

crossProduct

projectToPlane

projectToPlane

length

elementSum

scaleAdd

scaleAdd

scaleAdd

add

get

set

fill

set

addAt

setValues

negate

getElements

toDoubleBuffer

toNormal

clone

getX

getY

getZ

exactClone