Package org.flag4j.arrays.sparse

Class CooCVector

java.lang.Object

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

org.flag4j.core.sparse_base.SparseTensorBase<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber[],CNumber>

org.flag4j.core.sparse_base.ComplexSparseTensorBase<CooCVector,CVector,CooVector>

org.flag4j.arrays.sparse.CooCVector

All Implemented Interfaces:

Serializable, ComplexTensorMixin<CooCVector,CooVector>, SparseTensorMixin, TensorComparisonsMixin, TensorManipulationsMixin<CooCVector>, TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>, TensorPropertiesMixin, VectorComparisonsMixin, VectorManipulationsMixin<CooCMatrix>, VectorMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>, VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>, VectorPropertiesMixin

public class CooCVector
extends ComplexSparseTensorBase<CooCVector,CVector,CooVector>
implements VectorMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

Complex sparse vector. Stored in coordinate (COO) format.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final int[]	indices	Indices of non-zero entries in this sparse vector.
final int	size	The size of this vector.

Fields inherited from class org.flag4j.core.sparse_base.SparseTensorBase

nnz

Fields inherited from class org.flag4j.core.TensorBase

DEFAULT_ROUND_TO_ZERO_THRESHOLD, entries, shape

Constructor Summary

Constructors

Constructor	Description
CooCVector(int size)	Creates a sparse column vector of specified size filled with zeros.
CooCVector(int size, double[] nonZeroEntries, int[] indices)	Creates a sparse column vector of specified size filled with zeros.
CooCVector(int size, int[] nonZeroEntries, int[] indices)	Creates a sparse column vector of specified size filled with zeros.
CooCVector(int size, List<CNumber> entries, List<Integer> indices)	Creates a sparse vector of specified size, non-zero entries, and non-zero indices.
CooCVector(int size, CNumber[] nonZeroEntries, int[] indices)	Creates a sparse column vector of specified size filled with zeros.
CooCVector(CooCVector a)	Constructs a complex sparse vector whose size, orientation, non-zero entries, and indices are specified by another complex sparse vector.

Method Summary

Modifier and Type	Method	Description
CooVector	abs()	Computes the element-wise absolute value/magnitude of a tensor.
CVector	add(double a)	Adds specified value to all entries of this tensor.
CVector	add(CVector B)	Computes the element-wise addition between this vector and the specified vector.
CVector	add(Vector B)	Computes the element-wise addition between this vector and the specified vector.
CooCVector	add(CooCVector B)	Computes the element-wise addition between two tensors of the same rank.
CooCVector	add(CooVector B)	Computes the element-wise addition between this vector and the specified vector.
CVector	add(CNumber a)	Adds specified value to all entries of this tensor.
boolean	allClose(CooCVector tensor, double relTol, double absTol)	Checks if all entries of this tensor are close to the entries of the argument tensor.
int[]	argMax()	Finds the indices of the maximum value in this tensor.
int[]	argMin()	Finds the indices of the minimum value in this tensor.
CooCVector	conj()	Computes the complex conjugate of a tensor.
CooCVector	copy()	Creates a dense copy of this tensor.
CooCVector	div(double divisor)	Computes the scalar division of a tensor.
CooCVector	div(CNumber divisor)	Computes the scalar division of a tensor.
CooCVector	elemDiv(CVector B)	Computes the element-wise division between two tensors.
CooCVector	elemDiv(Vector B)	Computes the element-wise division (Hadamard multiplication) between this vector and a specified vector.
CooCVector	elemMult(CVector B)	Computes the element-wise multiplication (Hadamard multiplication) between this vector and a specified vector.
CooCVector	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 between two tensors.
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 sparse COO vector.
CooCMatrix	extend(int n, int axis)	Extends a vector a specified number of times to a matrix.
CooCVector	flatten()	Flattens tensor to single dimension.
CooCVector	flatten(int axis)	Flattens a tensor along the specified axis.
static CooCVector	fromDense(CVector src)	Creates a sparse tensor from a dense tensor.
CNumber	get(int... indices)	Gets the element in this tensor at the specified indices.
protected CooCVector	getSelf()	Simply returns a reference of this tensor.
CooCVector	H()	Computes the conjugate transpose of this tensor.
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.
boolean	isComplex()	Checks if this vector contains at least one non-real entry.
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.
boolean	isReal()	Checks if this vector contains only real entries.
CVector	join(CVector b)	Joints specified vector with this vector.
CVector	join(Vector b)	Joints specified vector with this vector.
CooCVector	join(CooCVector b)	Joints specified vector with this vector.
CooCVector	join(CooVector b)	Joints specified vector with this vector.
int	length()	Gets the length of a vector.
protected CooVector	makeRealTensor(Shape shape, double[] entries, int[][] indices)	A factory for creating a real sparse tensor.
protected CooCVector	makeTensor(Shape shape, CNumber[] entries, int[][] indices)	A factory for creating a complex sparse tensor.
CooCVector	mult(double factor)	Computes scalar multiplication of a tensor.
CooCVector	mult(CNumber factor)	Computes scalar multiplication of a tensor.
CooCVector	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.
CooCVector	recip()	Computes the reciprocals, element-wise, of this sparse vector.
CooCMatrix	repeat(int n, int axis)	Repeats a vector n times along a certain axis to create a matrix.
CooCVector	reshape(int... shape)	Copies and reshapes tensor if possible.
CooCVector	reshape(Shape shape)	Copies and reshapes tensor if possible.
CooCVector	set(double value, int... indices)	Sets an index of this tensor to a specified value.
CooCVector	set(CNumber value, int... indices)	Sets an index of this tensor to a specified value.
int	size()	Gets the full size of this vector (including non-zero entries).
CooCVector	sqrt()	Computes the element-wise square root of a tensor.
CooCMatrix	stack(CVector b)	Stacks two vectors along columns as if they were row vectors.
CooCMatrix	stack(CVector b, int axis)	Stacks two vectors along specified axis.
CooCMatrix	stack(Vector b)	Stacks two vectors along columns as if they were row vectors.
CooCMatrix	stack(Vector b, int axis)	Stacks two vectors along specified axis.
CooCMatrix	stack(CooCVector b)	Stacks two vectors along columns as if they were row vectors.
CooCMatrix	stack(CooCVector b, int axis)	Stacks two vectors along specified axis.
CooCMatrix	stack(CooVector b)	Stacks two vectors along columns as if they were row vectors.
CooCMatrix	stack(CooVector b, int axis)	Stacks two vectors along specified axis.
CVector	sub(double a)	Adds specified value to all entries of this tensor.
CVector	sub(CVector B)	Computes the element-wise subtraction between this vector and the specified vector.
CVector	sub(Vector B)	Computes the element-wise subtraction between this vector and the specified vector.
CooCVector	sub(CooCVector B)	Computes the element-wise subtraction between two tensors of the same rank.
CooCVector	sub(CooVector B)	Computes the element-wise subtraction between this vector and the specified vector.
CVector	sub(CNumber a)	Subtracts a specified value from all entries of this tensor.
CooCVector	T()	Computes the transpose of a tensor.
CVector	toDense()	Converts this sparse tensor to an equivalent dense tensor.
CooCMatrix	toMatrix()	Converts a vector to an equivalent matrix.
CooCMatrix	toMatrix(boolean columVector)	Converts a vector to an equivalent matrix representing either a row or column vector.
CooVector	toReal()	Converts a complex tensor to a real matrix.
CooVector	toRealSafe()	Converts a complex tensor to a real matrix safely.
String	toString()	Formats this tensor as a human-readable string.
CooCTensor	toTensor()	Converts this vector to an equivalent tensor.
CooCVector	transpose()	Computes the transpose of a tensor.

Methods inherited from class org.flag4j.core.sparse_base.ComplexSparseTensorBase

isOnes, isZeros, max, maxAbs, min, minAbs, nonZeroEntries, round, round, roundToZero, roundToZero, sortIndices, sum

Methods inherited from class org.flag4j.core.sparse_base.SparseTensorBase

density, sparsity

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, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.flag4j.core.ComplexTensorMixin

hermTranspose

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.

indices

public final int[] indices

Indices of non-zero entries in this sparse vector.

Constructor Details

CooCVector

public CooCVector(int size)

Creates a sparse column vector of specified size filled with zeros.

Parameters:

size - The size of the sparse vector. i.e. the total number of entries in the sparse vector.

CooCVector

public CooCVector(int size,
 int[] nonZeroEntries,
 int[] indices)

Creates a sparse column vector of specified size filled with zeros.

Parameters:

size - The size of the sparse vector. i.e. the total number of entries in the sparse vector.

nonZeroEntries - The nonZero entries of this sparse vector.

indices - Indices of the nonZero entries.

Throws:

IllegalArgumentException - If the lengths of nonZeroEntries and indices arrays are not equal or if the length of the nonZeroEntries array is greater than the size.

CooCVector

public CooCVector(int size,
 double[] nonZeroEntries,
 int[] indices)

Creates a sparse column vector of specified size filled with zeros.

Parameters:

size - The size of the sparse vector. i.e. the total number of entries in the sparse vector.

nonZeroEntries - The nonZero entries of this sparse vector.

indices - Indices of the nonZero entries.

Throws:

IllegalArgumentException - If the lengths of nonZeroEntries and indices arrays are not equal or if the length of the nonZeroEntries array is greater than the size.

CooCVector

public CooCVector(int size,
 CNumber[] nonZeroEntries,
 int[] indices)

Creates a sparse column vector of specified size filled with zeros.

Parameters:

size - The size of the sparse vector. i.e. the total number of entries in the sparse vector.

nonZeroEntries - The nonZero entries of this sparse vector.

indices - Indices of the nonZero entries.

Throws:

IllegalArgumentException - If the lengths of nonZeroEntries and indices arrays are not equal or if the length of the nonZeroEntries array is greater than the size.

CooCVector

public CooCVector(CooCVector a)

Constructs a complex sparse vector whose size, orientation, non-zero entries, and indices are specified by another complex sparse vector.

Parameters:

a - Vector to copy.

CooCVector

public CooCVector(int size,
 List<CNumber> entries,
 List<Integer> indices)

Creates a sparse vector of specified size, non-zero entries, and non-zero indices.

Parameters:

size - Full size, including zeros, of the sparse vector.

entries - Non-zero entries of the sparse vector.

indices - Non-zero indices of the sparse vector.

Method Details

equals

public boolean equals(Object object)

Checks if an object is equal to this sparse COO vector.

Specified by:

equals in interface TensorComparisonsMixin

Overrides:

equals in class Object

Parameters:

object - Object to compare this sparse COO vector to.

Returns:

True if the object is a CooVector, has the same shape as this vector, and is element-wise equal to this vector.

fromDense

public static CooCVector fromDense(CVector src)

Creates a sparse tensor from a dense tensor.

Parameters:

src - Dense tensor to convert to a sparse tensor.

Returns:

A sparse tensor which is equivalent to the src dense tensor.

getSelf

protected CooCVector getSelf()

Simply returns a reference of this tensor.

Specified by:

getSelf in class TensorBase<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber[],CNumber>

Returns:

A reference to this tensor.

allClose

public boolean allClose(CooCVector tensor,
 double relTol,
 double absTol)

Description copied from class: TensorBase

Checks if all entries of this tensor are close to the entries of the argument tensor.

Specified by:

allClose in class TensorBase<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber[],CNumber>

Parameters:

tensor - Tensor to compare this tensor to.

relTol - Relative tolerance.

absTol - Absolute tolerance.

Returns:

True if the argument tensor is the same shape as this tensor and all entries are 'close', i.e. elements a and b at the same positions in the two tensors respectively satisfy |a-b| <= (atol + rtol*|b|). Otherwise, returns false.

See Also:

• TensorBase.allClose(Object)

H

public CooCVector H()

Computes the conjugate transpose of this tensor. In the context of a tensor, this swaps the first and last axes and takes the complex conjugate of the elements along these axes. Same as ComplexTensorMixin.hermTranspose().

Specified by:

H in interface ComplexTensorMixin<CooCVector,CooVector>

Returns:

The complex transpose of this tensor.

set

public CooCVector set(CNumber value,
 int... indices)

Sets an index of this tensor to a specified value.

Specified by:

set in interface ComplexTensorMixin<CooCVector,CooVector>

Parameters:

value - Value to set.

indices - The indices of this matrix for which to set the value.

Returns:

A reference to this tensor.

Throws:

IllegalArgumentException - If the number of indices is not equal to the rank of this tensor.

IndexOutOfBoundsException - If any of the indices are not within this tensor.

isReal

public boolean isReal()

Checks if this vector contains only real entries.

Specified by:

isReal in interface ComplexTensorMixin<CooCVector,CooVector>

Overrides:

isReal in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Returns:

True if this vector only contains real entries. Returns false if there is at least one entry with non-zero imaginary component.

isComplex

public boolean isComplex()

Checks if this vector contains at least one non-real entry.

Specified by:

isComplex in interface ComplexTensorMixin<CooCVector,CooVector>

Overrides:

isComplex in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Returns:

True if this vector contains at least one non-real entry. Returns false if all entries are real.

conj

public CooCVector conj()

Description copied from interface: ComplexTensorMixin

Computes the complex conjugate of a tensor.

Specified by:

conj in interface ComplexTensorMixin<CooCVector,CooVector>

Overrides:

conj in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Returns:

The complex conjugate of this tensor.

toReal

public CooVector toReal()

Description copied from class: ComplexSparseTensorBase

Converts a complex tensor to a real matrix. The imaginary component of any complex value will be ignored.

Specified by:

toReal in interface ComplexTensorMixin<CooCVector,CooVector>

Overrides:

toReal in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Returns:

A tensor of the same size containing only the real components of this tensor.

See Also:

• ComplexSparseTensorBase.toRealSafe()

toRealSafe

public CooVector toRealSafe()

Converts a complex tensor to a real matrix safely. That is, first checks if the tensor only contains real values and then converts to a real tensor. However, if non-real value exist, then an error is thrown.

Specified by:

toRealSafe in interface ComplexTensorMixin<CooCVector,CooVector>

Overrides:

toRealSafe in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Returns:

A tensor of the same size containing only the real components of this tensor.

Throws:

RuntimeException - If this tensor contains at least one non-real value.

See Also:

• toReal()

toTensor

public CooCTensor toTensor()

Converts this vector to an equivalent tensor.

Returns:

A tensor which is equivalent to this vector.

set

public CooCVector set(double value,
 int... indices)

Sets an index of this tensor to a specified value.

Specified by:

set in interface TensorManipulationsMixin<CooCVector>

Parameters:

value - Value to set.

indices - The indices of this tensor for which to set the value.

Returns:

A reference to this tensor.

reshape

public CooCVector reshape(Shape shape)

Copies and reshapes tensor if possible. The total number of entries in this tensor must match the total number of entries in the reshaped tensor.

Specified by:

reshape in interface TensorManipulationsMixin<CooCVector>

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.

reshape

public CooCVector reshape(int... shape)

Copies and reshapes tensor if possible. The total number of entries in this tensor must match the total number of entries in the reshaped tensor.

Specified by:

reshape in interface TensorManipulationsMixin<CooCVector>

Overrides:

reshape in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

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 CooCVector flatten()

Flattens tensor to single dimension. To flatten tensor along a single axis.

Specified by:

flatten in interface TensorManipulationsMixin<CooCVector>

Returns:

The flattened tensor.

join

public CVector join(Vector b)

Joints specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

Parameters:

b - Vector to join with this vector.

Returns:

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

join

public CooCVector join(CooVector b)

Joints specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

Parameters:

b - Vector to join with this vector.

Returns:

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

join

public CooCVector join(CooCVector b)

Joints specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

Parameters:

b - Vector to join with this vector.

Returns:

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

stack

public CooCMatrix stack(Vector b)

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

Specified by:

stack in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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 CooCMatrix stack(CooVector b)

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

Specified by:

stack in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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 CooCMatrix stack(CVector b)

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

Specified by:

stack in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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 CooCMatrix stack(CooCVector b)

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

Specified by:

stack in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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 CooCMatrix 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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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 CooCMatrix 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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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 CooCMatrix 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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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 CooCMatrix 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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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 CooCVector add(CooVector B)

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

Specified by:

add in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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 CooCVector add(CooCVector B)

Computes the element-wise addition between two tensors of the same rank.

Specified by:

add in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Specified by:

add in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

Parameters:

B - Second tensor in the addition.

Returns:

The result of adding the tensor B to this tensor element-wise.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

sub

public CVector sub(Vector B)

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

Specified by:

sub in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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

public CooCVector sub(CooVector B)

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

Specified by:

sub in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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

public CVector sub(CVector B)

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

Specified by:

sub in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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.

add

public CVector add(double a)

Adds specified value to all entries of this tensor.

Specified by:

add in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Parameters:

a - Value to add to all entries of this tensor.

Returns:

The result of adding the specified value to each entry of this tensor.

add

public CVector add(CNumber a)

Adds specified value to all entries of this tensor.

Specified by:

add in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Parameters:

a - Value to add to all entries of this tensor.

Returns:

The result of adding the specified value to each entry of this tensor.

sub

public CooCVector sub(CooCVector B)

Computes the element-wise subtraction between two tensors of the same rank.

Specified by:

sub in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Specified by:

sub in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

Parameters:

B - Second tensor in element-wise subtraction.

Returns:

The result of subtracting the tensor B from this tensor element-wise.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

elemMult

public CooCVector elemMult(Vector B)

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

Specified by:

elemMult in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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(CVector B)

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

Specified by:

elemMult in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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.

sub

public CVector sub(double a)

Adds specified value to all entries of this tensor.

Specified by:

sub in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Parameters:

a - Value to add to all entries of this tensor.

Returns:

The result of adding the specified value to each entry of this tensor.

sub

public CVector sub(CNumber a)

Subtracts a specified value from all entries of this tensor.

Specified by:

sub in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Parameters:

a - Value to subtract from all entries of this tensor.

Returns:

The result of subtracting the specified value from each entry of this tensor.

makeTensor

protected CooCVector makeTensor(Shape shape,
 CNumber[] entries,
 int[][] indices)

A factory for creating a complex sparse tensor.

Specified by:

makeTensor in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Parameters:

shape - Shape of the sparse tensor to make.

entries - Non-zero entries of the sparse tensor to make.

indices - Non-zero indices of the sparse tensor to make.

Returns:

A tensor created from the specified parameters.

makeRealTensor

protected CooVector makeRealTensor(Shape shape,
 double[] entries,
 int[][] indices)

A factory for creating a real sparse tensor.

Specified by:

makeRealTensor in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Parameters:

shape - Shape of the sparse tensor to make.

entries - Non-zero entries of the sparse tensor to make.

indices - Non-zero indices of the sparse tensor to make.

Returns:

A tensor created from the specified parameters.

mult

public CooCVector mult(double factor)

Computes scalar multiplication of a tensor.

Specified by:

mult in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Overrides:

mult in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Parameters:

factor - Scalar value to multiply with tensor.

Returns:

The result of multiplying this tensor by the specified scalar.

mult

public CooCVector mult(CNumber factor)

Computes scalar multiplication of a tensor.

Specified by:

mult in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Overrides:

mult in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Parameters:

factor - Scalar value to multiply with tensor.

Returns:

The result of multiplying this tensor by the specified scalar.

div

public CooCVector div(double divisor)

Computes the scalar division of a tensor.

Specified by:

div in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Overrides:

div in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Parameters:

divisor - The scalar value to divide tensor by.

Returns:

The result of dividing this tensor by the specified scalar.

Throws:

ArithmeticException - If divisor is zero.

div

public CooCVector div(CNumber divisor)

Computes the scalar division of a tensor.

Specified by:

div in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Overrides:

div in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Parameters:

divisor - The scalar value to divide tensor by.

Returns:

The result of dividing this tensor by the specified scalar.

Throws:

ArithmeticException - If divisor is zero.

sqrt

public CooCVector sqrt()

Computes the element-wise square root of a tensor.

Specified by:

sqrt in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Overrides:

sqrt in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Returns:

The result of applying an element-wise square root to this tensor. Note, this method will compute the principle square root i.e. the square root with positive real part.

abs

public CooVector abs()

Computes the element-wise absolute value/magnitude of a tensor. If the tensor contains complex values, the magnitude will be computed.

Specified by:

abs in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Overrides:

abs in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Returns:

The result of applying an element-wise absolute value/magnitude to this tensor.

transpose

public CooCVector transpose()

Computes the transpose of a tensor. Same as T().

Specified by:

transpose in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Returns:

The transpose of this tensor.

T

public CooCVector T()

Computes the transpose of a tensor. Same as transpose().

Specified by:

T in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Returns:

The transpose of this tensor.

recip

public CooCVector recip()

Computes the reciprocals, element-wise, of this sparse vector. However, all zero entries will remain zero.

Specified by:

recip in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Overrides:

recip in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Returns:

A sparse vector containing the reciprocal non-zero elements of this tensor.

Throws:

ArithmeticException - If this tensor contains any zeros.

get

public CNumber get(int... indices)

Gets the element in this tensor at the specified indices.

Specified by:

get in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Parameters:

indices - Indices of element.

Returns:

The element at the specified indices.

Throws:

IllegalArgumentException - If the number of indices does not match the rank of this tensor.

copy

public CooCVector copy()

Creates a dense copy of this tensor.

Specified by:

copy in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Returns:

A copy of this tensor.

elemMult

public CooCVector elemMult(CooCVector B)

Computes the element-wise multiplication between two tensors.

Specified by:

elemMult in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Specified by:

elemMult in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

Parameters:

B - Tensor to element-wise multiply to this tensor.

Returns:

The result of the element-wise tensor multiplication.

Throws:

IllegalArgumentException - If this tensor and B do not have the same shape.

elemDiv

public CooCVector elemDiv(Vector B)

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

Specified by:

elemDiv in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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

public CooCVector elemDiv(CVector B)

Computes the element-wise division between two tensors.

Specified by:

elemDiv in interface TensorOperationsMixin<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber>

Specified by:

elemDiv in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

Parameters:

B - Tensor to element-wise divide with this tensor.

Returns:

The result of the element-wise tensor multiplication.

Throws:

IllegalArgumentException - If this tensor and B do not have the same shape.

inner

public CNumber inner(Vector b)

Computes the inner product between two vectors.

Specified by:

inner in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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(CooVector b)

Computes the inner product between two vectors.

Specified by:

inner in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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 CooCVector normalize()

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

Specified by:

normalize in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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

public CMatrix outer(Vector b)

Computes the outer product of two vectors.

Specified by:

outer in interface VectorOperationsMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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 CooCMatrix toMatrix()

Converts a vector to an equivalent matrix.

Specified by:

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

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 CooCMatrix toMatrix(boolean columVector)

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

Specified by:

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

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.

argMin

public int[] argMin()

Finds the indices of the minimum value in this tensor.

Specified by:

argMin in interface TensorPropertiesMixin

Overrides:

argMin in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Returns:

The indices of the minimum value in this tensor. If this value occurs multiple times, the indices of the first entry (in row-major ordering) are returned.

argMax

public int[] argMax()

Finds the indices of the maximum value in this tensor.

Specified by:

argMax in interface TensorPropertiesMixin

Overrides:

argMax in class ComplexSparseTensorBase<CooCVector,CVector,CooVector>

Returns:

The indices of the maximum value in this tensor. If this value occurs multiple times, the indices of the first entry (in row-major ordering) are returned.

flatten

public CooCVector flatten(int axis)

Flattens a tensor along the specified axis. Since a vector only has 1 axis, this simply copies the vector.

Specified by:

flatten in interface TensorManipulationsMixin<CooCVector>

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 full size of this vector (including non-zero entries).

Specified by:

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

Returns:

The full size of this vector.

repeat

public CooCMatrix repeat(int n,
 int axis)

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

Specified by:

repeat in interface VectorMixin<CooCVector,CVector,CooCVector,CooCVector,CNumber,CooCMatrix,CMatrix,CooCMatrix>

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.

toDense

public CVector toDense()

Converts this sparse tensor to an equivalent dense tensor.

Specified by:

toDense in class SparseTensorBase<CooCVector,CVector,CooCVector,CVector,CooVector,CNumber[],CNumber>

Returns:

A dense tensor which is equivalent to this sparse tensor.

extend

public CooCMatrix extend(int n,
 int axis)

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

Specified by:

extend in interface VectorManipulationsMixin<CooCMatrix>

Parameters:

n - The number of times to extend this vector.

axis - Axis along which to extend vector.

Returns:

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

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.

toString

public String toString()

Formats this tensor as a human-readable string. Specifically, a string containing the shape and flatten entries of this tensor.

Overrides:

toString in class Object

Returns:

A human-readable string representing this tensor.