Class AbstractDenseSemiringVector<T extends AbstractDenseSemiringVector<T,U,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,V extends Semiring<V>>

java.lang.Object

org.flag4j.arrays.backend.AbstractTensor<T,V[],V>

org.flag4j.arrays.backend.semiring_arrays.AbstractDenseSemiringTensor<T,V>

org.flag4j.arrays.backend.semiring_arrays.AbstractDenseSemiringVector<T,U,V>

Type Parameters:

T - Type of the vector.

U - Type of matrix equivalent to this vector.

V - Type of the field element of this vector.

All Implemented Interfaces:

Serializable, SemiringTensorMixin<T,T,V>, TensorOverSemiring<T,T,V[],V>, VectorMixin<T,U,U,V>

Direct Known Subclasses:

AbstractDenseRingVector, SemiringVector

public abstract class AbstractDenseSemiringVector<T extends AbstractDenseSemiringVector<T,U,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,V extends Semiring<V>>
extends AbstractDenseSemiringTensor<T,V>
implements VectorMixin<T,U,U,V>

The base class for all dense vectors whose data are Semiring elements.

Vectors are 1D tensors (i.e. rank 1 tensor).

AbstractDenseSemiringVector vectors have mutable AbstractTensor.data but a fixed AbstractTensor.shape.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final int	size	The size of this vector.

Fields inherited from class org.flag4j.arrays.backend.semiring_arrays.AbstractDenseSemiringTensor

zeroElement

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

data, rank, shape

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDenseSemiringVector(Shape shape, V[] data)	Constructs a dense semiring vector with the specified data and shape.

Method Summary

Modifier and Type	Method	Description
V	dot(T b)	Computes the dot product between two vectors.
V	get(int idx)	Gets the element of this vector at the specified index.
V	inner(T b)	Computes the inner product between two vectors.
T	join(T b)	Joints specified vector with this vector.
int	length()	Gets the length of a vector.
V	mag()	Computes the magnitude of this vector.
protected abstract U	makeLikeMatrix(Shape shape, V[] entries)	Constructs a matrix of similar type to this vector with the specified shape and data.
abstract T	makeLikeTensor(V[] entries)	Constructs a dense vector with the specified data of the same type as the vector.
T	normalize()	Normalizes this vector to a unit length vector.
U	outer(T b)	Computes the outer product of two vectors.
U	repeat(int n, int axis)	Repeats a vector n times along a certain axis to create a matrix.
U	stack(T b, int axis)	Stacks two vectors along specified axis.
U	toMatrix(boolean columVector)	Converts a vector to an equivalent matrix representing either a row or column vector.

Methods inherited from class org.flag4j.arrays.backend.semiring_arrays.AbstractDenseSemiringTensor

add, addEq, argmax, argmin, copy, elemMult, flatten, flatten, get, getZeroElement, makeLikeCooTensor, max, min, reshape, set, setZeroElement, T, T, tensorDot, tensorTr, toCoo, toCoo

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

getData, getRank, getShape, makeLikeTensor, reshape, sameShape, T, totalEntries

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flag4j.arrays.backend.semiring_arrays.SemiringTensorMixin

add, addEq, isOnes, isZeros, makeEmptyDataArray, mult, multEq, prod, sum

Methods inherited from interface org.flag4j.arrays.backend.semiring_arrays.TensorOverSemiring

getData, getRank, getShape, makeLikeTensor, tensorDot, tensorDot, tensorDot, tensorTr

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

size, stack, toMatrix

Field Details

size

public final int size

The size of this vector. This is the total number of data stored in this vector.

Constructor Details

AbstractDenseSemiringVector

protected AbstractDenseSemiringVector(Shape shape,
 V[] data)

Constructs a dense semiring vector with the specified data and shape.

Parameters:

shape - Shape of this tensor.

data - Entries of this tensor. If this tensor is dense, this specifies all data within the tensor. If this tensor is sparse, this specifies only the non-zero data of the tensor.

Throws:

LinearAlgebraException - If shape.getRank() != 1.

Method Details

makeLikeTensor

public abstract T makeLikeTensor(V[] entries)

Constructs a dense vector with the specified data of the same type as the vector.

Parameters:

entries - Entries of the dense vector to construct.

makeLikeMatrix

protected abstract U makeLikeMatrix(Shape shape,
 V[] entries)

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

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

join

public T join(T b)

Joints specified vector with this vector. That is, creates a vector of length this.length() + b.length() containing first the elements of this vector followed by the elements of b.

Specified by:

join in interface VectorMixin<T extends AbstractDenseSemiringVector<T,U,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,V extends Semiring<V>>

Parameters:

b - Vector to join with this vector.

Returns:

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

inner

public V inner(T b)

Computes the inner product between two vectors.

Specified by:

inner in interface VectorMixin<T extends AbstractDenseSemiringVector<T,U,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,V extends Semiring<V>>

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

See Also:

• dot(AbstractDenseSemiringVector)

dot

public V dot(T b)

Computes the dot product between two vectors.

Note: this method is distinct from inner(AbstractDenseSemiringVector). The inner product is equivalent to the dot product of this tensor with the conjugation of b.

Specified by:

dot in interface VectorMixin<T extends AbstractDenseSemiringVector<T,U,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,V extends Semiring<V>>

Parameters:

b - Second vector in the dot product.

Returns:

The dot product between this vector and the vector b.

Throws:

IllegalArgumentException - If this vector and vector b do not have the same number of data.

See Also:

• inner(AbstractDenseSemiringVector)

length

public int length()

Gets the length of a vector. Same as VectorMixin.size().

Specified by:

length in interface VectorMixin<T extends AbstractDenseSemiringVector<T,U,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,V extends Semiring<V>>

Returns:

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

repeat

public U repeat(int n,
 int axis)

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

Specified by:

repeat in interface VectorMixin<T extends AbstractDenseSemiringVector<T,U,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,V extends Semiring<V>>

Parameters:

n - Number of times to repeat vector. Must be positive.

axis - Axis along which to repeat vector. Must be either 1 or 0.

• If axis=0, then the vector will be treated as a row vector and stacked vertically n times.
• If axis=1 then the vector will be treated as a column vector and stacked horizontally n times.

Returns:

A matrix whose rows/columns are this vector repeated.

stack

public U stack(T 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 VectorMixin<T extends AbstractDenseSemiringVector<T,U,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,V extends Semiring<V>>

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 data in this vector is different from the number of data in the vector b.

IllegalArgumentException - If axis is not either 0 or 1.

outer

public U outer(T b)

Computes the outer product of two vectors.

Specified by:

outer in interface VectorMixin<T extends AbstractDenseSemiringVector<T,U,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,V extends Semiring<V>>

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

toMatrix

public U toMatrix(boolean columVector)

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

Specified by:

toMatrix in interface VectorMixin<T extends AbstractDenseSemiringVector<T,U,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,V extends Semiring<V>>

Parameters:

columVector - Flag indicating 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.

normalize

public T normalize()

Normalizes this vector to a unit length vector.

Specified by:

normalize in interface VectorMixin<T extends AbstractDenseSemiringVector<T,U,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,V extends Semiring<V>>

Returns:

This vector normalized to a unit length.

mag

public V mag()

Computes the magnitude of this vector.

Specified by:

mag in interface VectorMixin<T extends AbstractDenseSemiringVector<T,U,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,V extends Semiring<V>>

Returns:

The magnitude of this vector.

get

public V get(int idx)

Gets the element of this vector at the specified index.

Specified by:

get in interface VectorMixin<T extends AbstractDenseSemiringVector<T,U,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,U extends AbstractDenseSemiringMatrix<U,T,V>,V extends Semiring<V>>

Parameters:

idx - Index of the element to get within this vector.

Returns:

The element of this vector at index idx.