rustebra 0.4.0

A hybrid no_std/alloc linear algebra crate for Rust, scaling from embedded targets to dynamic Krylov subspace solvers.
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

use alloc::vec::Vec;

use super::Storage;

/// Heap-allocated [`Storage`] backed by a `Vec<T>`. Requires the `alloc` feature.
///
/// # Examples
///
/// ```
/// use rustebra::storage::{Storage, DynamicStorage};
///
/// let storage = DynamicStorage::new(vec![1, 2, 3]);
/// assert_eq!(storage.len(), 3);
/// assert_eq!(storage.get(1), Some(&2));
/// assert_eq!(storage.get(3), None);
/// ```
pub struct DynamicStorage<T> {
    data: Vec<T>,
}

impl<T> DynamicStorage<T> {
    /// Creates a new `DynamicStorage` from a `Vec` of elements.
    ///
    /// # Examples
    ///
    /// ```
    /// use rustebra::storage::DynamicStorage;
    ///
    /// let storage = DynamicStorage::new(vec![1, 2, 3]);
    /// ```
    pub fn new(data: Vec<T>) -> Self {
        Self { data }
    }
}

impl<T> Storage for DynamicStorage<T> {
    type Item = T;

    fn len(&self) -> usize {
        self.data.len()
    }

    fn get(&self, index: usize) -> Option<&T> {
        self.data.get(index)
    }
}

#[cfg(test)]
mod tests {
    use super::{DynamicStorage, Storage};

    #[test]
    fn len_and_is_empty() {
        let storage = DynamicStorage::new(vec![1, 2, 3]);
        assert_eq!(storage.len(), 3);
        assert!(!storage.is_empty());

        let empty: DynamicStorage<i32> = DynamicStorage::new(vec![]);
        assert_eq!(empty.len(), 0);
        assert!(empty.is_empty());
    }

    #[test]
    fn get_in_and_out_of_bounds() {
        let storage = DynamicStorage::new(vec![1, 2, 3]);
        assert_eq!(storage.get(0), Some(&1));
        assert_eq!(storage.get(2), Some(&3));
        assert_eq!(storage.get(3), None);
    }
}