ferrum-numpy-interop 0.2.0

Python/NumPy interop via PyO3 and Arrow/Polars for ferrum
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

//! # ferrum-numpy-interop
//!
//! A companion crate providing zero-copy (where possible) conversions between
//! ferrum arrays and external array ecosystems:
//!
//! - **NumPy** (via PyO3) — feature `"python"`
//! - **Apache Arrow** — feature `"arrow"`
//! - **Polars** — feature `"polars"`
//!
//! All three backends are feature-gated and disabled by default. Enable them
//! in your `Cargo.toml`:
//!
//! ```toml
//! [dependencies.ferrum-numpy-interop]
//! version = "0.1"
//! features = ["arrow"]  # or "python", "polars"
//! ```
//!
//! ## Design principles
//!
//! 1. **Safety first** — every conversion validates dtypes and memory layout
//!    before returning. No silent reinterpretation of memory.
//! 2. **Zero-copy when possible** — C-contiguous arrays are shared without
//!    copying where the target format supports it.
//! 3. **Explicit errors** — dtype mismatches, null values, and unsupported
//!    types produce clear [`FerrumError`](ferrum_core::FerrumError) messages.

pub mod dtype_map;

#[cfg(feature = "python")]
pub mod numpy_conv;

#[cfg(feature = "arrow")]
pub mod arrow_conv;

#[cfg(feature = "polars")]
pub mod polars_conv;

// Re-export the main conversion traits at crate root for ergonomics.

#[cfg(feature = "arrow")]
pub use arrow_conv::{FromArrow, FromArrowBool, ToArrow, ToArrowBool};

#[cfg(feature = "polars")]
pub use polars_conv::{FromPolars, FromPolarsBool, ToPolars, ToPolarsBool};

#[cfg(feature = "python")]
pub use numpy_conv::{AsFerrum, IntoNumPy};