pub struct UntypedArray { /* private fields */ }Expand description
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§
Source§impl UntypedArray
impl UntypedArray
Sourcepub fn new(shape: Vec<usize>, dtype_name: String) -> PyResult<Self>
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".
Sourcepub fn dtype_name(&self) -> &str
pub fn dtype_name(&self) -> &str
Return the canonical dtype name.
Sourcepub fn is_floating(&self) -> bool
pub fn is_floating(&self) -> bool
Return true if the element dtype is a floating-point type.
Sourcepub fn is_integer(&self) -> bool
pub fn is_integer(&self) -> bool
Return true if the element dtype is an integer type.
Sourcepub fn read_as_f64(&self, flat_index: usize) -> PyResult<f64>
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.
Trait Implementations§
Source§impl<'py> IntoPyObject<'py> for UntypedArray
impl<'py> IntoPyObject<'py> for UntypedArray
Source§type Target = UntypedArray
type Target = UntypedArray
Source§type Output = Bound<'py, <UntypedArray as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <UntypedArray as IntoPyObject<'py>>::Target>
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Source§impl PyClass for UntypedArray
impl PyClass for UntypedArray
Source§impl PyClassImpl for UntypedArray
impl PyClassImpl for UntypedArray
Source§const MODULE: Option<&str> = ::core::option::Option::None
const MODULE: Option<&str> = ::core::option::Option::None
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
Source§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.
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.
Source§const DOC: &'static CStr
const DOC: &'static CStr
text_signature if a constructor is defined. Read moreSource§type Layout = <<UntypedArray as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<UntypedArray>
type Layout = <<UntypedArray as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<UntypedArray>
Source§type ThreadChecker = NoopThreadChecker
type ThreadChecker = NoopThreadChecker
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
PyAny by default, and when you declare
#[pyclass(extends=PyDict)], it’s PyDict.fn items_iter() -> PyClassItemsIter
fn lazy_type_object() -> &'static LazyTypeObject<Self>
Source§fn dict_offset() -> Option<PyObjectOffset>
fn dict_offset() -> Option<PyObjectOffset>
Source§fn weaklist_offset() -> Option<PyObjectOffset>
fn weaklist_offset() -> Option<PyObjectOffset>
Source§impl PyClassNewTextSignature for UntypedArray
impl PyClassNewTextSignature for UntypedArray
const TEXT_SIGNATURE: &'static str = "(shape, dtype_name)"
Source§impl PyMethods<UntypedArray> for PyClassImplCollector<UntypedArray>
impl PyMethods<UntypedArray> for PyClassImplCollector<UntypedArray>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for UntypedArray
impl PyTypeInfo for UntypedArray
Source§const NAME: &str = <Self as ::pyo3::PyClass>::NAME
const NAME: &str = <Self as ::pyo3::PyClass>::NAME
prefer using ::type_object(py).name() to get the correct runtime value
Source§const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE
const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE
prefer using ::type_object(py).module() to get the correct runtime value
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
impl DerefToPyAny for UntypedArray
impl ExtractPyClassWithClone for UntypedArray
Auto Trait Implementations§
impl Freeze for UntypedArray
impl RefUnwindSafe for UntypedArray
impl Send for UntypedArray
impl Sync for UntypedArray
impl Unpin for UntypedArray
impl UnsafeUnpin for UntypedArray
impl UnwindSafe for UntypedArray
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
self into an owned Python object, dropping type information.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
Source§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.