Skip to main content

ArrayV

Struct ArrayV 

Source
pub struct ArrayV {
    pub array: Array,
    pub offset: usize,
    /* private fields */
}
Expand description

§ArrayView

Logical, windowed view over an Array.

ArrayView handles indexing offsets automatically so that the View behaves like a regular array.

§Purpose

This is used to return an indexable view over a subset of the array. Additionally, it can be used to cache null counts for those regions, which can be used to speed up calculations.

§Behaviour

  • Indices are always relative to the window.
  • Holds a reference to the original Array and window bounds.
  • Windowing uses an arc clone
  • All access (get/index, etc.) is offset-correct and bounds-checked.
  • Null count is computed once (on demand or at creation) and cached for subsequent use.

§Notes

  • Use slice to derive smaller views without data copy.
  • Use to_array to materialise as an owned array.

Fields§

§array: Array

The outer array that this view is derived from - we retain a reference to it. Importantly, this is the full array - not the view, and thus should not be accessed as though it were the view subset.

§offset: usize

The index offset from 0 that for where this view starts from the outer array

Implementations§

Source§

impl ArrayV

Source

pub fn new(array: Array, offset: usize, len: usize) -> ArrayV

Construct a windowed view of array[offset..offset+len), with optional precomputed null count.

Source

pub fn new_nc( array: Array, offset: usize, len: usize, null_count: usize, ) -> ArrayV

Construct a windowed view, supplying a precomputed null count.

Source

pub fn len(&self) -> usize

Return the logical length of the view.

Source

pub fn is_empty(&self) -> bool

Returns true if the view is empty.

Source

pub fn get<T>(&self, i: usize) -> Option<<T as MaskedArray>::CopyType>
where T: MaskedArray + 'static,

Returns the value at logical index i within the window, or None if out of bounds or null.

Source

pub fn get_unchecked<T>(&self, i: usize) -> Option<<T as MaskedArray>::CopyType>
where T: MaskedArray + 'static,

Returns the value at logical index i within the window (unchecked).

Source

pub fn get_str(&self, i: usize) -> Option<&str>

Returns the string value at logical index i within the window, or None if out of bounds or null.

Source

pub unsafe fn get_str_unchecked(&self, i: usize) -> Option<&str>

Returns the string value at logical index i within the window.

§Safety

Skips bounds checks, but will still return None if null.

Source

pub fn slice(&self, offset: usize, len: usize) -> ArrayV

Returns a new window view into a sub-range of this view.

Source

pub fn to_array(&self) -> Array

Materialise a deep copy as an owned Array for the window.

Source

pub fn to_typed_vec<T>(&self) -> Result<Vec64<T>, KernelError>
where T: Numeric,

Extract array data as Vec64<T>, casting numeric values if necessary.

  • If array type matches T exactly, copies the slice directly
  • If array is a different numeric type, casts each element via NumCast
  • Returns error if array type is not numeric or nulls are present
§Example
ⓘ
let av = ArrayV::from(Array::from_float64(...));
let floats: Vec64<f64> = av.to_typed_vec::<f64>()?;
Source

pub fn gather_indices(&self, indices: &[usize]) -> Array

Gather specific indices from this view into a new materialised Array. Indices are relative to this view’s window.

Source

pub fn data_ptr_and_byte_len(&self) -> (*const u8, usize, usize)

Returns a pointer and metadata for raw access

This is not logical length - it is total raw bytes in the buffer, so for non-fixed width types such as bit-packed booleans or strings, please factor this in accordingly.

Source

pub fn end(&self) -> usize

Returns the exclusive end index of the window (relative to parent array).

Source

pub fn as_tuple(&self) -> (Array, usize, usize)

Returns the underlying window as a tuple: (Array, offset, len).

Note: This clones the Arc-wrapped Array.

Source

pub fn as_tuple_ref(&self) -> (&Array, usize, usize)

Returns a reference tuple: (&Array, offset, len).

This avoids cloning the Arc and returns a reference with a lifetime tied to this ArrayV.

Source

pub fn null_count(&self) -> usize

Returns the null count in the window, caching the result after first calculation.

Source

pub fn null_mask_view(&self) -> Option<BitmaskV>

Returns a windowed view over the underlying null mask, if any.

Source

pub fn set_null_count(&self, count: usize) -> Result<(), usize>

Set the cached null count (advanced use only).

Returns Ok(()) if the value was set, or Err(count) if it was already initialized. This is thread-safe and can only succeed once per ArrayV instance.

Trait Implementations§

Source§

impl Clone for ArrayV

Source§

fn clone(&self) -> ArrayV

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Concatenate for ArrayV

Source§

fn concat(self, other: ArrayV) -> Result<ArrayV, MinarrowError>

Concatenates two array views by materialising both to owned arrays, concatenating them, and wrapping the result back in a view.

§Notes
  • This operation copies data from both views to create owned arrays.
  • The resulting view has offset=0 and length equal to the combined length.
Source§

impl Debug for ArrayV

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ArrayV

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&FieldArray> for ArrayV

&FieldArray -> ArrayView

Arc bumps inner array with offset 0, length self.len().

Source§

fn from(field_array: &FieldArray) -> ArrayV

Converts to this type from the input type.
Source§

impl From<Array> for ArrayV

Array -> ArrayView

Uses Offset 0 and length self.len()

Source§

fn from(array: Array) -> ArrayV

Converts to this type from the input type.
Source§

impl From<ArrayV> for BooleanArrayV

Source§

fn from(view: ArrayV) -> BooleanArrayV

Converts to this type from the input type.
Source§

impl From<ArrayV> for NumericArrayV

Source§

fn from(view: ArrayV) -> NumericArrayV

Converts to this type from the input type.
Source§

impl From<ArrayV> for TextArrayV

Source§

fn from(view: ArrayV) -> TextArrayV

Converts to this type from the input type.
Source§

impl From<BooleanArrayV> for ArrayV

Available on crate feature views only.

BooleanArrayView -> ArrayView

Converts by wrapping the inner Arc as Array::BooleanArray.

Source§

fn from(view: BooleanArrayV) -> ArrayV

Converts to this type from the input type.
Source§

impl From<FieldArray> for ArrayV

FieldArray -> ArrayView

Takes self.array then offset 0, length self.len())

Source§

fn from(field_array: FieldArray) -> ArrayV

Converts to this type from the input type.
Source§

impl From<NumericArrayV> for ArrayV

Available on crate feature views only.

NumericArrayView -> ArrayView

Converts by wrapping the inner NumericArray as Array::NumericArray.

Source§

fn from(view: NumericArrayV) -> ArrayV

Converts to this type from the input type.
Source§

impl From<TextArrayV> for ArrayV

Available on crate feature views only.

TextArrayView -> ArrayView

Converts by wrapping the inner TextArray as Array::TextArray.

Source§

fn from(view: TextArrayV) -> ArrayV

Converts to this type from the input type.
Source§

impl PartialEq for ArrayV

Source§

fn eq(&self, other: &ArrayV) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl RowSelection for ArrayV

Available on crate feature select only.
Source§

type View = ArrayV

The view type returned by selection operations
Source§

fn r<S>(&self, selection: S) -> ArrayV
where S: DataSelector,

Select rows by index or range Read more
Source§

fn get_row_count(&self) -> usize

Get the count for data resolution
Source§

impl Shape for ArrayV

Source§

fn shape(&self) -> ShapeDim

Returns arbitrary Shape dimension for any data shape
Source§

fn shape_1d(&self) -> usize

Returns the first dimension shape Read more
Source§

fn shape_2d(&self) -> (usize, usize)

Returns the first and second dimension shapes Read more
Source§

fn shape_3d(&self) -> (usize, usize, usize)

Returns the first, second and third dimension shapes Read more
Source§

fn shape_4d(&self) -> (usize, usize, usize, usize)

Returns the first, second, third and fourth dimension shapes Read more
Source§

impl StructuralPartialEq for ArrayV

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> CustomValue for T
where T: Any + Send + Sync + Clone + PartialEq + Debug,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Downcasts the type as Any
Source§

fn deep_clone(&self) -> Arc<dyn CustomValue>

Returns a deep clone of the object. Read more
Source§

fn eq_box(&self, other: &(dyn CustomValue + 'static)) -> bool

Performs semantic equality on the boxed object. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Print for T
where T: Display,

Source§

fn print(&self)
where Self: Display,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.