ferray-core 0.3.0

N-dimensional array type and foundational primitives for ferray
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

// ferray-core: Array module — NdArray<T, D> and ownership variants (REQ-1, REQ-3)
//
// NdArray wraps ndarray::ArrayBase internally. ndarray is NEVER part of the
// public API surface.

pub mod aliases;
pub mod arc;
pub mod cow;
pub mod display;
mod index_impl;
pub mod introspect;
pub mod iter;
pub mod methods;
pub mod owned;
pub mod reductions;
#[cfg(feature = "serde")]
mod serde_impl;
pub mod sort;
pub mod view;
pub mod view_mut;

/// Flags describing the memory properties of an array.
///
/// Mirrors `NumPy`'s `arr.flags` field: a flat collection of independent
/// boolean memory-layout properties. The names map 1:1 to `NumPy` and are
/// accessed individually by callers, so a bitfield-style enum would
/// hurt ergonomics rather than help.
#[allow(clippy::struct_excessive_bools)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ArrayFlags {
    /// Whether the data is C-contiguous (row-major).
    pub c_contiguous: bool,
    /// Whether the data is Fortran-contiguous (column-major).
    pub f_contiguous: bool,
    /// Whether the array owns its data.
    pub owndata: bool,
    /// Whether the array is writeable.
    pub writeable: bool,
}

// Re-export the main types at this module level for convenience.
pub use self::arc::ArcArray;
pub use self::cow::CowArray;
pub use self::owned::Array;
pub use self::view::ArrayView;
pub use self::view_mut::ArrayViewMut;