Struct CirculantMatrix 

pub struct CirculantMatrix<A>
where
    A: Float + NumAssign + Zero + Sum + One + ScalarOperand + Send + Sync + Debug,
{ /* private fields */ }

Circulant matrix implementation

A circulant matrix is completely defined by its first row. Each row is a cyclic shift of the previous row.

Implementations

impl<A> CirculantMatrix<A>

where A: Float + NumAssign + Zero + Sum + One + ScalarOperand + Send + Sync + Debug,

pub fn new(_firstrow: ArrayView1<'_, A>) -> LinalgResult<Self>

Create a new circulant matrix from its first row

Arguments

• first_row - The first row of the circulant matrix

Returns

A new CirculantMatrix instance

pub fn from_kernel(kernel: ArrayView1<'_, A>) -> LinalgResult<Self>

Create a new circulant matrix from a vector that will be used for circular convolution

Arguments

• kernel - The vector used for circular convolution

Returns

A new CirculantMatrix instance

pub fn first_row(&self) -> ArrayView1<'_, A>

Get a view of the first row of the circulant matrix

Returns

An ArrayView1 of the first row

pub fn size(&self) -> usize

Get the size of the circulant matrix

Returns

The size (number of rows/columns) of the matrix

Trait Implementations

impl<A> Clone for CirculantMatrix<A>

where A: Float + NumAssign + Zero + Sum + One + ScalarOperand + Send + Sync + Debug + Clone,

fn clone(&self) -> CirculantMatrix<A>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<A> Debug for CirculantMatrix<A>

where A: Float + NumAssign + Zero + Sum + One + ScalarOperand + Send + Sync + Debug + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<A> StructuredMatrix<A> for CirculantMatrix<A>

where A: Float + NumAssign + Zero + Sum + One + ScalarOperand + Send + Sync + Debug,

fn nrows(&self) -> usize

Returns the number of rows in the matrix

fn ncols(&self) -> usize

Returns the number of columns in the matrix

fn get(&self, i: usize, j: usize) -> LinalgResult<A>

Returns the element at position (i, j)

fn matvec(&self, x: &ArrayView1<'_, A>) -> LinalgResult<Array1<A>>

Multiply the matrix by a vector (matrix-vector product)

fn matvec_transpose(&self, x: &ArrayView1<'_, A>) -> LinalgResult<Array1<A>>

Multiply the transpose of the matrix by a vector

fn shape(&self) -> (usize, usize)

Returns the shape of the matrix as (rows, cols)

fn to_dense(&self) -> LinalgResult<Array2<A>>

Convert the structured matrix to a dense ndarray representation

fn to_operator(&self) -> LinearOperator<A>

where Self: Clone + Send + Sync + 'static,

Create a matrix-free operator from this structured matrix