pub struct MaskedArray { /* private fields */ }Expand description
A masked array of f64 values.
Each element has an associated boolean mask value:
false→ element is valid and participates in computations.true→ element is masked (invalid) and is replaced byfill_valuewhen the filled view is requested.
Implementations§
Source§impl MaskedArray
impl MaskedArray
Sourcepub fn new(
data: Vec<f64>,
mask: Option<Vec<bool>>,
shape: Vec<usize>,
fill_value: Option<f64>,
) -> PyResult<Self>
pub fn new( data: Vec<f64>, mask: Option<Vec<bool>>, shape: Vec<usize>, fill_value: Option<f64>, ) -> PyResult<Self>
Construct a new masked array.
§Arguments
data– flat element buffer; length must equal the product ofshape.mask– optional flat mask; defaults to all-false(nothing masked).shape– logical shape; must have product equal todata.len().fill_value– value substituted for masked elements (default:f64::NAN).
Sourcepub fn mean(&self) -> Option<f64>
pub fn mean(&self) -> Option<f64>
Return the mean of unmasked elements, or None if all elements are masked.
Sourcepub fn fill_value(&self) -> f64
pub fn fill_value(&self) -> f64
Return the fill value used for masked positions.
Trait Implementations§
Source§impl<'py> IntoPyObject<'py> for MaskedArray
impl<'py> IntoPyObject<'py> for MaskedArray
Source§type Target = MaskedArray
type Target = MaskedArray
The Python output type
Source§type Output = Bound<'py, <MaskedArray as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <MaskedArray as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
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>
Performs the conversion.
Source§impl PyClass for MaskedArray
impl PyClass for MaskedArray
Source§impl PyClassImpl for MaskedArray
impl PyClassImpl for MaskedArray
Source§const MODULE: Option<&str> = ::core::option::Option::None
const MODULE: Option<&str> = ::core::option::Option::None
Module which the class will be associated with. Read more
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
#[pyclass(immutable_type)]
Source§const RAW_DOC: &'static CStr = /// A masked array of `f64` values.
///
/// Each element has an associated boolean mask value:
/// - `false` → element is valid and participates in computations.
/// - `true` → element is masked (invalid) and is replaced by `fill_value`
/// when the filled view is requested.
const RAW_DOC: &'static CStr = /// A masked array of `f64` values. /// /// Each element has an associated boolean mask value: /// - `false` → element is valid and participates in computations. /// - `true` → element is masked (invalid) and is replaced by `fill_value` /// when the filled view is requested.
Docstring for the class provided on the struct or enum. Read more
Source§const DOC: &'static CStr
const DOC: &'static CStr
Fully rendered class doc, including the
text_signature if a constructor is defined. Read moreSource§type Layout = <<MaskedArray as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<MaskedArray>
type Layout = <<MaskedArray as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<MaskedArray>
Description of how this class is laid out in memory
Source§type ThreadChecker = NoopThreadChecker
type ThreadChecker = NoopThreadChecker
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
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>
Source§fn dict_offset() -> Option<PyObjectOffset>
fn dict_offset() -> Option<PyObjectOffset>
Used to provide the dictoffset slot
(equivalent to tp_dictoffset)
Source§fn weaklist_offset() -> Option<PyObjectOffset>
fn weaklist_offset() -> Option<PyObjectOffset>
Used to provide the weaklistoffset slot
(equivalent to tp_weaklistoffset
Source§impl PyClassNewTextSignature for MaskedArray
impl PyClassNewTextSignature for MaskedArray
const TEXT_SIGNATURE: &'static str = "(data, mask, shape, fill_value)"
Source§impl PyMethods<MaskedArray> for PyClassImplCollector<MaskedArray>
impl PyMethods<MaskedArray> for PyClassImplCollector<MaskedArray>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for MaskedArray
impl PyTypeInfo for MaskedArray
Source§const NAME: &str = <Self as ::pyo3::PyClass>::NAME
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.
Source§const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE
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.
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
impl DerefToPyAny for MaskedArray
impl ExtractPyClassWithClone for MaskedArray
Auto Trait Implementations§
impl Freeze for MaskedArray
impl RefUnwindSafe for MaskedArray
impl Send for MaskedArray
impl Sync for MaskedArray
impl Unpin for MaskedArray
impl UnsafeUnpin for MaskedArray
impl UnwindSafe for MaskedArray
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
Mutably borrows from an owned value. Read more
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>
Converts
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>
Converts
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>
Converts
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
👎Deprecated since 0.27.0:
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.
Name of self. This is used in error messages, for example.
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>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
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
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.