Package org.flag4j.arrays.sparse

Class CooVector

java.lang.Object

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

org.flag4j.core.sparse_base.SparseTensorBase<CooVector,Vector,CooCVector,CVector,CooVector,double[],Double>

org.flag4j.core.sparse_base.RealSparseTensorBase<CooVector,Vector,CooCVector,CVector>

org.flag4j.arrays.sparse.CooVector

All Implemented Interfaces:

Serializable, RealTensorMixin<CooVector,CooCVector>, SparseTensorMixin, TensorComparisonsMixin, TensorManipulationsMixin<CooVector>, TensorOperationsMixin<CooVector,Vector,CooCVector,CVector,CooVector,Double>, TensorPropertiesMixin, VectorComparisonsMixin, VectorManipulationsMixin<CooMatrix>, VectorMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,CooCMatrix>, VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,CooCMatrix>, VectorPropertiesMixin

public class CooVector
extends RealSparseTensorBase<CooVector,Vector,CooCVector,CVector>
implements VectorMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,CooCMatrix>

Real 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
CooVector(int size)	Creates a sparse vector of specified size filled with zeros.
CooVector(int size, double[] nonZeroEntries, int[] indices)	Creates a sparse vector of specified size along with non-zero entries and their indices.
CooVector(int size, int[] nonZeroEntries, int[] indices)	Creates a sparse vector of specified size filled with zeros.
CooVector(int size, List<Double> entries, List<Integer> indices)	Creates a sparse vector of specified size, non-zero entries, and non-zero indices.
CooVector(CooVector a)	Constructs a sparse vector whose non-zero values, indices, and size are specified by another sparse vector.

Method Summary

Modifier and Type	Method	Description
Vector	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.
Vector	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 this vector and the specified vector.
CooVector	add(CooVector B)	Computes the element-wise addition between two tensors of the same rank.
CVector	add(CNumber a)	Adds specified value to all entries of this tensor.
boolean	allClose(CooVector tensor, double relTol, double absTol)	Checks if all entries of this tensor are close to the entries of the argument tensor.
CooVector	copy()	Creates a copy of this tensor.
CooVector	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 (Hadamard multiplication) between this vector and a specified vector.
CooVector	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.
CooVector	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.
CooVector	elemMult(CooVector B)	Computes the element-wise multiplication between two tensors.
boolean	equals(Object object)	Checks if an object is equal to this sparse COO vector.
CooMatrix	extend(int n, int axis)	Extends a vector a specified number of times to a matrix.
CooVector	flatten()	Flattens tensor to single dimension.
CooVector	flatten(int axis)	Flattens a tensor along the specified axis.
static CooVector	fromDense(Vector src)	Creates a sparse tensor from a dense tensor.
Double	get(int... indices)	Gets the element in this tensor at the specified indices.
protected CooVector	getSelf()	Simply returns a reference of 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)	Joins specified vector with this vector.
Vector	join(Vector b)	Joins specified vector with this vector.
CooCVector	join(CooCVector b)	Joins specified vector with this vector.
CooVector	join(CooVector b)	Joins specified vector with this vector.
int	length()	Gets the length of a vector.
protected CooCVector	makeComplexTensor(Shape shape, CNumber[] entries, int[][] indices)	A factory for creating a complex sparse tensor.
protected Vector	makeDenseTensor(Shape shape, double[] entries)	A factory for creating a real dense tensor.
protected CooVector	makeTensor(Shape shape, double[] entries, int[][] indices)	A factory for creating a real sparse tensor.
CooVector	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.
CooMatrix	repeat(int n, int axis)	Repeats a vector n times along a certain axis to create a matrix.
CooVector	reshape(Shape shape)	Copies and reshapes tensor if possible.
CooVector	set(double value, int... indices)	Sets an index of a copy of this vector to a specified value.
int	size()	gets the size of this vector.
void	sortIndices()	Sorts the indices of this tensor in lexicographical order while maintaining the associated value for each index.
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.
CooMatrix	stack(Vector b)	Stacks two vectors along columns as if they were row vectors.
CooMatrix	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.
CooMatrix	stack(CooVector b)	Stacks two vectors along columns as if they were row vectors.
CooMatrix	stack(CooVector b, int axis)	Stacks two vectors along specified axis.
Vector	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.
Vector	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 this vector and the specified vector.
CooVector	sub(CooVector B)	Computes the element-wise subtraction between two tensors of the same rank.
CVector	sub(CNumber a)	Subtracts a specified value from all entries of this tensor.
CooVector	T()	Computes the transpose of a tensor.
CooCVector	toComplex()	Converts this tensor to an equivalent complex tensor.
Vector	toDense()	Converts this sparse tensor to an equivalent dense tensor.
CooMatrix	toMatrix()	Converts this vector to an equivalent matrix as if it were a column vector.
CooMatrix	toMatrix(boolean columVector)	Converts a vector to an equivalent matrix representing either a row or column vector.
String	toString()	Formats this tensor as a human-readable string.
CooTensor	toTensor()	Converts this vector to an equivalent tensor.

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

abs, argMax, argMin, isNeg, isOnes, isPos, isZeros, max, maxAbs, min, minAbs, mult, mult, nonZeroEntries, recip, reshape, round, round, roundToZero, roundToZero, sqrt, 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.TensorOperationsMixin

transpose

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

CooVector

public CooVector(int size)

Creates a sparse 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.

CooVector

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

Creates a sparse 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. Indices are assumed to be sorted in lexicographical order but this is not enforced. However, many algorithms assume the indices to be sorted. If they are not, use

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.

CooVector

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

Creates a sparse vector of specified size along with non-zero entries and their indices.

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. Entries assumed to be sorted by indices (not enforced).

indices - Indices of the nonZero entries. Assumed to be sorted (not enforced).

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.

CooVector

public CooVector(CooVector a)

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

Parameters:

a - Sparse vector to copy

CooVector

public CooVector(int size,
 List<Double> 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.

set

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

Sets an index of a copy of this vector to a specified value. Creates a copy of this vector and sets an index to the specified value. Note, unlike the dense version of this method, this does not affect this vector.

Specified by:

set in interface TensorManipulationsMixin<CooVector>

Parameters:

value - Value to set.

indices - The index of for which to set the value.

Returns:

A copy of this vector with the specified index set to the specified value.

Throws:

IllegalArgumentException - If the number of indices provided is greater than 1.

IllegalArgumentException - If the index is negative or larger than the total vector size.

reshape

public CooVector 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<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 CooVector flatten()

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

Specified by:

flatten in interface TensorManipulationsMixin<CooVector>

Returns:

The flattened tensor.

join

public Vector join(Vector b)

Joins specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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)

Joins specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,CooCMatrix>

Parameters:

b - Vector to join with this vector.

Returns:

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

join

public CooVector join(CooVector b)

Joins specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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)

Joins specified vector with this vector.

Specified by:

join in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,CooCMatrix>

Parameters:

b - Vector to join with this vector.

Returns:

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

stack

public CooMatrix stack(Vector b)

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

Specified by:

stack in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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 CooMatrix stack(CooVector b)

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

Specified by:

stack in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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 CooMatrix 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<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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 CooMatrix 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<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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 Vector add(Vector B)

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

Specified by:

add in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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 CooVector add(CooVector B)

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

Specified by:

add in interface TensorOperationsMixin<CooVector,Vector,CooCVector,CVector,CooVector,Double>

Specified by:

add in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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.

add

public CVector add(CVector B)

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

Specified by:

add in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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 this vector and the specified vector.

Specified by:

add in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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.

sub

public Vector sub(Vector B)

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

Specified by:

sub in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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 Vector add(double a)

Adds specified value to all entries of this tensor.

Specified by:

add in interface TensorOperationsMixin<CooVector,Vector,CooCVector,CVector,CooVector,Double>

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. If zeros are introduced, they will be explicitly stored.

Specified by:

add in interface TensorOperationsMixin<CooVector,Vector,CooCVector,CVector,CooVector,Double>

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

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

Specified by:

sub in interface TensorOperationsMixin<CooVector,Vector,CooCVector,CVector,CooVector,Double>

Specified by:

sub in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,CooCMatrix>

Parameters:

B - Vector to subtract from this vector.

Returns:

The result of the element-wise vector subtraction.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

sub

public CVector sub(CVector B)

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

Specified by:

sub in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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(CooCVector B)

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

Specified by:

sub in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,CooCMatrix>

Parameters:

B - Vector to subtract from 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(double a)

Adds specified value to all entries of this tensor.

Specified by:

sub in interface TensorOperationsMixin<CooVector,Vector,CooCVector,CVector,CooVector,Double>

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<CooVector,Vector,CooCVector,CVector,CooVector,Double>

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.

elemMult

public CooVector elemMult(Vector B)

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

Specified by:

elemMult in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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.

div

public CooVector div(double divisor)

Computes the scalar division of a tensor.

Specified by:

div in interface TensorOperationsMixin<CooVector,Vector,CooCVector,CVector,CooVector,Double>

Overrides:

div in class RealSparseTensorBase<CooVector,Vector,CooCVector,CVector>

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<CooVector,Vector,CooCVector,CVector,CooVector,Double>

Overrides:

div in class RealSparseTensorBase<CooVector,Vector,CooCVector,CVector>

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.

T

public CooVector T()

Computes the transpose of a tensor. Same as TensorOperationsMixin.transpose(). Since a vector is a rank 1 tensor, this just * copies the vector.

Specified by:

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

Returns:

The transpose of this tensor.

get

public Double get(int... indices)

Gets the element in this tensor at the specified indices. This sparse vectors indices are assumed to be sorted lexicographically. If this is not the case call this.sparseSort() before calling this method.

Specified by:

get in interface TensorOperationsMixin<CooVector,Vector,CooCVector,CVector,CooVector,Double>

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

Creates a copy of this tensor.

Specified by:

copy in interface TensorOperationsMixin<CooVector,Vector,CooCVector,CVector,CooVector,Double>

Returns:

A copy of this tensor.

elemMult

public CooVector elemMult(CooVector B)

Computes the element-wise multiplication between two tensors.

Specified by:

elemMult in interface TensorOperationsMixin<CooVector,Vector,CooCVector,CVector,CooVector,Double>

Specified by:

elemMult in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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.

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<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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(CooCVector B)

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

Specified by:

elemMult in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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.

elemDiv

public CooVector elemDiv(Vector b)

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

Specified by:

elemDiv in interface TensorOperationsMixin<CooVector,Vector,CooCVector,CVector,CooVector,Double>

Specified by:

elemDiv in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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 (Hadamard multiplication) between this vector and a specified vector.

Specified by:

elemDiv in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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.

inner

public Double inner(Vector b)

Computes the inner product between two vectors.

Specified by:

inner in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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 Double inner(CooVector b)

Computes the inner product between two vectors.

Specified by:

inner in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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 CooVector normalize()

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

Specified by:

normalize in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,CooCMatrix>

Returns:

A unit vector with the same direction as this vector.

inner

public CNumber inner(CVector b)

Computes the inner product between two vectors.

Specified by:

inner in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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 Matrix outer(Vector b)

Computes the outer product of two vectors.

Specified by:

outer in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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 Matrix outer(CooVector b)

Computes the outer product of two vectors.

Specified by:

outer in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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. This sparse vectors indices are assumed to be sorted lexicographically. If this is not the case call this.sparseSort() before calling this method.

Specified by:

isParallel in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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 CooMatrix toMatrix()

Converts this vector to an equivalent matrix as if it were a column vector.

Specified by:

toMatrix in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,CooCMatrix>

Returns:

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

See Also:

• toMatrix(boolean)

toMatrix

public CooMatrix toMatrix(boolean columVector)

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

Specified by:

toMatrix in interface VectorOperationsMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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.

See Also:

• toMatrix()

toTensor

public CooTensor toTensor()

Converts this vector to an equivalent tensor.

Returns:

A tensor which is equivalent to this vector.

extend

public CooMatrix extend(int n,
 int axis)

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

Specified by:

extend in interface VectorManipulationsMixin<CooMatrix>

Parameters:

n - The number of times to extend this vector. Must be a positive value.

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.

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.

makeTensor

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

A factory for creating a real sparse tensor.

Specified by:

makeTensor in class RealSparseTensorBase<CooVector,Vector,CooCVector,CVector>

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.

makeDenseTensor

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

A factory for creating a real dense tensor.

Specified by:

makeDenseTensor in class RealSparseTensorBase<CooVector,Vector,CooCVector,CVector>

Parameters:

shape - Shape of the tensor to make.

entries - Entries of the dense tensor to make.

Returns:

A tensor created from the specified parameters.

makeComplexTensor

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

A factory for creating a complex sparse tensor.

Specified by:

makeComplexTensor in class RealSparseTensorBase<CooVector,Vector,CooCVector,CVector>

Parameters:

shape - Shape of the 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.

sortIndices

public void sortIndices()

Sorts the indices of this tensor in lexicographical order while maintaining the associated value for each index.

Specified by:

sortIndices in interface SparseTensorMixin

Overrides:

sortIndices in class RealSparseTensorBase<CooVector,Vector,CooCVector,CVector>

toComplex

public CooCVector toComplex()

Converts this tensor to an equivalent complex tensor. That is, the entries of the resultant tensor will be exactly the same value but will have type CNumber rather than Double.

Specified by:

toComplex in interface RealTensorMixin<CooVector,CooCVector>

Returns:

A complex matrix which is equivalent to this matrix.

flatten

public CooVector flatten(int axis)

Flattens a tensor along the specified axis. This simply copies the vector since it is rank 1.

Specified by:

flatten in interface TensorManipulationsMixin<CooVector>

Parameters:

axis - Axis along which to flatten tensor. Must be 0.

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<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,CooCMatrix>

Returns:

The number of total entries (including zeros) of this vector.

repeat

public CooMatrix repeat(int n,
 int axis)

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

Specified by:

repeat in interface VectorMixin<CooVector,Vector,CooVector,CooCVector,Double,CooMatrix,Matrix,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.

getSelf

protected CooVector getSelf()

Simply returns a reference of this tensor.

Specified by:

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

Returns:

A reference to this tensor.

allClose

public boolean allClose(CooVector 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<CooVector,Vector,CooCVector,CVector,CooVector,double[],Double>

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)

toDense

public Vector toDense()

Converts this sparse tensor to an equivalent dense tensor.

Specified by:

toDense in class SparseTensorBase<CooVector,Vector,CooCVector,CVector,CooVector,double[],Double>

Returns:

A dense tensor which is equivalent to this sparse tensor.

fromDense

public static CooVector fromDense(Vector 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.

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.