nalgebra_latex 0.1.18

A library with several robust formatters for nalgebra::Matrix, LaTeX environments, and more
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

//! Module with types and traits for [`nalgebra_linsys`]

use nalgebra::{Matrix, Dim, RawStorage};

pub mod env;
pub mod err;
pub mod fmt;
pub mod numbering;
pub mod unknowns;

/// The type representing a [linear system], i.e. a system of simultaneous linear equations
///
/// # Example
///
/// ```
/// use nalgebra::{matrix, Const};
/// use nalgebra_latex::{
///     lin_sys::{
///         LinSys,
///         unknowns::SingleLetterBoldfaceVecOfUnknowns,
///         numbering::Numbering,
///         fmt::CasesLinSysFormatter,
///     },
///     fmt::{write_latex, LatexFormatter},
///     latex_modes::{InlineMathMode, DisplayMathMode, InnerParagraphMode},
/// };
///
/// let mut s = String::new();
/// let m = matrix!(
///     1,2,3,4;
///     5,6,7,8;
///     9,10,11,12;
/// );
/// let vec_of_unknowns = SingleLetterBoldfaceVecOfUnknowns::<_,{Numbering::OneBased}>::new('x', Const::<3>);
/// let ls = LinSys::new(m, vec_of_unknowns).unwrap();
/// write_latex::<CasesLinSysFormatter,InnerParagraphMode,InlineMathMode,_,_>(&mut s, &ls).unwrap();
/// assert_eq!(s, r"$\begin{cases}1x_{1}+2x_{2}+3x_{3}=4\\5x_{1}+6x_{2}+7x_{3}=8\\9x_{1}+10x_{2}+11x_{3}=12\end{cases}$");
/// ```
///
/// [linear system]: https://en.wikipedia.org/wiki/System_of_linear_equations
pub struct LinSys<T, R, C, S, U>
where
    U: unknowns::Unknowns,
    R: Dim,
    C: Dim,
    S: RawStorage<T, R, C>,
{
    /// Matrix representation of a [linear system]. For convenience, the field is of type [`nalgebra::Matrix`]
    ///
    /// [linear system]: https://en.wikipedia.org/wiki/System_of_linear_equations
    pub matrix: Matrix<T, R, C, S>,
    /// The unknowns over which the [linear system] is defined
    ///
    /// [linear system]: https://en.wikipedia.org/wiki/System_of_linear_equations
    pub unknowns: U,
}

impl<T, R, C, S, U> LinSys<T, R, C, S, U>
where
    U: unknowns::Unknowns,
    R: Dim,
    C: Dim,
    S: RawStorage<T, R, C>,
{
    pub fn new(mrls: Matrix<T, R, C, S>, unknowns: U) -> Option<Self> {
        match unknowns.len() {
            Ok(len) => if len != mrls.ncols() - 1 { return None },
            _ => ()
        };
        Some(LinSys {
            matrix: mrls,
            unknowns,
        })
    }
}