Struct DVector 

pub struct DVector<D> { /* private fields */ }

An immutable vector of generic decimal values.

D is bound by NativeDecimalType, which can be one of the native integer types (i8, i16, i32, i64, i128) or i256. D is used to store the decimal values.

The decimal vector maintains a PrecisionScale<D> that defines the precision (total number of digits) and scale (digits after the decimal point) for all values in the vector.

Implementations

impl<D: NativeDecimalType> DVector<D>

pub fn new(ps: PrecisionScale<D>, elements: Buffer<D>, validity: Mask) -> Self

Creates a new DVector<D> from the given PrecisionScale, elements buffer, and validity mask.

Panics

Panics if:

• The lengths of the elements and validity do not match.
• Any of the elements are out of bounds for the given PrecisionScale.

pub fn try_new( ps: PrecisionScale<D>, elements: Buffer<D>, validity: Mask, ) -> VortexResult<Self>

Tries to create a new DVector<D> from the given PrecisionScale, elements buffer, and validity mask.

Errors

Returns an error if:

• The lengths of the elements and validity do not match.
• Any of the elements are out of bounds for the given PrecisionScale.

pub unsafe fn new_unchecked( ps: PrecisionScale<D>, elements: Buffer<D>, validity: Mask, ) -> Self

Creates a new DVector<D> from the given PrecisionScale, elements buffer, and validity mask, without validation.

Safety

The caller must ensure:

• The lengths of the elements and validity are equal.
• All elements are in bounds for the given PrecisionScale.

pub fn into_parts(self) -> (PrecisionScale<D>, Buffer<D>, Mask)

Decomposes the decimal vector into its constituent parts (PrecisionScale, decimal buffer, and validity).

pub fn precision_scale(&self) -> PrecisionScale<D>

Get the precision/scale of the decimal vector.

pub fn precision(&self) -> u8

Returns the precision of the decimal vector.

pub fn scale(&self) -> i8

Returns the scale of the decimal vector.

pub fn elements(&self) -> &Buffer<D>

Returns a reference to the underlying elements buffer containing the decimal data.

pub fn get(&self, index: usize) -> Option<&D>

Gets a nullable element at the given index, panicking on out-of-bounds.

If the element at the given index is null, returns None. Otherwise, returns Some(x), where x: D.

Note that this get method is different from the standard library slice::get, which returns None if the index is out of bounds. This method will panic if the index is out of bounds, and return None if the elements is null.

Panics

Panics if the index is out of bounds.

Trait Implementations

impl<D: NativeDecimalType> AsRef<[D]> for DVector<D>

fn as_ref(&self) -> &[D]

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

impl<D: Clone> Clone for DVector<D>

fn clone(&self) -> DVector<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for DVector<D>

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

Formats the value using the given formatter.

impl<D: NativeDecimalType> From<DVector<D>> for DecimalVector

fn from(value: DVector<D>) -> Self

Converts to this type from the input type.

impl<D: NativeDecimalType> From<DVector<D>> for Vector

fn from(v: DVector<D>) -> Self

Converts to this type from the input type.

impl<D: NativeDecimalType> VectorOps for DVector<D>

type Mutable = DVectorMut<D>

The mutable equivalent of this immutable vector.

fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its “length”.

fn validity(&self) -> &Mask

Returns the validity mask of the vector, where true represents a valid element and false represents a null element.

fn scalar_at(&self, index: usize) -> Scalar

Return the scalar at the given index.

fn slice(&self, range: impl RangeBounds<usize> + Clone + Debug) -> Self

Slice the vector from start to end (exclusive).

fn try_into_mut(self) -> Result<DVectorMut<D>, Self>

Tries to convert self into a mutable vector (implementing VectorMutOps).

fn into_mut(self) -> DVectorMut<D>

Converts self into a mutable vector (implementing VectorMutOps).

fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

fn null_count(&self) -> usize

Returns the null count of the vector.