rmatrix_ks 0.4.0

matrix and some algebra in Rust
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

//! # Common
//!
//! common tools for matrix or vectors

use crate::error::IError;
use crate::error::IResult;
use crate::matrix::Matrix;
use crate::num::number::Zero;

/// generate points of matrix
///
/// ```rust
/// # use rmatrix_ks::utils::common::points;
/// # fn main() {
/// assert_eq!(vec![(2, 3), (2, 6), (4, 3), (4, 6)],
///     points(|x, y| (2 * x, 3 * y), 2, 2));
/// # }
/// ```
pub fn points<T, R>(
    mut f: impl FnMut(usize, usize) -> (T, R),
    row: usize,
    col: usize,
) -> Vec<(T, R)> {
    let mut ps = Vec::with_capacity(row * col);
    for r in 1..=row {
        for c in 1..=col {
            ps.push(f(r, c))
        }
    }
    ps
}

/// concatenate two matrices horizontally
///
/// ```rust
/// # use rmatrix_ks::matrix::Matrix;
/// # use rmatrix_ks::error::IResult;
/// # use rmatrix_ks::utils::common::horizontal_concat;
/// # fn main() -> IResult<()> {
/// let mat1: Matrix<i32> = Matrix::create(2, 3, vec![1, 2, 3, 4, 5, 6])?;
/// let mat2: Matrix<i32> = Matrix::create(2, 3, vec![1, 2, 3, 4, 5, 6])?;
/// assert_eq!(Matrix::create(2, 6, vec![1, 2, 3, 1, 2, 3, 4, 5, 6, 4, 5, 6])?,
///     horizontal_concat(&mat1, &mat2)?);
/// # Ok(())
/// # }
/// ```
pub fn horizontal_concat<T>(mat: &Matrix<T>, rhs: &Matrix<T>) -> IResult<Matrix<T>>
where
    T: Clone + Zero,
{
    if mat.row() != rhs.row() {
        Err(IError::IncompatibleShape(
            (mat.row(), rhs.column()),
            rhs.dim,
        ))
    } else {
        let mut hmat = Matrix::zeros(mat.row(), mat.column() + rhs.column())?;
        for r in 1..=mat.row() {
            for c1 in 1..=mat.column() {
                hmat.set_element(r, c1, mat.get_element(r, c1)?.clone())?;
            }

            for c2 in 1..=rhs.column() {
                hmat.set_element(r, mat.column() + c2, rhs.get_element(r, c2)?.clone())?;
            }
        }
        Ok(hmat)
    }
}

/// concatenate two matrices vertically
///
/// ```rust
/// # use rmatrix_ks::matrix::Matrix;
/// # use rmatrix_ks::utils::common::vertical_concat;
/// # use rmatrix_ks::error::IResult;
/// # fn main() -> IResult<()> {
/// let mat1: Matrix<i32> = Matrix::create(2, 3, vec![1, 2, 3, 4, 5, 6])?;
/// let mat2: Matrix<i32> = Matrix::create(2, 3, vec![1, 2, 3, 4, 5, 6])?;
/// assert_eq!(Matrix::create(4, 3, vec![1, 2, 3, 4, 5, 6, 1, 2, 3, 4, 5, 6])?,
///     vertical_concat(&mat1, &mat2)?);
/// # Ok(())
/// # }
/// ```
pub fn vertical_concat<T>(mat: &Matrix<T>, rhs: &Matrix<T>) -> IResult<Matrix<T>>
where
    T: Clone,
{
    Matrix::create(
        mat.row() + rhs.row(),
        mat.column(),
        [&mat.inner[..], &rhs.inner[..]].concat(),
    )
}

/// eigen values
///
/// **TODO**
pub fn eigen_values() {
    todo!()
}

/// solve linear equations
///
/// **TODO**
pub fn linear_solve() {
    todo!()
}

/// eigen vectors
///
/// **TODO**
pub fn eigen_system() {
    todo!()
}