Struct Patches 

pub struct Patches { /* private fields */ }

A helper for working with patched arrays.

Implementations

impl Patches

pub fn new( array_len: usize, offset: usize, indices: ArrayRef, values: ArrayRef, ) -> Self

pub unsafe fn new_unchecked( array_len: usize, offset: usize, indices: ArrayRef, values: ArrayRef, ) -> Self

Construct new patches without validating any of the arguments

Safety

Users have to assert that

• Indices and values have the same length
• Indices is an unsigned integer type
• Indices must be sorted
• Last value in indices is smaller than array_len

pub fn array_len(&self) -> usize

pub fn num_patches(&self) -> usize

pub fn dtype(&self) -> &DType

pub fn indices(&self) -> &ArrayRef

pub fn into_indices(self) -> ArrayRef

pub fn indices_mut(&mut self) -> &mut ArrayRef

pub fn values(&self) -> &ArrayRef

pub fn into_values(self) -> ArrayRef

pub fn values_mut(&mut self) -> &mut ArrayRef

pub fn offset(&self) -> usize

pub fn indices_ptype(&self) -> PType

pub fn to_metadata( &self, len: usize, dtype: &DType, ) -> VortexResult<PatchesMetadata>

pub fn cast_values(self, values_dtype: &DType) -> VortexResult<Self>

pub fn get_patched(&self, index: usize) -> Option<Scalar>

Get the patched value at a given index if it exists.

pub fn search_index(&self, index: usize) -> SearchResult

Return the insertion point of index in the Self::indices.

pub fn search_sorted<T: Into<Scalar>>( &self, target: T, side: SearchSortedSide, ) -> VortexResult<SearchResult>

Return the search_sorted result for the given target re-mapped into the original indices.

pub fn min_index(&self) -> usize

Returns the minimum patch index

pub fn max_index(&self) -> usize

Returns the maximum patch index

pub fn filter(&self, mask: &Mask) -> VortexResult<Option<Self>>

Filter the patches by a mask, resulting in new patches for the filtered array.

pub fn mask(&self, mask: &Mask) -> VortexResult<Option<Self>>

Mask the patches, REMOVING the patches where the mask is true. Unlike filter, this preserves the patch indices. Unlike mask on a single array, this does not set masked values to null.

pub fn slice(&self, start: usize, stop: usize) -> Option<Self>

Slice the patches by a range of the patched array.

pub fn take_with_nulls( &self, take_indices: &dyn Array, ) -> VortexResult<Option<Self>>

Take the indices from the patches

Any nulls in take_indices are added to the resulting patches.

pub fn take(&self, take_indices: &dyn Array) -> VortexResult<Option<Self>>

Take the indices from the patches.

Any nulls in take_indices are ignored.

pub fn take_search( &self, take_indices: PrimitiveArray, include_nulls: bool, ) -> VortexResult<Option<Self>>

pub fn take_map( &self, take_indices: PrimitiveArray, include_nulls: bool, ) -> VortexResult<Option<Self>>

pub fn map_values<F>(self, f: F) -> VortexResult<Self>

where F: FnOnce(ArrayRef) -> VortexResult<ArrayRef>,

Trait Implementations

impl Clone for Patches

fn clone(&self) -> Patches

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Patches

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

Formats the value using the given formatter.