math.linear.doubles

Class Vector

java.lang.Object

math.linear.doubles.Vector

public final class Vector
extends Object

An immutable and thread-safe implementation of a real-valued vector backed by an array of primitive doubles.

Constructor Summary

Constructors

Constructor and Description
Vector(double... elements) Create a new vector using the provided elements.

Method Summary

Modifier and Type	Method and Description
double	at(int i) Return the element at index i, where indexing begins at 0.
double	dotProduct(Vector other) Compute the dot product of this vector with the given vector.
double[]	elements() The elements of the vector as an array of primitive doubles.
boolean	equals(Object obj)
static Vector	from(double... elements) Create a new vector from the given elements.
int	hashCode()
Vector	minus(double scalar) Subtract the given scalar from this vector and return the result in a new vector.
Vector	minus(Vector other) Subtract the given vector from this vector and return the result in a new vector.
double	norm() Compute the L2 length of this vector.
Matrix	outerProduct(Vector other) Compute the outer product of this vector and the given vector.
Vector	plus(Vector other) Add this vector to the given vector and return the result in a new vector.
Vector	scaledBy(double alpha) Scale this vector by the given scalar and return the result in a new vector.
int	size() The number of elements in this vector.
double	sum() Compute the sum of the elements of this vector.
double	sumOfSquares() Compute the sum of squared elements of this vector.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Vector

public Vector(double... elements)

Create a new vector using the provided elements.

Parameters:

elements - the elements of the new vector.

Method Detail

from

public static Vector from(double... elements)

Create a new vector from the given elements.

Parameters:

elements - the elements of the new vector.

Returns:

a new vector with the given elements.

elements

public double[] elements()

The elements of the vector as an array of primitive doubles.

Returns:

the elements of the vector as an array of primitive doubles.

at

public double at(int i)

Return the element at index i, where indexing begins at 0.

Parameters:

i - the index of the element.

Returns:

the element at index i, where indexing begins at 0.

size

public int size()

The number of elements in this vector.

Returns:

the number of elements in this vector.

plus

public Vector plus(Vector other)

Add this vector to the given vector and return the result in a new vector.

Parameters:

other - the vector to add to this vector.

Returns:

this vector added to the given vector.

minus

public Vector minus(Vector other)

Subtract the given vector from this vector and return the result in a new vector.

Parameters:

other - the vector to subtract from this vector.

Returns:

this vector subtracted by the given vector.

minus

public Vector minus(double scalar)

Subtract the given scalar from this vector and return the result in a new vector.

Parameters:

scalar - the scalar to subtract from this vector.

Returns:

this vector subtracted by the given scalar.

scaledBy

public Vector scaledBy(double alpha)

Scale this vector by the given scalar and return the result in a new vector.

Parameters:

alpha - the scalar to scale this vector by.

Returns:

this vector scaled by the given scalar.

dotProduct

public double dotProduct(Vector other)

Compute the dot product of this vector with the given vector.

Parameters:

other - the vector to take the dot product with.

Returns:

the dot product of this vector with the given vector.

outerProduct

public Matrix outerProduct(Vector other)

Compute the outer product of this vector and the given vector.

Parameters:

other - the vector to compute the outer product of this vector with.

Returns:

the outer product of this vector with the given vector.

norm

public double norm()

Compute the L2 length of this vector.

Returns:

the L2 length of this vector.

sum

public double sum()

Compute the sum of the elements of this vector.

Returns:

the sum of the elements of this vector.

sumOfSquares

public double sumOfSquares()

Compute the sum of squared elements of this vector.

Returns:

the sum of squared elements of this vector.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object