Struct UntypedArray 

pub struct UntypedArray { /* private fields */ }

A runtime-typed multi-dimensional array backed by a flat byte buffer.

Elements can be read and written as f64 regardless of the underlying storage dtype — the conversion is applied automatically.

Implementations

impl UntypedArray

pub fn new(shape: Vec<usize>, dtype_name: String) -> PyResult<Self>

Construct a zero-filled untyped array.

Arguments

• shape – logical dimensions.
• dtype_name – dtype string; one of: "float32", "f32", "float64", "f64", "int32", "i32", "int64", "i64", "bool", "b", "uint8", "u8", "int8", "i8".

pub fn dtype_name(&self) -> &str

Return the canonical dtype name.

pub fn itemsize(&self) -> usize

Return the byte size of a single element.

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

Return the logical shape.

pub fn ndim(&self) -> usize

Return the number of dimensions.

pub fn nbytes(&self) -> usize

Return the total byte size of the backing buffer.

pub fn size(&self) -> usize

Return the total number of elements (product of shape).

pub fn is_floating(&self) -> bool

Return true if the element dtype is a floating-point type.

pub fn is_integer(&self) -> bool

Return true if the element dtype is an integer type.

pub fn read_as_f64(&self, flat_index: usize) -> PyResult<f64>

Read element at flat_index and cast it to f64.

Returns PyIndexError if the index is out of bounds.

pub fn write_f64(&mut self, flat_index: usize, value: f64) -> PyResult<()>

Write value (as f64) to element at flat_index, casting to the array’s dtype.

Returns PyIndexError if the index is out of bounds.

Trait Implementations

impl DerefToPyAny for UntypedArray

impl ExtractPyClassWithClone for UntypedArray

impl<'py> IntoPyObject<'py> for UntypedArray

type Target = UntypedArray

The Python output type

type Output = Bound<'py, <UntypedArray 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 UntypedArray

const NAME: &str = "UntypedArray"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for UntypedArray

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 runtime-typed multi-dimensional array backed by a flat byte buffer. /// /// Elements can be read and written as `f64` regardless of the underlying /// storage dtype — the conversion is applied automatically.

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 = <<UntypedArray as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<UntypedArray>

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 UntypedArray

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

impl PyMethods<UntypedArray> for PyClassImplCollector<UntypedArray>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for UntypedArray

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.