Package org.flag4j.arrays.dense

Class CVector

java.lang.Object

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

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

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

org.flag4j.arrays.dense.CVector

All Implemented Interfaces:

Serializable, ComplexTensorMixin<CVector,Vector>, DenseMixin<CNumber>, DenseVectorMixin, TensorComparisonsMixin, TensorManipulationsMixin<CVector>, TensorOperationsMixin<CVector,CVector,CVector,CVector,Vector,CNumber>, TensorPropertiesMixin, VectorComparisonsMixin, VectorManipulationsMixin<CMatrix>, VectorMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,CMatrix>, VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,CMatrix>, VectorPropertiesMixin

public class CVector
extends ComplexDenseTensorBase<CVector,Vector>
implements VectorMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,CMatrix>, DenseVectorMixin

Complex dense vector. This class is mostly equivalent to a rank 1 complex tensor.

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
CVector(double... entries)	Creates a vector with specified entries.
CVector(int size)	Creates a column vector of specified size filled with zeros.
CVector(int... entries)	Creates a vector with specified entries.
CVector(int size, double fillValue)	Creates a vector of specified size filled with a specified value.
CVector(int size, CNumber fillValue)	Creates a vector of specified size filled with a specified value.
CVector(CVector a)	Constructs a complex vector whose entries and shape are specified by another complex vector.
CVector(Vector a)	Constructs a complex vector whose entries and shape are specified by another real vector.
CVector(CNumber... entries)	Creates a vector with specified entries.

Method Summary

Modifier and Type	Method	Description
CVector	add(Vector 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.
CVector	add(CooVector B)	Computes the element-wise addition between this vector and the specified vector.
void	addEq(Vector B)	Computes the element-wise addition between this vector and the specified vector and stores the result in this vector.
void	addEq(CooCVector B)	Computes the element-wise addition between this vector and the specified vector and stores the result in this 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.
CVector	cross(Vector b)	Computes the vector cross product between two vectors.
CVector	elemDiv(Vector B)	Computes the element-wise division (Hadamard multiplication) between this vector and a specified vector.
CVector	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.
CooCVector	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.
CMatrix	extend(int n, int axis)	Extends a vector a specified number of times to a matrix.
CVector	flatten()	Since vectors are rank 1 tensors, this method simply copies the vector.
CVector	flatten(int axis)	Flattens a tensor along the specified axis.
static CVector	getEmpty(int size)	Constructs an empty complex dense vector whose entries are null.
protected CVector	getSelf()	Simply returns a reference of this tensor.
CVector	H()	Computes the conjugate transpose of this vector.
CNumber	inner(CVector b)	Computes the inner product between two vectors.
CNumber	inner(Vector b)	Computes the inner product between two vectors.
CNumber	inner(CooCVector b)	Computes the inner product between two vectors.
CNumber	inner(CooVector b)	Computes the inner product between two vectors.
double	innerSelf()	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)	Creates a new vector which is the result of joining the specified vector with this vector.
CVector	join(Vector b)	Joints specified vector with this vector.
CVector	join(CooCVector b)	Joints specified vector with this vector.
CVector	join(CooVector b)	Joints specified vector with this vector.
int	length()	Gets the length of a vector.
protected Vector	makeRealTensor(Shape shape, double[] entries)	Factory to create a real tensor with the specified shape and size.
protected CVector	makeTensor(Shape shape, CNumber[] entries)	Factory to create a tensor with the specified shape and size.
CVector	normalize()	Computes a unit vector in the same direction as this vector.
CMatrix	outer(CVector b)	Computes the outer product of two vectors.
CMatrix	outer(Vector b)	Computes the outer product of two vectors.
CMatrix	outer(CooCVector b)	Computes the outer product of two vectors.
CMatrix	outer(CooVector b)	Computes the outer product of two vectors.
CMatrix	repeat(int n, int axis)	Repeats a vector n times along a certain axis to create a matrix.
CVector	reshape(Shape shape)	Since vectors are rank 1 tensors, this method simply copies the vector.
int	size()	gets the size of this vector.
CMatrix	stack(CVector b)	Stacks two vectors along columns as if they are column vectors.
CMatrix	stack(CVector b, int axis)	Stacks two vectors along specified axis.
CMatrix	stack(Vector b)	Stacks two vectors along columns as if they are column vectors.
CMatrix	stack(Vector b, int axis)	Stacks two vectors along specified axis.
CMatrix	stack(CooCVector b)	Stacks two vectors along columns as if they are column vectors.
CMatrix	stack(CooCVector b, int axis)	Stacks two vectors along specified axis.
CMatrix	stack(CooVector b)	Stacks two vectors along columns as if they are column vectors.
CMatrix	stack(CooVector b, int axis)	Stacks two vectors along specified axis.
CVector	sub(Vector 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.
CVector	sub(CooVector B)	Computes the element-wise addition between this vector and the specified vector.
void	subEq(Vector B)	Computes the element-wise subtraction between this vector and the specified vector and stores the result in this vector.
void	subEq(CooCVector B)	Computes the element-wise subtraction between this vector and the specified vector and stores the result in this vector.
void	subEq(CooVector B)	Computes the element-wise addition between this vector and the specified vector.
CVector	T()	Computes the transpose of a tensor.
CooCVector	toCoo()	Converts this dense vector to an equivalent CooCVector.
CMatrix	toMatrix()	Converts a vector to an equivalent matrix.
CMatrix	toMatrix(boolean columVector)	Converts a vector to an equivalent matrix representing either a row or column vector.
String	toString()	Generates a human-readable string representation of this vector.
CTensor	toTensor()	Creates a rank 1 tensor which is equivalent to this vector.

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

abs, add, add, add, addEq, addEq, addEq, allClose, argMax, argMin, conj, copy, div, div, elemDiv, elemMult, get, hashCode, isComplex, isOnes, isReal, isZeros, max, maxAbs, min, minAbs, mult, mult, recip, reshape, round, round, roundToZero, roundToZero, set, set, sqrt, sub, sub, sub, subEq, subEq, subEq, sum, toReal, toRealSafe

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.ComplexTensorMixin

hermTranspose

Methods inherited from interface org.flag4j.core.TensorOperationsMixin

transpose

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 total number of entries in this vector.

Constructor Details

CVector

public CVector(int size)

Creates a column vector of specified size filled with zeros.

Parameters:

size - Size of the vector.

CVector

public CVector(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.

CVector

public CVector(int size,
 CNumber fillValue)

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

Parameters:

size - Size of the vector.

fillValue - Value to fill vector with.

CVector

public CVector(double... entries)

Creates a vector with specified entries.

Parameters:

entries - Entries for this column vector.

CVector

public CVector(int... entries)

Creates a vector with specified entries.

Parameters:

entries - Entries for this column vector.

CVector

public CVector(CNumber... entries)

Creates a vector with specified entries.

Parameters:

entries - Entries for this column vector.

CVector

public CVector(Vector a)

Constructs a complex vector whose entries and shape are specified by another real vector.

Parameters:

a - Real vector to copy.

CVector

public CVector(CVector a)

Constructs a complex vector whose entries and shape are specified by another complex vector.

Parameters:

a - Complex vector to copy.

Method Details

getEmpty

public static CVector getEmpty(int size)

Constructs an empty complex dense vector whose entries are null. Note, this is in contrast to CVector(int) which constructs the zero vector of a specified length.

Parameters:

size - Size of the empty vector to construct.

Returns:

An empty dense complex vector containing null values.

Throws:

NegativeArraySizeException - If size is negative.

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 CVector. False otherwise.

add

public CVector add(CooCVector B)

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

Specified by:

add in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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(Vector B)

Computes the element-wise addition between this vector and the specified vector and stores the result 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(Vector B)

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

Specified by:

subEq in interface DenseVectorMixin

Parameters:

B - Vector to subtract this vector.

Throws:

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

sub

public CVector sub(Vector B)

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

Specified by:

sub in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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(CooVector B)

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

Specified by:

sub in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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.

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.

addEq

public void addEq(CooCVector B)

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

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.

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.

subEq

public void subEq(CooCVector B)

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

Parameters:

B - Vector to add to this vector.

Throws:

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

elemMult

public CVector elemMult(Vector B)

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

Specified by:

elemMult in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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(CooVector B)

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

Specified by:

elemMult in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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(Vector B)

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

Specified by:

elemDiv in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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.

T

public CVector T()

Computes the transpose of a tensor. Same as TensorOperationsMixin.transpose(). This has no effect on a vector.

Specified by:

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

Returns:

The transpose of this tensor.

makeRealTensor

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

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

Specified by:

makeRealTensor in class ComplexDenseTensorBase<CVector,Vector>

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.

extend

public CMatrix extend(int n,
 int axis)

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

Specified by:

extend in interface VectorManipulationsMixin<CMatrix>

Parameters:

n - The number of times to extend this vector.

axis - Axis along which to extend vector. If axis=0 this vector is treated as a row vector and extended along rows. If axis=1 this vector is treated as a column vector and extended along the columns.

Returns:

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

join

public CVector join(Vector b)

Joints specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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)

Creates a new vector which is the result of joining the specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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(CooVector b)

Joints specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,CMatrix>

Parameters:

b - Vector to join with this vector.

Returns:

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

stack

public CMatrix stack(Vector b)

Stacks two vectors along columns as if they are column vectors.

Specified by:

stack in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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(CooVector b)

Stacks two vectors along columns as if they are column vectors.

Specified by:

stack in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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 as if they are column vectors.

Specified by:

stack in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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 as if they are column vectors.

Specified by:

stack in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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(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<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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(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<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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.

add

public CVector add(Vector B)

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

Specified by:

add in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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(CooVector B)

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

Specified by:

add in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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.

inner

public CNumber inner(Vector b)

Computes the inner product between two vectors.

Specified by:

inner in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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.

innerSelf

public double innerSelf()

Computes the inner product between two vectors.

Returns:

The inner product between this vector and the vector b.

inner

public CNumber inner(CooVector b)

Computes the inner product between two vectors.

Specified by:

inner in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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 CVector normalize()

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

Specified by:

normalize in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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 CVector 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 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 CMatrix outer(Vector b)

Computes the outer product of two vectors.

Specified by:

outer in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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(CooVector b)

Computes the outer product of two vectors.

Specified by:

outer in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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 CMatrix toMatrix()

Converts a vector to an equivalent matrix.

Specified by:

toMatrix in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,CMatrix>

Returns:

A matrix equivalent to this vector. This method will respect the orientation of the vector. That is, if this vector is a row vector, then the resulting matrix will have a single row. If this vector is a column vector, then the resulting matrix will have a single column.

toMatrix

public CMatrix toMatrix(boolean columVector)

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

Specified by:

toMatrix in interface VectorOperationsMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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 CTensor toTensor()

Creates a rank 1 tensor which is equivalent to this vector.

Returns:

A rank 1 tensor equivalent to this vector.

toCoo

public CooCVector toCoo()

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

Specified by:

toCoo in class DenseTensorBase<CVector,CVector,Vector,CNumber[],CNumber>

Returns:

A CooCVector that is equivalent to this dense vector.

length

public int length()

Gets the length of a vector.

Specified by:

length in interface VectorPropertiesMixin

Returns:

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

H

public CVector H()

Computes the conjugate transpose of this vector. Since a vector is a rank 1 tensor, this simply computes the complex conjugate of this vector.

Specified by:

H in interface ComplexTensorMixin<CVector,Vector>

Returns:

The complex conjugate of this vector.

reshape

public CVector reshape(Shape shape)

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

Specified by:

reshape in interface TensorManipulationsMixin<CVector>

Overrides:

reshape in class ComplexDenseTensorBase<CVector,Vector>

Parameters:

shape - Shape of the new tensor.

Returns:

A tensor which is equivalent to this tensor but with the specified shape.

Throws:

IllegalArgumentException - If this tensor cannot be reshaped to the specified dimensions.

flatten

public CVector flatten()

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

Specified by:

flatten in interface TensorManipulationsMixin<CVector>

Returns:

The flattened tensor.

flatten

public CVector flatten(int axis)

Flattens a tensor along the specified axis.

Specified by:

flatten in interface TensorManipulationsMixin<CVector>

Parameters:

axis - Axis along which to flatten tensor.

Throws:

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

size

public int size()

gets the size of this vector.

Specified by:

size in interface VectorMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,CMatrix>

Returns:

The total number of entries in this vector.

repeat

public CMatrix repeat(int n,
 int axis)

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

Specified by:

repeat in interface VectorMixin<CVector,CVector,CooCVector,CVector,CNumber,CMatrix,CMatrix,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.

makeTensor

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

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

Specified by:

makeTensor in class DenseTensorBase<CVector,CVector,Vector,CNumber[],CNumber>

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.

getSelf

protected CVector getSelf()

Simply returns a reference of this tensor.

Specified by:

getSelf in class TensorBase<CVector,CVector,CVector,CVector,Vector,CNumber[],CNumber>

Returns:

A reference to this tensor.

toString

public String toString()

Generates a human-readable string representation of this vector.

Overrides:

toString in class Object

Returns:

A human-readable string representation of this vector.