Package org.flag4j.operations.sparse.coo.real_complex

Class RealComplexSparseVectorOperations

java.lang.Object

org.flag4j.operations.sparse.coo.real_complex.RealComplexSparseVectorOperations

public final class RealComplexSparseVectorOperations
extends Object

This class contains low level implementations of operations on a real sparse tensor and a complex sparse tensor.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RealComplexSparseVectorOperations()

Method Summary

Modifier and Type	Method	Description
static CVector	add(CooCVector src, double a)	Adds a real number to each entry of a sparse vector, including the zero entries.
static CooCVector	add(CooCVector src1, CooVector src2)	Computes the element-wise vector addition between a real sparse vector and a complex sparse vector.
static CVector	add(CooVector src, CNumber a)	Adds a real number to each entry of a sparse vector, including the zero entries.
static CooCVector	elemMult(CooCVector src1, CooVector src2)	Computes the element-wise vector multiplication between two real sparse vectors.
static CNumber	inner(CooCVector src1, CooVector src2)	Computes the inner product of a real and complex sparse vector.
static CNumber	inner(CooVector src1, CooCVector src2)	Computes the inner product of a real and complex sparse vector.
static CMatrix	outerProduct(CooCVector src1, CooVector src2)	Computes the vector outer product between a complex sparse vector and a real sparse vector.
static CMatrix	outerProduct(CooVector src1, CooCVector src2)	Computes the vector outer product between a complex sparse vector and a real sparse vector.
static CooCVector	sub(CooCVector src1, CooVector src2)	Computes the element-wise vector subtraction between a real sparse vector and a complex sparse vector.
static CooCVector	sub(CooVector src1, CooCVector src2)	Computes the element-wise vector subtraction between a real sparse vector and a complex sparse vector.
static CVector	sub(CooVector src, CNumber a)	Subtracts a real number from each entry of a sparse vector, including the zero entries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RealComplexSparseVectorOperations

private RealComplexSparseVectorOperations()

Method Details

add

public static CVector add(CooVector src,
 CNumber a)

Adds a real number to each entry of a sparse vector, including the zero entries.

Parameters:

src - Sparse vector to add value to.

a - Value to add to the src sparse vector.

Returns:

The result of adding the specified value to the sparse vector.

add

public static CVector add(CooCVector src,
 double a)

Adds a real number to each entry of a sparse vector, including the zero entries.

Parameters:

src - Sparse vector to add value to.

a - Value to add to the src sparse vector.

Returns:

The result of adding the specified value to the sparse vector.

sub

public static CVector sub(CooVector src,
 CNumber a)

Subtracts a real number from each entry of a sparse vector, including the zero entries.

Parameters:

src - Sparse vector to subtract value from.

a - Value to subtract from the src sparse vector.

Returns:

The result of subtracting the specified value from the sparse vector.

add

public static CooCVector add(CooCVector src1,
 CooVector src2)

Computes the element-wise vector addition between a real sparse vector and a complex sparse vector. Both sparse vectors are assumed to have their indices sorted lexicographically.

Parameters:

src1 - First sparse vector in the addition. Indices assumed to be sorted lexicographically.

src2 - Second sparse vector in the addition. Indices assumed to be sorted lexicographically.

Returns:

The result of the vector addition.

Throws:

IllegalArgumentException - If the two vectors do not have the same size (full size including zeros).

sub

public static CooCVector sub(CooCVector src1,
 CooVector src2)

Computes the element-wise vector subtraction between a real sparse vector and a complex sparse vector. Both sparse vectors are assumed to have their indices sorted lexicographically.

Parameters:

src1 - First sparse vector in the subtraction. Indices assumed to be sorted lexicographically.

src2 - Second sparse vector in the subtraction. Indices assumed to be sorted lexicographically.

Returns:

The result of the vector subtraction.

Throws:

IllegalArgumentException - If the two vectors do not have the same size (full size including zeros).

sub

public static CooCVector sub(CooVector src1,
 CooCVector src2)

Computes the element-wise vector subtraction between a real sparse vector and a complex sparse vector. Both sparse vectors are assumed to have their indices sorted lexicographically.

Parameters:

src1 - First sparse vector in the subtraction. Indices assumed to be sorted lexicographically.

src2 - Second sparse vector in the subtraction. Indices assumed to be sorted lexicographically.

Returns:

The result of the vector subtraction.

Throws:

IllegalArgumentException - If the two vectors do not have the same size (full size including zeros).

elemMult

public static CooCVector elemMult(CooCVector src1,
 CooVector src2)

Computes the element-wise vector multiplication between two real sparse vectors. Both sparse vectors are assumed to have their indices sorted lexicographically.

Parameters:

src1 - First sparse vector in the multiplication. Indices assumed to be sorted lexicographically.

src2 - Second sparse vector in the multiplication. Indices assumed to be sorted lexicographically.

Returns:

The result of the vector multiplication.

Throws:

IllegalArgumentException - If the two vectors do not have the same size (full size including zeros).

inner

public static CNumber inner(CooCVector src1,
 CooVector src2)

Computes the inner product of a real and complex sparse vector. Both sparse vectors are assumed to have their indices sorted lexicographically.

Parameters:

src1 - First sparse vector in the inner product. Indices assumed to be sorted lexicographically.

src2 - Second sparse vector in the inner product. Indices assumed to be sorted lexicographically.

Returns:

The result of the vector inner product.

Throws:

IllegalArgumentException - If the two vectors do not have the same size (full size including zeros).

inner

public static CNumber inner(CooVector src1,
 CooCVector src2)

Computes the inner product of a real and complex sparse vector. Both sparse vectors are assumed to have their indices sorted lexicographically.

Parameters:

src1 - First sparse vector in the inner product. Indices assumed to be sorted lexicographically.

src2 - Second sparse vector in the inner product. Indices assumed to be sorted lexicographically.

Returns:

The result of the vector inner product.

Throws:

IllegalArgumentException - If the two vectors do not have the same size (full size including zeros).

outerProduct

public static CMatrix outerProduct(CooCVector src1,
 CooVector src2)

Computes the vector outer product between a complex sparse vector and a real sparse vector.

Parameters:

src1 - Entries of the first sparse vector in the outer product.

src2 - Second sparse vector in the outer product.

Returns:

The matrix resulting from the vector outer product.

outerProduct

public static CMatrix outerProduct(CooVector src1,
 CooCVector src2)

Computes the vector outer product between a complex sparse vector and a real sparse vector.

Parameters:

src1 - Entries of the first sparse vector in the outer product.

src2 - Second sparse vector in the outer product.

Returns:

The matrix resulting from the vector outer product.