Module flag4j

Package org.flag4j.arrays.dense

Class CVector

java.lang.Object

org.flag4j.arrays.backend.AbstractTensor<CVector,Field<Complex128>[],Complex128>

org.flag4j.arrays.backend.TensorOverSemiRing<CVector,CVector,Field<Complex128>[],Complex128>

org.flag4j.arrays.backend.TensorOverRing<CVector,CVector,Field<Complex128>[],Complex128>

org.flag4j.arrays.backend.TensorOverField<CVector,CVector,Field<Complex128>[],Complex128>

org.flag4j.arrays.backend.FieldTensorBase<CVector,CVector,Complex128>

org.flag4j.arrays.backend.DenseFieldVectorBase<CVector,CMatrix,CooCVector,Complex128>

org.flag4j.arrays.dense.CVectorOld

All Implemented Interfaces:

Serializable, DenseTensorMixin<CVector,CooCVector>, DenseVectorMixin<CVector,CooCVector,CMatrix,Field<Complex128>[],Complex128>, TensorBinaryOpsMixin<CVector,CVector>, TensorMixin<CVector,Field<Complex128>[],Complex128>, VectorMatrixOpsMixin<CVector,CMatrix,CMatrix>, VectorMixinOld<CVector,CMatrix,CMatrix,Field<Complex128>[],Complex128>

public class CVector
extends DenseFieldVectorBase<CVector,CMatrix,CooCVector,Complex128>

A complex dense vector whose entries are Complex128's.

A vector is essentially equivalent to a rank 1 tensor but has some extended functionality and may have improved performance for some operations.

CVector's have mutable entries but a fixed size.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.flag4j.arrays.backend.DenseFieldVectorBase

size

Fields inherited from class org.flag4j.arrays.backend.AbstractTensor

entries, rank, shape

Constructor Summary

Constructors

Constructor	Description
CVector(double... entries)	Creates a complex vector with the specified entries.
CVector(int size)	Creates a complex zero vector with the specified size.
CVector(int... entries)	Creates a complex vector with the specified entries.
CVector(int size, double fillValue)	Creates a complex vector with the specified size and filled with fillValue.
CVector(int size, Complex128 fillValue)	Creates a complex vector with the specified size and filled with fillValue.
CVector(int size, Complex64 fillValue)	Creates a complex vector with the specified size and filled with fillValue.
CVector(Complex64... entries)	Creates a complex vector with the specified entries.
CVector(Field<Complex128>... entries)	Creates a complex vector with the specified entries.
CVector(CVector vector)	Creates a copy of the provided vector.

Method Summary

Modifier and Type	Method	Description
CVector	add(Complex128 b)	Adds a complex-valued scalar to each entry of this vector.
CVector	add(Vector b)	Adds a complex dense vector to this vector.
CVector	add(CooCVector b)	Adds a complex sparse vector to this vector.
CVector	add(CooVector b)	Adds a real sparse vector to this vector.
void	addEq(double b)	Adds a scalar value to each entry of this tensor and stores the result in this tensor.
void	addEq(Vector b)	Computes the element-wise sum between two tensors and stores the result in this tensor.
CVector	div(Vector b)	Computes the element-wise quotient of this vector and a complex dense vector.
CVector	elemMult(Vector b)	Computes the element-wise product of this vector and a complex dense vector.
CooCVector	elemMult(CooCVector b)	Computes the element-wise product of this vector and a complex sparse vector.
CooCVector	elemMult(CooVector b)	Computes the element-wise product of this vector and a real sparse vector.
static CVector	getEmpty(int size)	Constructs an empty complex vector with the specified size.
double	innerSelf()	Computes the inner product between this vector and itself.
CMatrix	makeLikeMatrix(Shape shape, Field<Complex128>[] entries)	Constructs a matrix of similar type to this vector with the specified shape and entries.
CVector	makeLikeTensor(int size, Complex128 fillValue)	Creates a vector with the specified size filled with the fillValue.
CVector	makeLikeTensor(Field<Complex128>... entries)	Creates a vector with the specified entries.
CVector	makeLikeTensor(Shape shape, Field<Complex128>[] entries)	Constructs a tensor of the same type as this tensor with the given the shape and entries.
CooCVector	makeSparseVector(int size, List<Field<Complex128>> entries, List<Integer> indices)	Constructs a sparse vector of similar type to this dense vector.
CVector	round()	Rounds this tensor to the nearest whole number.
CVector	round(int precision)	Rounds a matrix to the nearest whole number.
CVector	roundToZero()	Rounds values which are close to zero in absolute value to zero.
CVector	roundToZero(double threshold)	Rounds values which are close to zero in absolute value to zero.
CVector	set(double val, int index)	Sets a value of this vector to val.
CVector	sub(Vector b)	Subtracts a complex dense vector from this vector.
CVector	sub(CooCVector b)	Subtracts a complex sparse vector from this vector.
CVector	sub(CooVector b)	Subtracts a real sparse vector from this vector.
void	subEq(double b)	Subtracts a scalar from each entry of this tensor.
void	subEq(Vector b)	Computes the element-wise difference between two tensors and stores the result in this tensor.
Vector	toReal()	Converts this complex vector to a real vector.
String	toString()	Generates a human-readable string representation of this vector.

Methods inherited from class org.flag4j.arrays.backend.DenseFieldVectorBase

abs, addEq, allClose, cross, div, divEq, dot, elemMultEq, equals, H, H, inner, isParallel, isPerp, join, length, norm, norm, normalize, outer, repeat, set, stack, stack, subEq, T, T, tensorDot, tensorDot, toCoo, toMatrix

Methods inherited from class org.flag4j.arrays.backend.FieldTensorBase

add, add, addEq, conj, copy, div, div, divEq, elemMult, flatten, flatten, get, getZeroElement, H, isOnes, isZeros, mult, mult, multEq, prod, recip, reshape, setZeroElement, sqrt, sub, sub, sub, subEq, sum, T, tensorTr

Methods inherited from class org.flag4j.arrays.backend.TensorOverSemiRing

tensorDot, tensorDot, tensorTr

Methods inherited from class org.flag4j.arrays.backend.AbstractTensor

getEntries, getRank, getShape, reshape, sameShape, totalEntries

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flag4j.arrays.backend.DenseTensorMixin

allClose

Methods inherited from interface org.flag4j.arrays.backend.TensorMixin

copy, get, getEntries, getRank, getShape, T

Methods inherited from interface org.flag4j.arrays.backend.VectorMatrixOpsMixin

toMatrix

Methods inherited from interface org.flag4j.arrays.backend.VectorMixinOld

size

Constructor Details

CVector

public CVector(Field<Complex128>... entries)

Creates a complex vector with the specified entries.

Parameters:

entries - Entries of this vector.

CVector

public CVector(Complex64... entries)

Creates a complex vector with the specified entries.

Parameters:

entries - Entries of this vector.

CVector

public CVector(double... entries)

Creates a complex vector with the specified entries.

Parameters:

entries - Entries of this vector.

CVector

public CVector(int... entries)

Creates a complex vector with the specified entries.

Parameters:

entries - Entries of this vector.

CVector

public CVector(int size,
 Complex128 fillValue)

Creates a complex vector with the specified size and filled with fillValue.

Parameters:

size - The size of the vector.

fillValue - The value to fill the vector with.

CVector

public CVector(int size,
 Complex64 fillValue)

Creates a complex vector with the specified size and filled with fillValue.

Parameters:

size - The size of the vector.

fillValue - The value to fill the vector with.

CVector

public CVector(int size,
 double fillValue)

Creates a complex vector with the specified size and filled with fillValue.

Parameters:

size - The size of the vector.

fillValue - The value to fill the vector with.

CVector

public CVector(int size)

Creates a complex zero vector with the specified size.

Parameters:

size - The size of the vector.

CVector

public CVector(CVector vector)

Creates a copy of the provided vector.

Parameters:

vector - Vector to create a copy of.

Method Details

getEmpty

public static CVector getEmpty(int size)

Constructs an empty complex vector with the specified size. The entries of the resulting vector will be null.

Parameters:

size - The size of the vector.

Returns:

An empty complex vector with the specified size.

makeLikeTensor

public CVector makeLikeTensor(int size,
 Complex128 fillValue)

Creates a vector with the specified size filled with the fillValue.

Specified by:

makeLikeTensor in class DenseFieldVectorBase<CVector,CMatrix,CooCVector,Complex128>

Parameters:

size -

fillValue - Value to fill this vector with.

makeLikeTensor

public CVector makeLikeTensor(Field<Complex128>... entries)

Creates a vector with the specified entries.

Specified by:

makeLikeTensor in class DenseFieldVectorBase<CVector,CMatrix,CooCVector,Complex128>

Parameters:

entries - Entries of this vector.

makeLikeMatrix

public CMatrix makeLikeMatrix(Shape shape,
 Field<Complex128>[] entries)

Constructs a matrix of similar type to this vector with the specified shape and entries.

Specified by:

makeLikeMatrix in class DenseFieldVectorBase<CVector,CMatrix,CooCVector,Complex128>

Parameters:

shape - Shape of the matrix to construct.

entries - Entries of the matrix to construct.

Returns:

A matrix of similar type to this vector with the specified shape and entries.

makeSparseVector

public CooCVector makeSparseVector(int size,
 List<Field<Complex128>> entries,
 List<Integer> indices)

Constructs a sparse vector of similar type to this dense vector.

Specified by:

makeSparseVector in class DenseFieldVectorBase<CVector,CMatrix,CooCVector,Complex128>

Parameters:

size - The size of the sparse vector.

entries - The non-zero entries of the sparse vector.

indices - The non-zero indices of the sparse vector.

Returns:

A sparse vector of similar type to this dense vector with the specified size, entries, and indices.

makeLikeTensor

public CVector makeLikeTensor(Shape shape,
 Field<Complex128>[] entries)

Constructs a tensor of the same type as this tensor with the given the shape and entries.

Specified by:

makeLikeTensor in interface TensorMixin<CVector,Field<Complex128>[],Complex128>

Specified by:

makeLikeTensor in class AbstractTensor<CVector,Field<Complex128>[],Complex128>

Parameters:

shape - Shape of the tensor to construct.

entries - Entries of the tensor to construct.

Returns:

A tensor of the same type as this tensor with the given the shape and entries.

innerSelf

public double innerSelf()

Computes the inner product between this vector and itself.

Returns:

The inner product between this vector and itself.

toReal

public Vector toReal()

Converts this complex vector to a real vector. This is done by ignoring the imaginary component of all entries.

Returns:

A real vector containing the real components of this complex vectors entries.

add

public CVector add(Vector b)

Adds a complex dense vector to this vector.

Parameters:

b - Complex dense vector in the sum.

Returns:

The sum of this vector and b.

add

public CVector add(CooVector b)

Adds a real sparse vector to this vector.

Parameters:

b - The real sparse vector in the sum.

Returns:

The sum of this vector and b.

add

public CVector add(CooCVector b)

Adds a complex sparse vector to this vector.

Parameters:

b - The complex sparse vector in the sum.

Returns:

The sum of this vector and b.

add

public CVector add(Complex128 b)

Adds a complex-valued scalar to each entry of this vector.

Overrides:

add in class FieldTensorBase<CVector,CVector,Complex128>

Parameters:

b - The scalar value in the sum.

Returns:

The sum of this vector's entries with the scalar value b.

sub

public CVector sub(Vector b)

Subtracts a complex dense vector from this vector.

Parameters:

b - Complex dense vector in the difference.

Returns:

The difference of this vector and b.

sub

public CVector sub(CooVector b)

Subtracts a real sparse vector from this vector.

Parameters:

b - The real sparse vector in the difference.

Returns:

The difference of this vector and b.

sub

public CVector sub(CooCVector b)

Subtracts a complex sparse vector from this vector.

Parameters:

b - The complex sparse vector in the difference.

Returns:

The difference of this vector and b.

subEq

public void subEq(double b)

Subtracts a scalar from each entry of this tensor. The result is stored in this tensor.

Parameters:

b - The scalar to subtract from each entry of this tensor.

elemMult

public CVector elemMult(Vector b)

Computes the element-wise product of this vector and a complex dense vector.

Parameters:

b - The complex dense vector in the element-wise product.

Returns:

The element-wise product of this vector and b.

elemMult

public CooCVector elemMult(CooVector b)

Computes the element-wise product of this vector and a real sparse vector.

Parameters:

b - The real sparse vector in the element-wise product.

Returns:

The element-wise product of this vector and b.

elemMult

public CooCVector elemMult(CooCVector b)

Computes the element-wise product of this vector and a complex sparse vector.

Parameters:

b - The complex sparse vector in the element-wise product.

Returns:

The element-wise product of this vector and b.

div

public CVector div(Vector b)

Computes the element-wise quotient of this vector and a complex dense vector.

Parameters:

b - The complex dense vector in the element-wise quotient.

Returns:

The element-wise quotient of this vector and b.

round

public CVector round()

Rounds this tensor to the nearest whole number. If the tensor is complex, both the real and imaginary component will be rounded independently.

Returns:

A copy of this tensor with each entry rounded to the nearest whole number.

round

public CVector round(int precision)

Rounds a matrix to the nearest whole number. If the matrix is complex, both the real and imaginary component will be rounded independently.

Parameters:

precision - The number of decimal places to round to. This value must be non-negative.

Returns:

A copy of this matrix with rounded values.

Throws:

IllegalArgumentException - If precision is negative.

roundToZero

public CVector roundToZero()

Rounds values which are close to zero in absolute value to zero. If the tensor is complex, both the real and imaginary components will be rounded independently. By default, the values must be within Flag4jConstants.EPS_F64 of zero. To specify a threshold value see roundToZero(double).

Returns:

A copy of this tensor with rounded values.

roundToZero

public CVector roundToZero(double threshold)

Rounds values which are close to zero in absolute value to zero.

Parameters:

threshold - Threshold for rounding values to zero. That is, if a value in this matrix is less than the threshold in absolute value then it will be rounded to zero. This value must be non-negative.

Returns:

A copy of this matrix with rounded values.

Throws:

IllegalArgumentException - If threshold is negative.

subEq

public void subEq(Vector b)

Computes the element-wise difference between two tensors and stores the result in this tensor.

Parameters:

b - Second tensor in the element-wise difference.

Throws:

TensorShapeException - If this tensor and b do not have the same shape.

addEq

public void addEq(Vector b)

Computes the element-wise sum between two tensors and stores the result in this tensor.

Parameters:

b - Second tensor in the element-wise sum.

Throws:

TensorShapeException - If this tensor and b do not have the same shape.

set

public CVector set(double val,
 int index)

Sets a value of this vector to val.

Parameters:

val - Value to set.

index - Index of this vector to set to val.

Throws:

ArrayIndexOutOfBoundsException - If index is not within this vector.

addEq

public void addEq(double b)

Adds a scalar value to each entry of this tensor and stores the result in this tensor.

Parameters:

b - Scalar value in sum.

toString

public String toString()

Generates a human-readable string representation of this vector.

Overrides:

toString in class Object

Returns:

A human-readable string representation of this vector.