Struct ALPArray 

pub struct ALPArray { /* private fields */ }

Implementations

impl ALPArray

pub fn new( encoded: ArrayRef, exponents: Exponents, patches: Option<Patches>, ) -> Self

Build a new ALPArray from components, panicking on validation failure.

See ALPArray::try_new for reference on preconditions that must pass before calling this method.

pub fn try_new( encoded: ArrayRef, exponents: Exponents, patches: Option<Patches>, ) -> VortexResult<Self>

Build a new ALPArray from components:

• encoded contains the ALP-encoded ints. Any null values are replaced with placeholders
• exponents are the ALP exponents, valid range depends on the data type
• patches are any patch values that don’t cleanly encode using the ALP conversion function

This method validates the inputs and will return an error if any validation fails.

Validation

• The encoded array must be either i32 or i64
  • If i32, any patches must have DType f32 with same nullability
  • If i64, then patchesmust have DType f64 with same nullability
• exponents must be in the valid range depending on if the ALPArray is of type f32 or f64.
• patches must have an array_len equal to the length of encoded

Any failure of these preconditions will result in an error being returned.

Examples

// Returns error because buffer has wrong PType.
let result = ALPArray::try_new(
    buffer![1i8].into_array(),
    Exponents { e: 1, f: 1 },
    None
);
assert!(result.is_err());

// Returns error because Exponents are out of bounds for f32
let result = ALPArray::try_new(
    buffer![1i32, 2i32].into_array(),
    Exponents { e: 100, f: 100 },
    None
);
assert!(result.is_err());

// Success!
let value = ALPArray::try_new(
    buffer![0i32].into_array(),
    Exponents { e: 1, f: 1 },
    None
).unwrap();

assert_eq!(value.scalar_at(0), 0f32.into());

pub fn ptype(&self) -> PType

pub fn encoded(&self) -> &ArrayRef

pub fn exponents(&self) -> Exponents

pub fn patches(&self) -> Option<&Patches>

Trait Implementations

impl AsRef<dyn Array> for ALPArray

fn as_ref(&self) -> &dyn Array

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ALPArray

fn clone(&self) -> ALPArray

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ALPArray

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

Formats the value using the given formatter.

impl Deref for ALPArray

type Target = dyn Array

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<ALPArray> for ArrayRef

fn from(value: ALPArray) -> ArrayRef

Converts to this type from the input type.

impl IntoArray for ALPArray

fn into_array(self) -> ArrayRef