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: Arc<dyn Array>, values: Arc<dyn Array>, chunk_offsets: Option<Arc<dyn Array>>, ) -> Patches

pub unsafe fn new_unchecked( array_len: usize, offset: usize, indices: Arc<dyn Array>, values: Arc<dyn Array>, chunk_offsets: Option<Arc<dyn Array>>, offset_within_chunk: Option<usize>, ) -> Patches

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) -> &Arc<dyn Array>

pub fn into_indices(self) -> Arc<dyn Array>

pub fn indices_mut(&mut self) -> &mut Arc<dyn Array>

pub fn values(&self) -> &Arc<dyn Array>

pub fn into_values(self) -> Arc<dyn Array>

pub fn values_mut(&mut self) -> &mut Arc<dyn Array>

pub fn offset(&self) -> usize

pub fn chunk_offsets(&self) -> &Option<Arc<dyn Array>>

pub fn chunk_offset_at(&self, idx: usize) -> usize

pub fn offset_within_chunk(&self) -> Option<usize>

pub fn indices_ptype(&self) -> PType

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

pub fn cast_values(self, values_dtype: &DType) -> Result<Patches, VortexError>

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

Searches for index in the indices array.

Chooses between chunked search when Self::chunk_offsets is available, and binary search otherwise. The index parameter is adjusted by Self::offset for both.

Arguments

• index - The index to search for

Returns

• [SearchResult::Found(patch_idx)] - If a patch exists at this index, returns the position in the patches array
• [SearchResult::NotFound(insertion_point)] - If no patch exists, returns where a patch at this index would be inserted to maintain sorted order

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) -> Result<Option<Patches>, VortexError>

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

pub fn mask(&self, mask: &Mask) -> Result<Option<Patches>, VortexError>

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, range: Range<usize>) -> Option<Patches>

Slice the patches by a range of the patched array.

pub fn take_with_nulls( &self, take_indices: &(dyn Array + 'static), ) -> Result<Option<Patches>, VortexError>

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 + 'static), ) -> Result<Option<Patches>, VortexError>

Take the indices from the patches.

Any nulls in take_indices are ignored.

pub fn take_search( &self, take_indices: PrimitiveArray, include_nulls: bool, ) -> Result<Option<Patches>, VortexError>

pub fn take_map( &self, take_indices: PrimitiveArray, include_nulls: bool, ) -> Result<Option<Patches>, VortexError>

pub fn map_values<F>(self, f: F) -> Result<Patches, VortexError>

where F: FnOnce(Arc<dyn Array>) -> Result<Arc<dyn Array>, VortexError>,

Trait Implementations

impl ArrayEq for Patches

fn array_eq(&self, other: &Patches, precision: Precision) -> bool

impl ArrayHash for Patches

fn array_hash<H>(&self, state: &mut H, precision: Precision)

where H: Hasher,

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<(), Error>

Formats the value using the given formatter.