opensrdk-linear-algebra 0.6.3

Standard linear algebra library using blas and lapack for OpenSRDK toolchain.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

use crate::matrix::ci::CirculantMatrix;
use crate::{matrix::MatrixError, number::Number};
use std::error::Error;

#[derive(Clone, Debug, Default, Hash)]
pub struct ToeplitzMatrix<T = f64>
where
    T: Number,
{
    dim: usize,
    row_elems: Vec<T>,
    col_elems: Vec<T>,
}

impl<T> ToeplitzMatrix<T>
where
    T: Number,
{
    /// must be row.len() - 1 = col.len()
    pub fn new(row_elems: Vec<T>, col_elems: Vec<T>) -> Result<Self, Box<dyn Error>> {
        let dim = row_elems.len();

        if col_elems.len() != dim.max(1) - 1 {
            return Err(MatrixError::DimensionMismatch.into());
        }

        Ok(Self {
            dim,
            row_elems,
            col_elems,
        })
    }

    pub fn dim(&self) -> usize {
        self.dim
    }

    pub fn row_elems(&self) -> &[T] {
        &self.row_elems
    }

    pub fn col_elems(&self) -> &[T] {
        &self.col_elems
    }

    pub fn eject(self) -> (Vec<T>, Vec<T>) {
        (self.row_elems, self.col_elems)
    }

    pub fn embedded_circulant(&self) -> CirculantMatrix<T> {
        let row = (0..self.dim)
            .into_iter()
            .chain((1..self.dim - 1).rev().into_iter())
            .map(|i| self.row_elems[i])
            .collect();

        CirculantMatrix::<T>::new(row)
    }
}