scirs2_numpy/
lib.rs

1//! This crate provides Rust interfaces for [NumPy C APIs][c-api],
2//! especially for the [ndarray][ndarray] class.
3//!
4//! It uses [`pyo3`] for Rust bindings to CPython, and uses
5//! [`ndarray`] as the Rust matrix library.
6//!
7//! To resolve its dependency on NumPy, it calls `import numpy.core` internally.
8//! This means that this crate should work if you can use NumPy in your Python environment,
9//! e.g. after installing it by `pip install numpy`. It does not matter whether you use
10//! the system environment or a dedicated virtual environment.
11//!
12//! Loading NumPy is done automatically and on demand. So if it is not installed, the functions
13//! provided by this crate will panic instead of returning a result.
14//!
15#![cfg_attr(
16    feature = "nalgebra",
17    doc = "Integration with [`nalgebra`] is provided via an implementation of [`ToPyArray`] for [`nalgebra::Matrix`] to convert nalgebra matrices into NumPy arrays
18as well as the [`PyReadonlyArray::try_as_matrix`] and [`PyReadwriteArray::try_as_matrix_mut`] methods to treat NumPy array as nalgebra matrix slices.
19"
20)]
21//! # Example
22//!
23//! ```
24//! use numpy::pyo3::Python;
25//! use numpy::ndarray::array;
26//! use numpy::{ToPyArray, PyArray, PyArrayMethods};
27//!
28//! Python::attach(|py| {
29//!     let py_array = array![[1i64, 2], [3, 4]].to_pyarray(py);
30//!
31//!     assert_eq!(
32//!         py_array.readonly().as_array(),
33//!         array![[1i64, 2], [3, 4]]
34//!     );
35//! });
36//! ```
37//!
38#![cfg_attr(feature = "nalgebra", doc = "```")]
39#![cfg_attr(not(feature = "nalgebra"), doc = "```rust,ignore")]
40//! use numpy::pyo3::Python;
41//! use numpy::nalgebra::Matrix3;
42//! use numpy::{pyarray, ToPyArray, PyArrayMethods};
43//!
44//! Python::attach(|py| {
45//!     let py_array = pyarray![py, [0, 1, 2], [3, 4, 5], [6, 7, 8]];
46//!
47//!     let py_array_square;
48//!
49//!     {
50//!         let py_array = py_array.readwrite();
51//!         let mut na_matrix = py_array.as_matrix_mut();
52//!
53//!         na_matrix.add_scalar_mut(1);
54//!
55//!         py_array_square = na_matrix.pow(2).to_pyarray(py);
56//!     }
57//!
58//!     assert_eq!(
59//!         py_array.readonly().as_matrix(),
60//!         Matrix3::new(1, 2, 3, 4, 5, 6, 7, 8, 9)
61//!     );
62//!
63//!     assert_eq!(
64//!         py_array_square.readonly().as_matrix(),
65//!         Matrix3::new(30, 36, 42, 66, 81, 96, 102, 126, 150)
66//!     );
67//! });
68#![doc = "```"]
69//!
70//! [c-api]: https://numpy.org/doc/stable/reference/c-api
71//! [ndarray]: https://numpy.org/doc/stable/reference/arrays.ndarray.html
72#![deny(missing_docs)]
73
74pub mod array;
75mod array_like;
76pub mod array_protocol;
77pub mod borrow;
78pub mod convert;
79pub mod datetime;
80pub mod dlpack;
81mod dtype;
82mod error;
83pub mod masked;
84pub mod npyffi;
85mod slice_container;
86mod strings;
87mod structured;
88mod sum_products;
89pub mod untyped;
90mod untyped_array;
91
92pub use ndarray;
93pub use pyo3;
94
95#[cfg(feature = "nalgebra")]
96pub use nalgebra;
97
98pub use crate::array::{
99    get_array_module, PyArray, PyArray0, PyArray0Methods, PyArray1, PyArray2, PyArray3, PyArray4,
100    PyArray5, PyArray6, PyArrayDyn, PyArrayMethods,
101};
102pub use crate::array_like::{
103    AllowTypeChange, PyArrayLike, PyArrayLike0, PyArrayLike1, PyArrayLike2, PyArrayLike3,
104    PyArrayLike4, PyArrayLike5, PyArrayLike6, PyArrayLikeDyn, TypeMustMatch,
105};
106pub use crate::array_protocol::{
107    parse_typestr, register_array_protocol_module, ArrayInterfaceDict, ArrayProtocol,
108    ArrayProtocolError, NdArrayWrapper,
109};
110pub use crate::borrow::{
111    PyReadonlyArray, PyReadonlyArray0, PyReadonlyArray1, PyReadonlyArray2, PyReadonlyArray3,
112    PyReadonlyArray4, PyReadonlyArray5, PyReadonlyArray6, PyReadonlyArrayDyn, PyReadwriteArray,
113    PyReadwriteArray0, PyReadwriteArray1, PyReadwriteArray2, PyReadwriteArray3, PyReadwriteArray4,
114    PyReadwriteArray5, PyReadwriteArray6, PyReadwriteArrayDyn,
115};
116pub use crate::convert::{IntoPyArray, NpyIndex, ToNpyDims, ToPyArray};
117pub use crate::dlpack::{
118    dlpack_from_slice, dlpack_to_vec_f64, register_dlpack_module, validate_dlpack_tensor,
119    DLDataType, DLDataTypeCode, DLDevice, DLDeviceType, DLManagedTensor, DLPackCapsule, DLTensor,
120    DLTensorInfo, DlpackError,
121};
122pub use crate::dtype::{dtype, Complex32, Complex64, Element, PyArrayDescr, PyArrayDescrMethods};
123pub use crate::error::{BorrowError, FromVecError, NotContiguousError};
124pub use crate::masked::{masked_array, masked_less, register_masked_module, MaskedArray};
125pub use crate::npyffi::{PY_ARRAY_API, PY_UFUNC_API};
126pub use crate::strings::{PyFixedString, PyFixedUnicode};
127pub use crate::structured::{
128    register_structured_module, DtypeField, StructuredArray, StructuredDtype,
129};
130pub use crate::sum_products::{dot, einsum, inner};
131pub use crate::untyped::{register_untyped_module, UntypedArray};
132pub use crate::untyped_array::{PyUntypedArray, PyUntypedArrayMethods};
133
134pub use ndarray::{array, Ix1, Ix2, Ix3, Ix4, Ix5, Ix6, IxDyn};
135
136/// A prelude
137///
138/// The purpose of this module is to avoid direct imports of
139/// the method traits defined by this crate via a glob import:
140///
141/// ```
142/// # #![allow(unused_imports)]
143/// use numpy::prelude::*;
144/// ```
145pub mod prelude {
146    pub use crate::array::{PyArray0Methods, PyArrayMethods};
147    pub use crate::convert::{IntoPyArray, ToPyArray};
148    pub use crate::dtype::PyArrayDescrMethods;
149    pub use crate::untyped_array::PyUntypedArrayMethods;
150}
151
152#[cfg(doctest)]
153mod doctest {
154    macro_rules! doc_comment {
155        ($doc_string:expr, $mod_name:ident) => {
156            #[doc = $doc_string]
157            mod $mod_name {}
158        };
159    }
160    doc_comment!(include_str!("../README.md"), readme);
161}
162
163#[cold]
164#[inline(always)]
165fn cold() {}
166
167/// Create a [`PyArray`] with one, two or three dimensions.
168///
169/// This macro is backed by [`ndarray::array`].
170///
171/// # Example
172///
173/// ```
174/// use numpy::pyo3::Python;
175/// use numpy::ndarray::array;
176/// use numpy::{pyarray, PyArrayMethods};
177///
178/// Python::attach(|py| {
179///     let array = pyarray![py, [1, 2], [3, 4]];
180///
181///     assert_eq!(
182///         array.readonly().as_array(),
183///         array![[1, 2], [3, 4]]
184///     );
185/// });
186#[macro_export]
187macro_rules! pyarray {
188    ($py: ident, $([$([$($x:expr),* $(,)*]),+ $(,)*]),+ $(,)*) => {{
189        $crate::IntoPyArray::into_pyarray($crate::array![$([$([$($x,)*],)*],)*], $py)
190    }};
191    ($py: ident, $([$($x:expr),* $(,)*]),+ $(,)*) => {{
192        $crate::IntoPyArray::into_pyarray($crate::array![$([$($x,)*],)*], $py)
193    }};
194    ($py: ident, $($x:expr),* $(,)*) => {{
195        $crate::IntoPyArray::into_pyarray($crate::array![$($x,)*], $py)
196    }};
197}
scirs2_numpy/lib.rs

scirs2_numpy/
lib.rs
