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

//! A library for creating, using, and printing matrices.
//! Matrices can be defined using the public struct, `mtrs::Matrix`, or the macro `matrix!`.
//! Currently the `Matrix` struct does not internally support floats. This may change in the future.
//! ```
//! #[macro_use] extern crate mtrs;
//! use mtrs::Matrix;
//!
//! fn main() {
//!     let matrix = matrix![f32; (2, 2); 1, 2; 3, 4.1];
//!     println!("{}", matrix.scalar_add(4.1));
//! }
//! ```
//! The `Matrix` struct supports addition, subtraction, and multiplication with eachother,
//! along with implementations for basic operations between a scalar value and a `Matrix`

extern crate num_traits;

mod impls;
mod macros;
mod math;
mod matrix;
mod size;

use num_traits::Num;

/// The main Matrix struct. Can be created in a variety of different ways.
/// ```
/// #[macro_use] extern crate mtrs;
/// use mtrs::Matrix;
///
/// // All of these create a 2 x 2 matrix.
///
/// // From a 2D vector
/// let matrix = Matrix::from_vec(2, vec![1, 2, 3, 4]);
/// // Identity matrix of i32
/// let matrix: Matrix<i32> = Matrix::identity(2);
/// // Matrix of ones
/// let matrix: Matrix<i32> = Matrix::ones(2);
/// // Matrix of zeros
/// let matrix: Matrix<i32> = Matrix::zeros(2);
/// // Matrix of `i32`s
/// let matrix = matrix![(2, 2); 1, 2, 3, 4];
/// // Matrix of `f64`s
/// let matrix = matrix![f64; (2, 2); 1, 2; 3, 4];
/// ```
#[derive(Clone, PartialEq, Debug)]
pub struct Matrix<T: Num> {
    /// The height of the matrix
    height: usize,

    /// The width of the matrix
    width: usize,

    /// The main body of the matrix, stored as a 2d array
    data: Vec<T>,
}

#[cfg(test)]
mod main_tests {
    use super::Matrix;

    #[test]
    fn test_values() {
        let matrix = Matrix::from_slice((2, 2), &[1, 2, 3, 4]);

        assert_eq!(matrix.height, 2);
        assert_eq!(matrix.width, 2);
        assert_eq!(matrix.data, vec![1, 2, 3, 4]);
    }
}