gmatlib 0.2.0

Simple linear algebra in Rust and beyond!
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

use std::error::Error;
use std::fmt::{Debug, Display};

#[derive(Debug)]
pub struct MatrixAugmentationError
{
    pub a: usize,
    pub b: usize,
}
impl Display for MatrixAugmentationError
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result 
    {
        write!(
            f, "failed to augment matrix because they did not have the same number of rows. (A: {}, B: {})", 
            self.a, self.b
        )
    }
}
impl Error for MatrixAugmentationError {}

#[derive(Debug)]
pub struct MatrixSubsetError;
impl Display for MatrixSubsetError
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result 
    {
        write!(f, "failed to take subset of matrix because indices were backwards or out of bounds.")
    }
}
impl Error for MatrixSubsetError {}

#[derive(Debug)]
pub enum MatrixInversionError
{
    DeterminantWasZero,
    SingularValueWasZero,
    ZeroDuringInversion
}
impl Display for MatrixInversionError
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result
    {
        match self 
        {
            MatrixInversionError::DeterminantWasZero   => write!(f, "calculated a determinant of 0 while trying to invert matrix."),
            MatrixInversionError::SingularValueWasZero => write!(f, "matrix was zero matrix of size 1 x 1 and cannot be inverted."),
            MatrixInversionError::ZeroDuringInversion  => write!(f, "found a 0 value during the nxn matrix inversion process."),
        }
    }
}
impl Error for MatrixInversionError {}

#[derive(Debug)]
pub struct NonSquareMatrixError;
impl Display for NonSquareMatrixError
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result
    {
        write!(f, "could not perform operation because matrix did not have the same number of rows and columns.")
    }
}
impl Error for NonSquareMatrixError {}

#[derive(Debug)]
pub struct MatrixFromVecError;
impl Display for MatrixFromVecError
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "failed to construct Matrix<T> from Vec<T> because it was not of a len evenly divisible by the number of columns.")
    }
}
impl Error for MatrixFromVecError {}

#[derive(Debug)]
pub struct MatrixMultiplicationError;
impl Display for MatrixMultiplicationError
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "failed to multiply matrices because columns of left operand and rows of right operand were not equal.")
    }
}
impl Error for MatrixMultiplicationError {}