Struct NdArrayWrapper 

pub struct NdArrayWrapper { /* private fields */ }

A concrete array type implementing the NumPy __array__ and __array_interface__ protocols.

Wraps an owned flat Vec<f64> buffer with a logical shape, and exposes it to NumPy via the array interface protocol.

Implementations

impl NdArrayWrapper

pub fn new(data: Vec<f64>, shape: Vec<usize>) -> PyResult<Self>

Construct a new NdArrayWrapper with C-contiguous strides.

Arguments

• data – flat element buffer; must have shape.iter().product::<usize>() elements.
• shape – logical dimensions.

pub fn array_method(&self, py: Python<'_>) -> PyResult<Py<PyAny>>

Return a Python representation suitable for numpy consumption.

Calls numpy.array(list_of_floats).reshape(shape) so that consumers that call np.asarray(obj) or np.array(obj.__array__()) obtain the correct array.

Note: requires NumPy to be installed in the active Python environment.

pub fn array_interface(&self, py: Python<'_>) -> PyResult<Py<PyAny>>

The __array_interface__ property, returning a dict describing the buffer.

pub fn shape_tuple(&self, py: Python<'_>) -> Py<PyAny>

Return the shape as a Python tuple.

pub fn dtype_str(&self) -> &str

Return the dtype typestr (e.g. "<f8").

pub fn data(&self) -> Vec<f64>

Return a flat copy of the data buffer.

pub fn ndim(&self) -> usize

Return the number of dimensions.

Trait Implementations

impl ArrayProtocol for NdArrayWrapper

fn array_interface(&self) -> ArrayInterfaceDict

Returns the populated ArrayInterfaceDict for this object.

fn dtype_str(&self) -> &'static str

Returns the NumPy dtype type-string (e.g. "<f8" for little-endian f64).

fn shape(&self) -> Vec<usize>

Returns the logical shape of the array.

fn strides(&self) -> Vec<usize>

Returns the strides of the array in bytes.

fn data_ptr(&self) -> *const u8

Returns a raw pointer to the first byte of element data.

fn nbytes(&self) -> usize

Returns the total number of bytes occupied by the element buffer.

impl<'py> IntoPyObject<'py> for NdArrayWrapper

type Target = NdArrayWrapper

The Python output type

type Output = Bound<'py, <NdArrayWrapper as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for NdArrayWrapper

const NAME: &str = "NdArrayWrapper"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for NdArrayWrapper

const MODULE: Option<&str> = ::core::option::Option::None

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// A concrete array type implementing the NumPy `__array__` and /// `__array_interface__` protocols. /// /// Wraps an owned flat `Vec<f64>` buffer with a logical shape, and exposes /// it to NumPy via the array interface protocol.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<NdArrayWrapper as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<NdArrayWrapper>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for NdArrayWrapper

const TEXT_SIGNATURE: &'static str = "(data, shape)"

impl PyMethods<NdArrayWrapper> for PyClassImplCollector<NdArrayWrapper>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for NdArrayWrapper

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for NdArrayWrapper

impl ExtractPyClassWithClone for NdArrayWrapper