ferray-core 0.2.8

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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

// ferray-core: N-dimensional array type and foundational primitives
//
// This is the root crate for the ferray workspace. It provides NdArray<T, D>,
// the full ownership model (Array, ArrayView, ArrayViewMut, ArcArray, CowArray),
// the Element trait, DType system, FerrayError, and array introspection/iteration.
//
// ndarray is used internally but is NOT part of the public API.
//
// When the `no_std` feature is enabled, only the subset of functionality that
// does not depend on `std` or `ndarray` is compiled: DType, Element, FerrayError
// (simplified), dimension types (without ndarray conversions), constants, and
// layout enums. The full Array type and related features require `std`.

#![cfg_attr(feature = "no_std", no_std)]

#[cfg(feature = "no_std")]
extern crate alloc;

// Modules that work in both std and no_std modes
pub mod constants;
pub mod dimension;
pub mod dtype;
pub mod error;
pub mod layout;
pub mod record;

// Modules that require std (depend on ndarray or std-only features)
#[cfg(not(feature = "no_std"))]
pub mod array;
#[cfg(not(feature = "no_std"))]
pub mod buffer;
#[cfg(not(feature = "no_std"))]
pub mod creation;
#[cfg(not(feature = "no_std"))]
pub mod dynarray;
#[cfg(not(feature = "no_std"))]
pub mod indexing;
#[cfg(not(feature = "no_std"))]
pub mod manipulation;
#[cfg(not(feature = "no_std"))]
pub mod ops;
#[cfg(not(feature = "no_std"))]
pub mod prelude;

// Re-export key types at crate root for ergonomics (std only)
#[cfg(not(feature = "no_std"))]
pub use array::ArrayFlags;
#[cfg(not(feature = "no_std"))]
pub use array::aliases;
#[cfg(not(feature = "no_std"))]
pub use array::arc::ArcArray;
#[cfg(not(feature = "no_std"))]
pub use array::cow::CowArray;
#[cfg(not(feature = "no_std"))]
pub use array::display::{get_print_options, set_print_options};
#[cfg(not(feature = "no_std"))]
pub use array::owned::Array;
#[cfg(not(feature = "no_std"))]
pub use array::view::ArrayView;
#[cfg(not(feature = "no_std"))]
pub use array::view_mut::ArrayViewMut;

pub use dimension::{Axis, Dimension, Ix0, Ix1, Ix2, Ix3, Ix4, Ix5, Ix6, IxDyn};

#[cfg(feature = "const_shapes")]
pub use dimension::static_shape::{
    Assert, DefaultNdarrayDim, IsTrue, Shape1, Shape2, Shape3, Shape4, Shape5, Shape6,
    StaticBroadcast, StaticMatMul, StaticSize, static_reshape_array,
};

pub use dtype::{DType, Element, SliceInfoElem};

pub use error::{FerrayError, FerrayResult};

pub use layout::MemoryLayout;

#[cfg(not(feature = "no_std"))]
pub use buffer::AsRawBuffer;

#[cfg(not(feature = "no_std"))]
pub use dynarray::DynArray;

pub use record::FieldDescriptor;

// Re-export proc macros from ferray-core-macros.
// The derive macro FerrayRecord shares its name with the trait in record::FerrayRecord.
// Both are re-exported: the derive macro lives in macro namespace, the trait in type namespace.
pub use ferray_core_macros::{FerrayRecord, promoted_type, s};
pub use record::FerrayRecord;

// Kani formal verification harnesses (only compiled during `cargo kani`)
#[cfg(kani)]
mod verification_kani;