linalgz 0.1.0

A simple linear algebra library for 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

//! Misc helper utilities.

use crate::Vector;

/// Asserts that the given vectors have the same length and panics otherwise.
///
/// # Example
///
/// ```
/// use linalgz::vector;
/// use linalgz::utils::*;
///
/// let v1 = vector![1, 2, 3];
/// let v2 = vector![4, 5, 6];
/// assert_lens(&v1, &v2)
/// ```
pub fn assert_lens<T>(left: &Vector<T>, right: &Vector<T>) {
    if left.len() != right.len() {
        panic!(
            "unequal vector lengths: left: {}, right: {}",
            left.len(),
            right.len()
        );
    }
}

/// Asserts that the given vector have the given length and panics otherwise.
///
/// # Example
///
/// ```
/// use linalgz::vector;
/// use linalgz::utils::*;
///
/// let v = vector![1, 2, 3];
/// assert_len(&v, 3)
/// ```
pub fn assert_len<T>(v: &Vector<T>, len: usize) {
    if v.len() != len {
        panic!("expecting vector length {} but got {}", v.len(), len);
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::vector;

    #[test]
    #[should_panic]
    fn unequal_lens() {
        let v1 = vector![1, 2, 3];
        let v2 = vector![1, 2, 3, 4];

        assert_lens(&v1, &v2)
    }

    #[test]
    #[should_panic]
    fn unexpected_len() {
        let v1 = vector![1, 2, 3];
        assert_len(&v1, 4);
    }
}