org.wallerlab.yoink.math.linear

Class CommonsVector3D

java.lang.Object

org.wallerlab.yoink.math.linear.CommonsVector3D

All Implemented Interfaces:

Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

public class CommonsVector3D
extends java.lang.Object
implements Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Vector Adaptor pattern. thsi class is to convert from our own implementation to the appache commons maths lib.

Nested Class Summary

Nested classes/interfaces inherited from interface org.wallerlab.yoink.api.service.math.Vector

Vector.Vector3DType

Constructor Summary

Constructors

Constructor and Description
CommonsVector3D()
CommonsVector3D(double[] d)
CommonsVector3D(double x, double y, double z)

Method Summary

Modifier and Type	Method and Description
Vector	add(Vector m) get the sum of this vector with another vector
double	distance(Vector m) get the distance between this vector and another vector
double	dotProduct() get the dot product of this vector with itself
Vector	ebeMultiply(Vector m) multiply this vector with another vector element by element
boolean	equals(Vector m) check if this vector equals another vector m.
Vector	exp() do Math.exp() calculation for every element in the vector
double	getEntry(int i) get one element in this vector
org.apache.commons.math3.geometry.euclidean.threed.Vector3D	getInternalVector() get the value of internal vector of this vector in the vector type in the library
double	getNorm() get the norm of this vector
double	getX() get the value of x coordinate of this vector
double	getY() get the value of y coordinate of this vector
double	getZ() get the value of z coordinate of this vector
Vector	scalarMultiply(double d) multiply this vector with a scalar value
void	setInternalVector(org.apache.commons.math3.geometry.euclidean.threed.Vector3D internalVector) set the value of internal vector
Vector	subtract(Vector m) get the result of this vector subtracts another vector
double[]	toArray() get the value of this vector in the form of a double array

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommonsVector3D

public CommonsVector3D(double x,
                       double y,
                       double z)

CommonsVector3D

public CommonsVector3D()

CommonsVector3D

public CommonsVector3D(double[] d)

Method Detail

dotProduct

public double dotProduct()

Description copied from interface: Vector

get the dot product of this vector with itself

Specified by:

dotProduct in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Returns:

Double

getNorm

public double getNorm()

Description copied from interface: Vector

get the norm of this vector

Specified by:

getNorm in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Returns:

Double

add

public Vector add(Vector m)

Description copied from interface: Vector

get the sum of this vector with another vector

Specified by:

add in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Parameters:

m - -Vector

Returns:

the sum of two vectors, - Vector

subtract

public Vector subtract(Vector m)

Description copied from interface: Vector

get the result of this vector subtracts another vector

Specified by:

subtract in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Parameters:

m - -Vector

Returns:

the subtraction of two vectors, - Vector

scalarMultiply

public Vector scalarMultiply(double d)

Description copied from interface: Vector

multiply this vector with a scalar value

Specified by:

scalarMultiply in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Parameters:

d - -the scalar value, -Double

Returns:

a vector, -Vector

getX

public double getX()

Description copied from interface: Vector

get the value of x coordinate of this vector

Specified by:

getX in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Returns:

Double

getY

public double getY()

Description copied from interface: Vector

get the value of y coordinate of this vector

Specified by:

getY in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Returns:

Double

getZ

public double getZ()

Description copied from interface: Vector

get the value of z coordinate of this vector

Specified by:

getZ in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Returns:

Double

distance

public double distance(Vector m)

Description copied from interface: Vector

get the distance between this vector and another vector

Specified by:

distance in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Parameters:

m - - Vector

Returns:

distance -Double

ebeMultiply

public Vector ebeMultiply(Vector m)

Description copied from interface: Vector

multiply this vector with another vector element by element

Specified by:

ebeMultiply in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Parameters:

m - -Vector

Returns:

a vector, -Vector

getEntry

public double getEntry(int i)

Description copied from interface: Vector

get one element in this vector

Specified by:

getEntry in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Parameters:

i - , the index of element

Returns:

the element value, Double

getInternalVector

public org.apache.commons.math3.geometry.euclidean.threed.Vector3D getInternalVector()

Description copied from interface: Vector

get the value of internal vector of this vector in the vector type in the library

Specified by:

getInternalVector in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Returns:

a vector in the vector type in the library

setInternalVector

public void setInternalVector(org.apache.commons.math3.geometry.euclidean.threed.Vector3D internalVector)

Description copied from interface: Vector

set the value of internal vector

Specified by:

setInternalVector in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Parameters:

internalVector - , a vector in the vector type in the library

equals

public boolean equals(Vector m)

Description copied from interface: Vector

check if this vector equals another vector m.

Specified by:

equals in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Parameters:

m - - Vector

Returns:

Boolean

toArray

public double[] toArray()

Description copied from interface: Vector

get the value of this vector in the form of a double array

Specified by:

toArray in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Returns:

a double array

exp

public Vector exp()

Description copied from interface: Vector

do Math.exp() calculation for every element in the vector

Specified by:

exp in interface Vector<org.apache.commons.math3.geometry.euclidean.threed.Vector3D>

Returns:

a vector, -Vector