Struct MaskedArray 

pub struct MaskedArray<T: Element, D: Dimension> { /* private fields */ }

A masked array that pairs data with a boolean mask.

Each element position has a corresponding mask bit:

• true means the element is masked (invalid / missing)
• false means the element is valid

All operations (arithmetic, reductions, ufuncs) respect the mask by skipping masked elements.

Implementations

impl<T, D> MaskedArray<T, D>

where T: Element + Copy, D: Dimension,

pub fn filled(&self, fill_value: T) -> FerrayResult<Array<T, D>>

Return a regular array with masked positions replaced by fill_value.

Unmasked positions retain their original data values.

Errors

Returns an error only for internal failures.

pub fn compressed(&self) -> FerrayResult<Array<T, Ix1>>

Return a 1-D array containing only the unmasked elements.

The order is the logical (row-major) iteration order of the original array, with masked elements removed.

Errors

Returns an error only for internal failures.

impl<T: Element, D: Dimension> MaskedArray<T, D>

pub fn harden_mask(&mut self) -> FerrayResult<()>

Harden the mask: prevent subsequent assignments from clearing mask bits.

After this call, any attempt to set a mask bit to false via set_mask_flat or set_mask will be silently ignored.

Errors

This function does not currently error but returns Result for API consistency.

pub fn soften_mask(&mut self) -> FerrayResult<()>

Soften the mask: allow subsequent assignments to clear mask bits.

Errors

This function does not currently error but returns Result for API consistency.

impl<T: Element, D: Dimension> MaskedArray<T, D>

pub fn new(data: Array<T, D>, mask: Array<bool, D>) -> FerrayResult<Self>

Create a new masked array from data and mask arrays.

Errors

Returns FerrayError::ShapeMismatch if data and mask shapes differ.

pub fn from_data(data: Array<T, D>) -> FerrayResult<Self>

Create a masked array with no masked elements (all-false mask).

Errors

Returns an error if the mask array cannot be created.

pub fn data(&self) -> &Array<T, D>

Return a reference to the underlying data array.

pub fn mask(&self) -> &Array<bool, D>

Return a reference to the mask array.

pub fn data_mut(&mut self) -> &mut Array<T, D>

Return a mutable reference to the underlying data array.

pub fn shape(&self) -> &[usize]

Return the shape of the masked array.

pub fn ndim(&self) -> usize

Return the number of dimensions.

pub fn size(&self) -> usize

Return the total number of elements (including masked).

pub fn dim(&self) -> &D

Return the dimension descriptor.

pub fn is_hard_mask(&self) -> bool

Return whether the mask is hardened.

pub fn set_mask_flat( &mut self, flat_idx: usize, value: bool, ) -> FerrayResult<()>

Set a mask value at a flat index.

If the mask is hardened, only true (masking) is allowed; attempts to clear a mask bit are silently ignored.

Errors

Returns FerrayError::IndexOutOfBounds if flat_idx >= size.

pub fn set_mask(&mut self, new_mask: Array<bool, D>) -> FerrayResult<()>

Replace the mask with a new one.

If the mask is hardened, only bits that are true in both the old and new masks (or newly set to true) are allowed; cleared bits are ignored.

Errors

Returns FerrayError::ShapeMismatch if shapes differ.

impl<T, D> MaskedArray<T, D>

where T: Element + Copy, D: Dimension,

pub fn count(&self) -> FerrayResult<usize>

Count the number of unmasked (valid) elements.

Errors

This function does not currently error but returns Result for API consistency.

impl<T, D> MaskedArray<T, D>

where T: Element + Float, D: Dimension,

pub fn sum(&self) -> FerrayResult<T>

Compute the sum of unmasked elements.

Returns zero if all elements are masked.

Errors

Returns an error only for internal failures.

pub fn mean(&self) -> FerrayResult<T>

Compute the mean of unmasked elements.

Returns NaN if no elements are unmasked.

Errors

Returns an error only for internal failures.

pub fn min(&self) -> FerrayResult<T>

Compute the minimum of unmasked elements.

Errors

Returns FerrayError::InvalidValue if no elements are unmasked.

pub fn max(&self) -> FerrayResult<T>

Compute the maximum of unmasked elements.

Errors

Returns FerrayError::InvalidValue if no elements are unmasked.

pub fn var(&self) -> FerrayResult<T>

Compute the variance of unmasked elements (population variance, ddof=0).

Returns NaN if no elements are unmasked.

Errors

Returns an error only for internal failures.

pub fn std(&self) -> FerrayResult<T>

Compute the standard deviation of unmasked elements (population, ddof=0).

Returns NaN if no elements are unmasked.

Errors

Returns an error only for internal failures.

impl<T, D> MaskedArray<T, D>

where T: Element + PartialOrd + Copy, D: Dimension,

pub fn sort(&self) -> FerrayResult<MaskedArray<T, Ix1>>

Sort the masked array (flattened), placing masked elements at the end.

Returns a new 1-D MaskedArray where:

• Unmasked elements are sorted in ascending order
• Masked elements come after all unmasked elements

Errors

Returns an error only for internal failures.

pub fn argsort(&self) -> FerrayResult<Vec<usize>>

Return the indices that would sort the masked array, with masked elements placed at the end.

Returns a Vec<usize> of indices.

Errors

Returns an error only for internal failures.

Trait Implementations

impl<T: Clone + Element, D: Clone + Dimension> Clone for MaskedArray<T, D>

fn clone(&self) -> MaskedArray<T, D>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Element, D: Debug + Dimension> Debug for MaskedArray<T, D>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.