Package org.flag4j.core

Interface VectorOperationsMixin<T,U,V,W,X extends Number,TT,UU,WW>

Type Parameters:

T - Vector type.

U - Dense Vector type.

V - Sparse Vector type.

W - Complex Vector type.

X - Vector entry type.

TT - Matrix type equivalent.

UU - Dense Matrix type equivalent.

WW - Complex Matrix type equivalent.

All Known Subinterfaces:

VectorMixin<T,U,V,W,X,TT,UU,WW>

All Known Implementing Classes:

CooCVector, CooVector, CVector, Vector

public interface VectorOperationsMixin<T,U,V,W,X extends Number,TT,UU,WW>

This interface specifies operations which should be implemented by any vector.

Method Summary

Modifier and Type	Method	Description
CVector	add(CVector B)	Computes the element-wise addition between this vector and the specified vector.
U	add(Vector B)	Computes the element-wise addition between this vector and the specified vector.
W	add(CooCVector B)	Computes the element-wise addition between this vector and the specified vector.
T	add(CooVector B)	Computes the element-wise addition between this vector and the specified vector.
W	elemDiv(CVector B)	Computes the element-wise division (Hadamard multiplication) between this vector and a specified vector.
T	elemDiv(Vector B)	Computes the element-wise division (Hadamard multiplication) between this vector and a specified vector.
W	elemMult(CVector B)	Computes the element-wise multiplication (Hadamard multiplication) between this vector and a specified vector.
T	elemMult(Vector B)	Computes the element-wise multiplication (Hadamard multiplication) between this vector and a specified vector.
CooCVector	elemMult(CooCVector B)	Computes the element-wise multiplication (Hadamard multiplication) between this vector and a specified vector.
V	elemMult(CooVector B)	Computes the element-wise multiplication (Hadamard multiplication) between this vector and a specified vector.
CNumber	inner(CVector b)	Computes the inner product between two vectors.
X	inner(Vector b)	Computes the inner product between two vectors.
CNumber	inner(CooCVector b)	Computes the inner product between two vectors.
X	inner(CooVector b)	Computes the inner product between two vectors.
boolean	isParallel(Vector b)	Checks if a vector is parallel to this vector.
boolean	isPerp(Vector b)	Checks if a vector is perpendicular to this vector.
CVector	join(CVector b)	Joints specified vector with this vector.
U	join(Vector b)	Joints specified vector with this vector.
W	join(CooCVector b)	Joints specified vector with this vector.
T	join(CooVector b)	Joints specified vector with this vector.
T	normalize()	Computes a unit vector in the same direction as this vector.
CMatrix	outer(CVector b)	Computes the outer product of two vectors.
UU	outer(Vector b)	Computes the outer product of two vectors.
CMatrix	outer(CooCVector b)	Computes the outer product of two vectors.
UU	outer(CooVector b)	Computes the outer product of two vectors.
WW	stack(CVector b)	Stacks two vectors along columns as if they were row vectors.
WW	stack(CVector b, int axis)	Stacks two vectors along specified axis.
TT	stack(Vector b)	Stacks two vectors along columns as if they were row vectors.
TT	stack(Vector b, int axis)	Stacks two vectors along specified axis.
WW	stack(CooCVector b)	Stacks two vectors along columns as if they were row vectors.
WW	stack(CooCVector b, int axis)	Stacks two vectors along specified axis.
TT	stack(CooVector b)	Stacks two vectors along columns as if they were row vectors.
TT	stack(CooVector b, int axis)	Stacks two vectors along specified axis.
CVector	sub(CVector B)	Computes the element-wise subtraction between this vector and the specified vector.
U	sub(Vector B)	Computes the element-wise subtraction between this vector and the specified vector.
W	sub(CooCVector B)	Computes the element-wise subtraction between this vector and the specified vector.
T	sub(CooVector B)	Computes the element-wise subtraction between this vector and the specified vector.
TT	toMatrix()	Converts a vector to an equivalent matrix.
TT	toMatrix(boolean columVector)	Converts a vector to an equivalent matrix representing either a row or column vector.

Method Details

join

U join(Vector b)

Joints specified vector with this vector.

Parameters:

b - Vector to join with this vector.

Returns:

A vector resulting from joining the specified vector with this vector.

join

CVector join(CVector b)

Joints specified vector with this vector.

Parameters:

b - Vector to join with this vector.

Returns:

A vector resulting from joining the specified vector with this vector.

join

T join(CooVector b)

Joints specified vector with this vector.

Parameters:

b - Vector to join with this vector.

Returns:

A vector resulting from joining the specified vector with this vector.

join

W join(CooCVector b)

Joints specified vector with this vector.

Parameters:

b - Vector to join with this vector.

Returns:

A vector resulting from joining the specified vector with this vector.

stack

TT stack(Vector b)

Stacks two vectors along columns as if they were row vectors.

Parameters:

b - Vector to stack to the bottom of this vector.

Returns:

The result of stacking this vector and vector b.

Throws:

IllegalArgumentException -
- If the number of entries in this vector is different from the number of entries in the vector b.

stack

TT stack(CooVector b)

Stacks two vectors along columns as if they were row vectors.

Parameters:

b - Vector to stack to the bottom of this vector.

Returns:

The result of stacking this vector and vector b.

Throws:

IllegalArgumentException -
- If the number of entries in this vector is different from the number of entries in the vector b.

stack

WW stack(CVector b)

Stacks two vectors along columns as if they were row vectors.

Parameters:

b - Vector to stack to the bottom of this vector.

Returns:

The result of stacking this vector and vector b.

Throws:

IllegalArgumentException -
- If the number of entries in this vector is different from the number of entries in the vector b.

stack

WW stack(CooCVector b)

Stacks two vectors along columns as if they were row vectors.

Parameters:

b - Vector to stack to the bottom of this vector.

Returns:

The result of stacking this vector and vector b.

Throws:

IllegalArgumentException -
- If the number of entries in this vector is different from the number of entries in the vector b.

stack

TT stack(Vector b,
 int axis)

Stacks two vectors along specified axis.

Stacking two vectors of length n along axis 0 stacks the vectors as if they were row vectors resulting in a 2-by-n matrix.

Stacking two vectors of length n along axis 1 stacks the vectors as if they were column vectors resulting in a n-by-2 matrix.

Parameters:

b - Vector to stack with this vector.

axis - Axis along which to stack vectors. If axis=0, then vectors are stacked as if they are row vectors. If axis=1, then vectors are stacked as if they are column vectors.

Returns:

The result of stacking this vector and the vector b.

Throws:

IllegalArgumentException - If the number of entries in this vector is different from the number of entries in the vector b.

IllegalArgumentException - If axis is not either 0 or 1.

stack

TT stack(CooVector b,
 int axis)

Stacks two vectors along specified axis.

Stacking two vectors of length n along axis 0 stacks the vectors as if they were row vectors resulting in a 2-by-n matrix.

Stacking two vectors of length n along axis 1 stacks the vectors as if they were column vectors resulting in a n-by-2 matrix.

Parameters:

b - Vector to stack with this vector.

axis - Axis along which to stack vectors. If axis=0, then vectors are stacked as if they are row vectors. If axis=1, then vectors are stacked as if they are column vectors.

Returns:

The result of stacking this vector and the vector b.

Throws:

IllegalArgumentException - If the number of entries in this vector is different from the number of entries in the vector b.

IllegalArgumentException - If axis is not either 0 or 1.

stack

WW stack(CVector b,
 int axis)

Stacks two vectors along specified axis.

Stacking two vectors of length n along axis 0 stacks the vectors as if they were row vectors resulting in a 2-by-n matrix.

Stacking two vectors of length n along axis 1 stacks the vectors as if they were column vectors resulting in a n-by-2 matrix.

Parameters:

b - Vector to stack with this vector.

axis - Axis along which to stack vectors. If axis=0, then vectors are stacked as if they are row vectors. If axis=1, then vectors are stacked as if they are column vectors.

Returns:

The result of stacking this vector and the vector b.

Throws:

IllegalArgumentException - If the number of entries in this vector is different from the number of entries in the vector b.

IllegalArgumentException - If axis is not either 0 or 1.

stack

WW stack(CooCVector b,
 int axis)

Stacks two vectors along specified axis.

Stacking two vectors of length n along axis 0 stacks the vectors as if they were row vectors resulting in a 2-by-n matrix.

Stacking two vectors of length n along axis 1 stacks the vectors as if they were column vectors resulting in a n-by-2 matrix.

Parameters:

b - Vector to stack with this vector.

axis - Axis along which to stack vectors. If axis=0, then vectors are stacked as if they are row vectors. If axis=1, then vectors are stacked as if they are column vectors.

Returns:

The result of stacking this vector and the vector b.

Throws:

IllegalArgumentException - If the number of entries in this vector is different from the number of entries in the vector b.

IllegalArgumentException - If axis is not either 0 or 1.

add

U add(Vector B)

Computes the element-wise addition between this vector and the specified vector.

Parameters:

B - Vector to add to this vector.

Returns:

The result of the element-wise vector addition.

Throws:

IllegalArgumentException - If this vector and the specified vector have different lengths.

add

T add(CooVector B)

Computes the element-wise addition between this vector and the specified vector.

Parameters:

B - Vector to add to this vector.

Returns:

The result of the element-wise vector addition.

Throws:

IllegalArgumentException - If this vector and the specified vector have different lengths.

add

CVector add(CVector B)

Computes the element-wise addition between this vector and the specified vector.

Parameters:

B - Vector to add to this vector.

Returns:

The result of the element-wise vector addition.

Throws:

IllegalArgumentException - If this vector and the specified vector have different lengths.

add

W add(CooCVector B)

Computes the element-wise addition between this vector and the specified vector.

Parameters:

B - Vector to add to this vector.

Returns:

The result of the element-wise vector addition.

Throws:

IllegalArgumentException - If this vector and the specified vector have different lengths.

sub

U sub(Vector B)

Computes the element-wise subtraction between this vector and the specified vector.

Parameters:

B - Vector to subtract from this vector.

Returns:

The result of the element-wise vector subtraction.

Throws:

IllegalArgumentException - If this vector and the specified vector have different lengths.

sub

T sub(CooVector B)

Computes the element-wise subtraction between this vector and the specified vector.

Parameters:

B - Vector to subtract from this vector.

Returns:

The result of the element-wise vector subtraction.

Throws:

IllegalArgumentException - If this vector and the specified vector have different lengths.

sub

CVector sub(CVector B)

Computes the element-wise subtraction between this vector and the specified vector.

Parameters:

B - Vector to subtract from this vector.

Returns:

The result of the element-wise vector subtraction.

Throws:

IllegalArgumentException - If this vector and the specified vector have different lengths.

sub

W sub(CooCVector B)

Computes the element-wise subtraction between this vector and the specified vector.

Parameters:

B - Vector to subtract from this vector.

Returns:

The result of the element-wise vector subtraction.

Throws:

IllegalArgumentException - If this vector and the specified vector have different lengths.

elemMult

T elemMult(Vector B)

Computes the element-wise multiplication (Hadamard multiplication) between this vector and a specified vector.

Parameters:

B - Vector to element-wise multiply to this vector.

Returns:

The vector resulting from the element-wise multiplication.

Throws:

IllegalArgumentException - If this vector and B do not have the same size.

elemMult

V elemMult(CooVector B)

Computes the element-wise multiplication (Hadamard multiplication) between this vector and a specified vector.

Parameters:

B - Vector to element-wise multiply to this vector.

Returns:

The vector resulting from the element-wise multiplication.

Throws:

IllegalArgumentException - If this vector and B do not have the same size.

elemMult

W elemMult(CVector B)

Computes the element-wise multiplication (Hadamard multiplication) between this vector and a specified vector.

Parameters:

B - Vector to element-wise multiply to this vector.

Returns:

The vector resulting from the element-wise multiplication.

Throws:

IllegalArgumentException - If this vector and B do not have the same size.

elemMult

CooCVector elemMult(CooCVector B)

Computes the element-wise multiplication (Hadamard multiplication) between this vector and a specified vector.

Parameters:

B - Vector to element-wise multiply to this vector.

Returns:

The vector resulting from the element-wise multiplication.

Throws:

IllegalArgumentException - If this vector and B do not have the same size.

elemDiv

T elemDiv(Vector B)

Computes the element-wise division (Hadamard multiplication) between this vector and a specified vector.

Parameters:

B - Vector to element-wise divide this vector by.

Returns:

The vector resulting from the element-wise division.

Throws:

IllegalArgumentException - If this vector and B do not have the same size.

elemDiv

W elemDiv(CVector B)

Computes the element-wise division (Hadamard multiplication) between this vector and a specified vector.

Parameters:

B - Vector to element-wise divide this vector by.

Returns:

The vector resulting from the element-wise division.

Throws:

IllegalArgumentException - If this vector and B do not have the same size.

inner

X inner(Vector b)

Computes the inner product between two vectors.

Parameters:

b - Second vector in the inner product.

Returns:

The inner product between this vector and the vector b.

Throws:

IllegalArgumentException - If this vector and vector b do not have the same number of entries.

inner

X inner(CooVector b)

Computes the inner product between two vectors.

Parameters:

b - Second vector in the inner product.

Returns:

The inner product between this vector and the vector b.

Throws:

IllegalArgumentException - If this vector and vector b do not have the same number of entries.

normalize

T normalize()

Computes a unit vector in the same direction as this vector.

Returns:

A unit vector with the same direction as this vector. If this vector is zeros, then an equivalently sized zero vector will be returned.

inner

CNumber inner(CVector b)

Computes the inner product between two vectors.

Parameters:

b - Second vector in the inner product.

Returns:

The inner product between this vector and the vector b.

Throws:

IllegalArgumentException - If this vector and vector b do not have the same number of entries.

inner

CNumber inner(CooCVector b)

Computes the inner product between two vectors.

Parameters:

b - Second vector in the inner product.

Returns:

The inner product between this vector and the vector b.

Throws:

IllegalArgumentException - If this vector and vector b do not have the same number of entries.

outer

UU outer(Vector b)

Computes the outer product of two vectors.

Parameters:

b - Second vector in the outer product.

Returns:

The result of the vector outer product between this vector and b.

Throws:

IllegalArgumentException - If the two vectors do not have the same number of entries.

outer

UU outer(CooVector b)

Computes the outer product of two vectors.

Parameters:

b - Second vector in the outer product.

Returns:

The result of the vector outer product between this vector and b.

Throws:

IllegalArgumentException - If the two vectors do not have the same number of entries.

outer

CMatrix outer(CVector b)

Computes the outer product of two vectors.

Parameters:

b - Second vector in the outer product.

Returns:

The result of the vector outer product between this vector and b.

Throws:

IllegalArgumentException - If the two vectors do not have the same number of entries.

outer

CMatrix outer(CooCVector b)

Computes the outer product of two vectors.

Parameters:

b - Second vector in the outer product.

Returns:

The result of the vector outer product between this vector and b.

Throws:

IllegalArgumentException - If the two vectors do not have the same number of entries.

isParallel

boolean isParallel(Vector b)

Checks if a vector is parallel to this vector.

Parameters:

b - Vector to compare to this vector.

Returns:

True if the vector b is parallel to this vector and the same size. Otherwise, returns false.

isPerp

boolean isPerp(Vector b)

Checks if a vector is perpendicular to this vector.

Parameters:

b - Vector to compare to this vector.

Returns:

True if the vector b is perpendicular to this vector and the same size. Otherwise, returns false.

toMatrix

TT toMatrix()

Converts a vector to an equivalent matrix.

Returns:

A matrix equivalent to this vector where the vector is treated as a column vector.

toMatrix

TT toMatrix(boolean columVector)

Converts a vector to an equivalent matrix representing either a row or column vector.

Parameters:

columVector - Flag for choosing whether to convert this vector to a matrix representing a row or column vector.

If true, the vector will be converted to a matrix representing a column vector.

If false, The vector will be converted to a matrix representing a row vector.

Returns:

A matrix equivalent to this vector.