rustebra 0.3.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

mod r#static;
pub use self::r#static::StaticStorage;

#[cfg(feature = "alloc")]
mod dynamic;
#[cfg(feature = "alloc")]
pub use self::dynamic::DynamicStorage;

/// A fixed-layout collection of elements that algorithms in this crate read from.
///
/// Defines the minimal capability the algorithm layer needs: element access and a length,
/// independent of whether the backing memory lives on the stack or the heap. See ADR 0003 for
/// why this trait is kept intentionally minimal, and ADR 0006 for how it fits into the crate's
/// layered architecture.
///
/// # Examples
///
/// ```
/// use rustebra::storage::Storage;
///
/// fn first<S: Storage>(storage: &S) -> Option<&S::Item> {
///     storage.get(0)
/// }
/// ```
pub trait Storage {
    /// The type of element held by this storage.
    type Item;

    /// The number of elements in this storage.
    fn len(&self) -> usize;

    /// Returns `true` if this storage holds no elements.
    fn is_empty(&self) -> bool {
        self.len() == 0
    }

    /// Returns the element at `index`, or `None` if `index` is out of bounds.
    fn get(&self, index: usize) -> Option<&Self::Item>;
}