ndarrow 0.0.3

Zero-copy bridge between Apache Arrow and ndarray
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
94
95
96
97
98
99

//! # ndarrow
//!
//! Zero-copy bridge between [Apache Arrow](https://arrow.apache.org/) and
//! [ndarray](https://docs.rs/ndarray).
//!
//! ndarrow lets you move data between Arrow and ndarray with zero allocations
//! on the bridge path:
//!
//! - **Arrow → ndarray**: borrow Arrow buffers as ndarray views (O(1), no copy)
//! - **ndarray → Arrow**: transfer owned ndarray buffers into Arrow arrays (O(1), ownership move)
//!
//! # Quick Example
//!
//! ```
//! use arrow_array::Float64Array;
//! use ndarrow::{AsNdarray, IntoArrow};
//! use ndarray::Array1;
//!
//! // Arrow -> ndarray (zero-copy view)
//! let arrow_array = Float64Array::from(vec![1.0, 2.0, 3.0, 4.0]);
//! let view = arrow_array.as_ndarray().unwrap(); // ArrayView1<f64>, no allocation
//! assert_eq!(view[0], 1.0);
//!
//! // ndarray -> Arrow (zero-copy ownership transfer)
//! let result = Array1::from_vec(vec![5.0, 6.0, 7.0, 8.0]);
//! let arrow_result: Float64Array = result.into_arrow().unwrap();
//! assert_eq!(arrow_result.len(), 4);
//! ```
//!
//! # Null Handling
//!
//! Null semantics are explicit at the call site:
//!
//! ```
//! use arrow_array::Float64Array;
//! use ndarrow::AsNdarray;
//!
//! let array = Float64Array::from(vec![1.0, 2.0, 3.0]);
//!
//! // Validated: returns Err if nulls present (O(1) check)
//! let view = array.as_ndarray().unwrap();
//!
//! // Unchecked: caller guarantees no nulls (zero cost)
//! let view = unsafe { array.as_ndarray_unchecked() };
//!
//! // Masked: returns view + validity bitmap (zero allocation)
//! let (view, mask) = array.as_ndarray_masked();
//! ```
//!
//! # Performance Guarantee
//!
//! Bridge conversions are O(1) regardless of array size. The bridge creates views
//! (pointer + shape) or transfers buffer ownership. It never touches the data.

pub mod complex;
pub mod element;
pub mod error;
pub mod extensions;
pub mod helpers;
pub mod inbound;
pub mod outbound;
pub mod prelude;
pub mod sparse;
pub mod tensor;

// ─── Re-exports ───

pub use complex::{
    Complex32Extension, Complex32VariableShapeTensorIter, Complex64Extension,
    Complex64VariableShapeTensorIter, array1_complex32_to_extension, array1_complex64_to_extension,
    array2_complex32_to_fixed_size_list, array2_complex64_to_fixed_size_list,
    arrayd_complex32_to_fixed_shape_tensor, arrayd_complex64_to_fixed_shape_tensor,
    arrays_complex32_to_variable_shape_tensor, arrays_complex64_to_variable_shape_tensor,
    complex32_as_array_view1, complex32_as_array_view2,
    complex32_fixed_shape_tensor_as_array_viewd, complex32_variable_shape_tensor_iter,
    complex64_as_array_view1, complex64_as_array_view2,
    complex64_fixed_shape_tensor_as_array_viewd, complex64_variable_shape_tensor_iter,
};
pub use element::NdarrowElement;
pub use error::NdarrowError;
pub use extensions::{
    RegisteredExtension, deserialize_registered_extension, registered_extension_names,
};
pub use inbound::AsNdarray;
// Re-export free functions for FixedSizeList conversions.
pub use inbound::{
    fixed_size_list_as_array2, fixed_size_list_as_array2_masked,
    fixed_size_list_as_array2_unchecked,
};
pub use outbound::IntoArrow;
pub use sparse::{
    CsrMatrixBatchExtension, CsrMatrixBatchIter, CsrMatrixExtension, CsrMatrixMetadata, CsrView,
    csr_batch_to_extension_array, csr_matrix_batch_iter, csr_to_extension_array,
    csr_view_from_columns, csr_view_from_extension,
};
pub use tensor::{
    VariableShapeTensorIter, arrayd_to_fixed_shape_tensor, arrays_to_variable_shape_tensor,
    fixed_shape_tensor_as_array_viewd, variable_shape_tensor_iter,
};