Struct ToeplitzMatrix 

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

Toeplitz matrix implementation

A Toeplitz matrix is represented by its first row and first column, where the first element of both row and column must be the same.

Implementations

impl<A> ToeplitzMatrix<A>

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

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

Create a new Toeplitz matrix from its first row and first column

The first element of the row and column must be the same.

Arguments

• first_row - First row of the Toeplitz matrix
• first_col - First column of the Toeplitz matrix

Returns

A new ToeplitzMatrix instance

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

Create a new square Toeplitz matrix that is symmetric

Arguments

• first_row - First row of the Toeplitz matrix, which also defines the first column

Returns

A new symmetric ToeplitzMatrix instance

pub fn from_parts( c: A, r: ArrayView1<'_, A>, l: ArrayView1<'_, A>, ) -> LinalgResult<Self>

Create a Toeplitz matrix from the central part of the first row and first column

This creates a Toeplitz matrix with rows and columns, where the central part is defined by c - which will form both the central part of the first row and first column.

Arguments

• c - Central part of the Toeplitz matrix
• r - Rest of the first row (excluding the first element)
• l - Rest of the first column (excluding the first element)

Returns

A new ToeplitzMatrix instance

Trait Implementations

impl<A> Clone for ToeplitzMatrix<A>

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A> Debug for ToeplitzMatrix<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 ToeplitzMatrix<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