Crate numpy

Source
Expand description

This crate provides Rust interfaces for NumPy C APIs, especially for the ndarray class.

It uses [pyo3] for Rust bindings to CPython, and uses ndarray as the Rust matrix library.

To resolve its dependency on NumPy, it calls import numpy.core internally. This means that this crate should work if you can use NumPy in your Python environment, e.g. after installing it by pip install numpy. It does not matter whether you use the system environment or a dedicated virtual environment.

Loading NumPy is done automatically and on demand. So if it is not installed, the functions provided by this crate will panic instead of returning a result.

Integration with nalgebra is provided via an implementation of ToPyArray for nalgebra::Matrix to convert nalgebra matrices into NumPy arrays as well as the PyReadonlyArray::try_as_matrix and PyReadwriteArray::try_as_matrix_mut methods to treat NumPy array as nalgebra matrix slices.

§Example

use numpy::pyo3::Python;
use numpy::ndarray::array;
use numpy::{ToPyArray, PyArray, PyArrayMethods};

Python::with_gil(|py| {
    let py_array = array![[1i64, 2], [3, 4]].to_pyarray(py);

    assert_eq!(
        py_array.readonly().as_array(),
        array![[1i64, 2], [3, 4]]
    );
});
use numpy::pyo3::Python;
use numpy::nalgebra::Matrix3;
use numpy::{pyarray, ToPyArray, PyArrayMethods};

Python::with_gil(|py| {
    let py_array = pyarray![py, [0, 1, 2], [3, 4, 5], [6, 7, 8]];

    let py_array_square;

    {
        let py_array = py_array.readwrite();
        let mut na_matrix = py_array.as_matrix_mut();

        na_matrix.add_scalar_mut(1);

        py_array_square = na_matrix.pow(2).to_pyarray(py);
    }

    assert_eq!(
        py_array.readonly().as_matrix(),
        Matrix3::new(1, 2, 3, 4, 5, 6, 7, 8, 9)
    );

    assert_eq!(
        py_array_square.readonly().as_matrix(),
        Matrix3::new(30, 36, 42, 66, 81, 96, 102, 126, 150)
    );
});

Re-exports§

Modules§

Macros§

Structs§

Enums§

Traits§

Functions§

  • Ix1
    Create a one-dimensional index
  • Ix2
    Create a two-dimensional index
  • Ix3
    Create a three-dimensional index
  • Ix4
    Create a four-dimensional index
  • Ix5
    Create a five-dimensional index
  • Ix6
    Create a six-dimensional index
  • IxDyn
    Create a dynamic-dimensional index
  • dot
    Return the dot product of two arrays.
  • dot_boundDeprecated
    Deprecated name for dot.
  • dtype
    Returns the type descriptor (“dtype”) for a registered type.
  • dtype_boundDeprecated
    Deprecated name for dtype.
  • einsum
    Return the Einstein summation convention of given tensors.
  • einsum_boundDeprecated
    Deprecated name for einsum.
  • inner
    Return the inner product of two arrays.
  • inner_boundDeprecated
    Deprecated name for inner.

Type Aliases§