Package org.flag4j.arrays.dense

Class Vector

java.lang.Object

org.flag4j.core.TensorBase<Vector,Vector,CVector,CVector,Vector,double[],Double>

org.flag4j.core.dense_base.DenseTensorBase<Vector,CVector,Vector,double[],Double>

org.flag4j.core.dense_base.RealDenseTensorBase<Vector,CVector>

org.flag4j.arrays.dense.Vector

All Implemented Interfaces:

Serializable, DenseMixin<Double>, DenseVectorMixin, RealTensorMixin<Vector,CVector>, TensorComparisonsMixin, TensorManipulationsMixin<Vector>, TensorOperationsMixin<Vector,Vector,CVector,CVector,Vector,Double>, TensorPropertiesMixin, VectorComparisonsMixin, VectorManipulationsMixin<Matrix>, VectorMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>, VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>, VectorPropertiesMixin

public class Vector
extends RealDenseTensorBase<Vector,CVector>
implements VectorMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>, DenseVectorMixin

Real dense vector. This class is mostly Equivalent to a real dense tensor with rank 1.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final int	size	The size of this vector.

Fields inherited from class org.flag4j.core.TensorBase

DEFAULT_ROUND_TO_ZERO_THRESHOLD, entries, shape

Constructor Summary

Constructors

Constructor	Description
Vector(double... entries)	Creates a vector with specified entries.
Vector(int size)	Creates a vector of specified size filled with zeros.
Vector(int... entries)	Creates a vector with specified entries.
Vector(int size, double fillValue)	Creates a vector of specified size filled with a specified value.
Vector(Vector a)	Creates a vector from another vector.
Vector(Shape shape)	Creates a vector of the specified shape filled with zeros.
Vector(Shape shape, double fillValue)	Creates a vector of specified size filled with a specified value.

Method Summary

Modifier and Type	Method	Description
CVector	add(CVector B)	Computes the element-wise addition between this vector and the specified vector.
CVector	add(CooCVector B)	Computes the element-wise addition between this vector and the specified vector.
Vector	add(CooVector B)	Computes the element-wise addition between this vector and the specified vector.
void	addEq(CooVector B)	Computes the element-wise addition between this vector and the specified vector.
CVector	cross(CVector b)	Computes the vector cross product between two vectors.
Vector	cross(Vector b)	Computes the vector cross product between two vectors.
CVector	elemDiv(CVector B)	Computes the element-wise division (Hadamard multiplication) between this vector and a specified vector.
CVector	elemMult(CVector 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.
CooVector	elemMult(CooVector B)	Computes the element-wise multiplication (Hadamard multiplication) between this vector and a specified vector.
boolean	equals(Object object)	Checks if an object is equal to this vector object.
Matrix	extend(int n, int axis)	Extends a vector a specified number of times to a matrix.
Vector	flatten()	Since vectors are rank 1 tensors, this method simply copies the vector.
Vector	flatten(int axis)	Flattens a tensor along the specified axis.
protected Vector	getSelf()	Simply returns this tensor.
CNumber	inner(CVector b)	Computes the inner product between two vectors.
Double	inner(Vector b)	Computes the inner product between two vectors.
CNumber	inner(CooCVector b)	Computes the inner product between two vectors.
Double	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.
Vector	join(Vector b)	Joints specified vector with this vector.
CVector	join(CooCVector b)	Joints specified vector with this vector.
Vector	join(CooVector b)	Joints specified vector with this vector.
int	length()	Gets the length of a vector.
protected CVector	makeComplexTensor(Shape shape, double[] entries)	Factory to create a complex tensor with the specified shape and size.
protected CVector	makeComplexTensor(Shape shape, CNumber[] entries)	Factory to create a complex tensor with the specified shape and size.
protected Vector	makeTensor(Shape shape, double[] entries)	Factory to create a tensor with the specified shape and size.
Vector	normalize()	Computes a unit vector in the same direction as this vector.
CMatrix	outer(CVector b)	Computes the outer product of two vectors.
Matrix	outer(Vector b)	Computes the outer product of two vectors.
CMatrix	outer(CooCVector b)	Computes the outer product of two vectors.
Matrix	outer(CooVector b)	Computes the outer product of two vectors.
Matrix	repeat(int n, int axis)	Repeats a vector n times along a certain axis to create a matrix.
int	size()	gets the size of this vector.
CMatrix	stack(CVector b)	Stacks two vectors along columns.
CMatrix	stack(CVector b, int axis)	Stacks two vectors along specified axis.
Matrix	stack(Vector b)	Stacks two vectors along columns as if they were row vectors.
Matrix	stack(Vector b, int axis)	Stacks two vectors along specified axis.
CMatrix	stack(CooCVector b)	Stacks two vectors along columns.
CMatrix	stack(CooCVector b, int axis)	Stacks two vectors along specified axis.
Matrix	stack(CooVector b)	Stacks two vectors along columns.
Matrix	stack(CooVector b, int axis)	Stacks two vectors along specified axis.
CVector	sub(CVector B)	Computes the element-wise addition between this vector and the specified vector.
CVector	sub(CooCVector B)	Computes the element-wise addition between this vector and the specified vector.
Vector	sub(CooVector B)	Computes the element-wise addition between this vector and the specified vector.
void	subEq(CooVector B)	Computes the element-wise addition between this vector and the specified vector.
Vector	T()	Computes the transpose of a tensor.
CooVector	toCoo()	Converts this dense vector to an equivalent CooVector.
Matrix	toMatrix()	Converts a vector to an equivalent matrix representing the vector as a column.
Matrix	toMatrix(boolean columVector)	Converts a vector to an equivalent matrix representing either a row or column vector.
String	toString()	Converts this vector to a human-readable string format.
Tensor	toTensor()	Converts this vector to an equivalent tensor.
Vector	transpose()	Computes the transpose of a tensor.

Methods inherited from class org.flag4j.core.dense_base.RealDenseTensorBase

abs, add, add, add, addEq, addEq, allClose, argMax, argMin, copy, div, div, elemDiv, elemMult, get, hashCode, isNeg, isOnes, isPos, isZeros, max, maxAbs, min, minAbs, mult, mult, recip, reshape, reshape, round, round, roundToZero, roundToZero, set, sqrt, sub, sub, sub, subEq, subEq, sum, toComplex

Methods inherited from class org.flag4j.core.TensorBase

allClose, getEntries, getRank, getShape, sameLength, sameShape, tensorEquals, totalEntries

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.flag4j.core.dense_base.DenseVectorMixin

addEq, subEq

Methods inherited from interface org.flag4j.core.VectorOperationsMixin

add, elemDiv, elemMult, sub

Methods inherited from interface org.flag4j.core.VectorPropertiesMixin

maxAbs

Field Details

size

public final int size

The size of this vector. That is, the number of entries in this vector.

Constructor Details

Vector

public Vector(int size)

Creates a vector of specified size filled with zeros.

Parameters:

size - Size of the vector.

Vector

public Vector(int size,
 double fillValue)

Creates a vector of specified size filled with a specified value.

Parameters:

size - Size of the vector.

fillValue - Value to fill vector with.

Vector

public Vector(Shape shape)

Creates a vector of the specified shape filled with zeros.

Parameters:

shape - Shape of this vector.

Throws:

IllegalArgumentException - If the shapes is not rank 1.

Vector

public Vector(Shape shape,
 double fillValue)

Creates a vector of specified size filled with a specified value.

Parameters:

shape - Shape of the vector.

fillValue - Value to fill vector with.

Throws:

IllegalArgumentException - If the shapes is not rank 1.

Vector

public Vector(double... entries)

Creates a vector with specified entries.

Parameters:

entries - Entries for this column vector.

Vector

public Vector(int... entries)

Creates a vector with specified entries.

Parameters:

entries - Entries for this column vector.

Vector

public Vector(Vector a)

Creates a vector from another vector. This essentially copies the vector.

Parameters:

a - Vector to make copy of.

Method Details

equals

public boolean equals(Object object)

Checks if an object is equal to this vector object.

Specified by:

equals in interface TensorComparisonsMixin

Overrides:

equals in class Object

Parameters:

object - Object to check equality with this vector.

Returns:

True if the two vectors have the same shape, are numerically equivalent, and are of type Vector. False otherwise.

flatten

public Vector flatten()

Since vectors are rank 1 tensors, this method simply copies the vector.

Specified by:

flatten in interface TensorManipulationsMixin<Vector>

Returns:

The flattened tensor.

extend

public Matrix extend(int n,
 int axis)

Extends a vector a specified number of times to a matrix.

Specified by:

extend in interface VectorManipulationsMixin<Matrix>

Parameters:

n - The number of times to extend this vector.

axis - Axis along which to extend. If axis=0, then the vector will be treated as a row vector. If axis=1 then the vector will be treated as a column vector.

Returns:

A matrix which is the result of extending a vector n times.

Throws:

IllegalArgumentException - If axis is not 0 or 1.

add

public Vector add(CooVector B)

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

Specified by:

add in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CVector add(CVector B)

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

Specified by:

add in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CVector add(CooCVector B)

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

Specified by:

add in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public Vector sub(CooVector B)

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

Specified by:

sub in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CVector sub(CVector B)

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

Specified by:

sub in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CVector sub(CooCVector B)

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

Specified by:

sub in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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.

addEq

public void addEq(CooVector B)

Computes the element-wise addition between this vector and the specified vector. The result is stored in this vector.

Specified by:

addEq in interface DenseVectorMixin

Parameters:

B - Vector to add to this vector.

Throws:

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

subEq

public void subEq(CooVector B)

Computes the element-wise addition between this vector and the specified vector. The result is stored in this vector.

Specified by:

subEq in interface DenseVectorMixin

Parameters:

B - Vector to add to this vector.

Throws:

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

elemMult

public CooVector elemMult(CooVector B)

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

Specified by:

elemMult in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CVector elemMult(CVector B)

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

Specified by:

elemMult in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CooCVector elemMult(CooCVector B)

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

Specified by:

elemMult in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CVector elemDiv(CVector B)

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

Specified by:

elemDiv in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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.

transpose

public Vector transpose()

Computes the transpose of a tensor. Same as T(). For a vector, this just copies the vector.

Specified by:

transpose in interface TensorOperationsMixin<Vector,Vector,CVector,CVector,Vector,Double>

Returns:

The transpose of this tensor.

T

public Vector T()

Computes the transpose of a tensor. For a vector, this just copies the vector.
Same as transpose().

Specified by:

T in interface TensorOperationsMixin<Vector,Vector,CVector,CVector,Vector,Double>

Returns:

The transpose of this tensor.

join

public Vector join(Vector b)

Joints specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

Parameters:

b - Vector to join with this vector.

Returns:

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

join

public CVector join(CVector b)

Joints specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

Parameters:

b - Vector to join with this vector.

Returns:

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

join

public Vector join(CooVector b)

Joints specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

Parameters:

b - Vector to join with this vector.

Returns:

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

join

public CVector join(CooCVector b)

Joints specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

Parameters:

b - Vector to join with this vector.

Returns:

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

stack

public Matrix stack(Vector b)

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

Specified by:

stack in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public Matrix stack(CooVector b)

Stacks two vectors along columns.

Specified by:

stack in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CMatrix stack(CVector b)

Stacks two vectors along columns.

Specified by:

stack in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CMatrix stack(CooCVector b)

Stacks two vectors along columns.

Specified by:

stack in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public Matrix 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.

Specified by:

stack in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public Matrix 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.

Specified by:

stack in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CMatrix 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.

Specified by:

stack in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CMatrix 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.

Specified by:

stack in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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.

inner

public Double inner(Vector b)

Computes the inner product between two vectors.

Specified by:

inner in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public Double inner(CooVector b)

Computes the inner product between two vectors.

Specified by:

inner in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public Vector normalize()

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

Specified by:

normalize in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CNumber inner(CVector b)

Computes the inner product between two vectors.

Specified by:

inner in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CNumber inner(CooCVector b)

Computes the inner product between two vectors.

Specified by:

inner in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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.

cross

public Vector cross(Vector b)

Computes the vector cross product between two vectors.

Parameters:

b - Second vector in the cross product.

Returns:

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

Throws:

IllegalArgumentException - If either this vector or b do not have exactly 3 entries.

cross

public CVector cross(CVector b)

Computes the vector cross product between two vectors.

Parameters:

b - Second vector in the cross product.

Returns:

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

Throws:

IllegalArgumentException - If either this vector or b do not have 3 entries.

outer

public Matrix outer(Vector b)

Computes the outer product of two vectors.

Specified by:

outer in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public Matrix outer(CooVector b)

Computes the outer product of two vectors.

Specified by:

outer in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CMatrix outer(CVector b)

Computes the outer product of two vectors.

Specified by:

outer in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public CMatrix outer(CooCVector b)

Computes the outer product of two vectors.

Specified by:

outer in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public boolean isParallel(Vector b)

Checks if a vector is parallel to this vector.

Specified by:

isParallel in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public boolean isPerp(Vector b)

Checks if a vector is perpendicular to this vector.

Specified by:

isPerp in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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

public Matrix toMatrix()

Converts a vector to an equivalent matrix representing the vector as a column.

Specified by:

toMatrix in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

Returns:

A matrix equivalent to this vector.

toMatrix

public Matrix toMatrix(boolean columVector)

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

Specified by:

toMatrix in interface VectorOperationsMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

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.

toTensor

public Tensor toTensor()

Converts this vector to an equivalent tensor.

Returns:

A tensor which is equivalent to this vector.

makeTensor

protected Vector makeTensor(Shape shape,
 double[] entries)

Factory to create a tensor with the specified shape and size.

Specified by:

makeTensor in class DenseTensorBase<Vector,CVector,Vector,double[],Double>

Parameters:

shape - Shape of the tensor to make.

entries - Entries of the tensor to make.

Returns:

A new tensor with the specified shape and entries.

makeComplexTensor

protected CVector makeComplexTensor(Shape shape,
 double[] entries)

Factory to create a complex tensor with the specified shape and size.

Specified by:

makeComplexTensor in class RealDenseTensorBase<Vector,CVector>

Parameters:

shape - Shape of the tensor to make.

entries - Entries of the tensor to make.

Returns:

A new tensor with the specified shape and entries.

makeComplexTensor

protected CVector makeComplexTensor(Shape shape,
 CNumber[] entries)

Factory to create a complex tensor with the specified shape and size.

Specified by:

makeComplexTensor in class RealDenseTensorBase<Vector,CVector>

Parameters:

shape - Shape of the tensor to make.

entries - Entries of the tensor to make.

Returns:

A new tensor with the specified shape and entries.

toCoo

public CooVector toCoo()

Converts this dense vector to an equivalent CooVector. Note, this is likely only worthwhile for very sparse vectors.

Specified by:

toCoo in class DenseTensorBase<Vector,CVector,Vector,double[],Double>

Returns:

A CooVector that is equivalent to this dense vector.

getSelf

protected Vector getSelf()

Simply returns this tensor.

Specified by:

getSelf in class TensorBase<Vector,Vector,CVector,CVector,Vector,double[],Double>

Returns:

A reference to this tensor.

length

public int length()

Gets the length of a vector. Same as size()

Specified by:

length in interface VectorPropertiesMixin

Returns:

The length, i.e. the number of entries, in this vector.

size

public int size()

gets the size of this vector.

Specified by:

size in interface VectorMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

Returns:

The total number of entries in this vector.

repeat

public Matrix repeat(int n,
 int axis)

Repeats a vector n times along a certain axis to create a matrix.

Specified by:

repeat in interface VectorMixin<Vector,Vector,CooVector,CVector,Double,Matrix,Matrix,CMatrix>

Parameters:

n - Number of times to repeat vector.

axis - Axis along which to repeat vector. If axis=0 then each row of the resulting matrix will be equivalent to this vector. If axis=1 then each column of the resulting matrix will be equivalent to this vector.

Returns:

A matrix whose rows/columns are this vector repeated.

flatten

public Vector flatten(int axis)

Flattens a tensor along the specified axis. For a vector, this simply copies the vector.

Specified by:

flatten in interface TensorManipulationsMixin<Vector>

Parameters:

axis - Axis along which to flatten tensor.

Throws:

IllegalArgumentException - If the axis is not positive or larger than this.TensorBase.getRank()-1.

toString

public String toString()

Converts this vector to a human-readable string format. To specify the maximum number of entries to print, use PrintOptions.setMaxColumns(int).

Overrides:

toString in class Object

Returns:

A human-readable string representation of this vector.