opensrdk_linear_algebra/matrix/to/
mod.rs

1use crate::matrix::ci::CirculantMatrix;
2use crate::{matrix::MatrixError, number::Number};
3use rayon::prelude::*;
4use serde::{Deserialize, Serialize};
5
6#[derive(Clone, Debug, Default, PartialEq, Hash, Serialize, Deserialize)]
7pub struct ToeplitzMatrix<T = f64>
8where
9    T: Number,
10{
11    col_elems: Vec<T>,
12    row_elems: Vec<T>,
13}
14
15impl<T> ToeplitzMatrix<T>
16where
17    T: Number,
18{
19    pub fn new(dim: usize) -> Self {
20        Self {
21            col_elems: vec![T::default(); dim],
22            row_elems: vec![T::default(); dim.max(1) - 1],
23        }
24    }
25
26    /// - `col_elems`: First column elements. The length must be `dimension`.
27    /// - `row_elems`: First roe elements without first element. The length must be `dimension - 1`.
28    pub fn from(col_elems: Vec<T>, row_elems: Vec<T>) -> Result<Self, MatrixError> {
29        let dim = col_elems.len();
30
31        if row_elems.len() != dim.max(1) - 1 {
32            return Err(MatrixError::DimensionMismatch);
33        }
34
35        Ok(Self {
36            col_elems,
37            row_elems,
38        })
39    }
40
41    /// Dimension.
42    pub fn dim(&self) -> usize {
43        self.col_elems.len()
44    }
45
46    /// First column elements.
47    pub fn col_elems(&self) -> &[T] {
48        &self.col_elems
49    }
50
51    /// First row elements.
52    pub fn row_elems(&self) -> &[T] {
53        &self.row_elems
54    }
55
56    /// Returns `(self.row_elems, self.col_elems)`
57    pub fn eject(self) -> (Vec<T>, Vec<T>) {
58        (self.row_elems, self.col_elems)
59    }
60
61    pub fn embedded_circulant(&self) -> CirculantMatrix<T> {
62        let col_elems = (0..self.dim())
63            .into_par_iter()
64            .chain((1..self.dim() - 1).into_par_iter().rev())
65            .map(|i| self.col_elems[i])
66            .collect();
67
68        CirculantMatrix::<T>::new(col_elems)
69    }
70}
opensrdk_linear_algebra/matrix/to/mod.rs

opensrdk_linear_algebra/matrix/to/
mod.rs
