Struct DecimalArray

pub struct DecimalArray { /* private fields */ }

Array for decimal-typed real numbers

Implementations

impl DecimalArray

pub fn new<T: NativeDecimalType>( buffer: Buffer<T>, decimal_dtype: DecimalDType, validity: Validity, ) -> Self

Creates a new DecimalArray from a Buffer and Validity, without checking any invariants.

pub fn byte_buffer(&self) -> ByteBuffer

Returns the underlying ByteBuffer of the array.

pub fn buffer<T: NativeDecimalType>(&self) -> Buffer<T>

pub fn validity(&self) -> &Validity

Returns the underlying Validity of the array.

pub fn decimal_dtype(&self) -> DecimalDType

Returns the decimal type information

pub fn values_type(&self) -> DecimalValueType

pub fn precision(&self) -> u8

pub fn scale(&self) -> i8

Trait Implementations

impl ArrayCanonicalImpl for DecimalArray

fn _to_canonical(&self) -> VortexResult<Canonical>

Returns the canonical representation of the array.

fn _append_to_builder(&self, builder: &mut dyn ArrayBuilder) -> VortexResult<()>

Writes the array into the canonical builder.

impl ArrayImpl for DecimalArray

type Encoding = DecimalEncoding

fn _len(&self) -> usize

fn _dtype(&self) -> &DType

fn _vtable(&self) -> VTableRef

fn _with_children(&self, _children: &[ArrayRef]) -> VortexResult<Self>

Replace the children of this array with the given arrays.

fn _invoke( &self, _compute_fn: &ComputeFn, _args: &InvocationArgs<'_>, ) -> VortexResult<Option<Output>>

Dynamically invoke a kernel for the given compute function.

impl ArrayStatisticsImpl for DecimalArray

fn _stats_ref(&self) -> StatsSetRef<'_>

impl ArrayValidityImpl for DecimalArray

fn _is_valid(&self, index: usize) -> VortexResult<bool>

Returns whether the index item is valid.

fn _all_valid(&self) -> VortexResult<bool>

Returns whether the array is all valid.

fn _all_invalid(&self) -> VortexResult<bool>

Returns whether the array is all invalid.

fn _validity_mask(&self) -> VortexResult<Mask>

Returns the canonical validity mask for the array.

fn _valid_count(&self) -> VortexResult<usize>

Returns the number of valid elements in the array.

fn _invalid_count(&self) -> VortexResult<usize>

Returns the number of invalid elements in the array.

impl ArrayVariantsImpl for DecimalArray

fn _as_decimal_typed(&self) -> Option<&dyn DecimalArrayTrait>

Downcasts the array for decimal-specific behavior.

fn _as_null_typed(&self) -> Option<&dyn NullArrayTrait>

Downcasts the array for null-specific behavior.

fn _as_bool_typed(&self) -> Option<&dyn BoolArrayTrait>

Downcasts the array for bool-specific behavior.

fn _as_primitive_typed(&self) -> Option<&dyn PrimitiveArrayTrait>

Downcasts the array for primitive-specific behavior.

fn _as_utf8_typed(&self) -> Option<&dyn Utf8ArrayTrait>

Downcasts the array for utf8-specific behavior.

fn _as_binary_typed(&self) -> Option<&dyn BinaryArrayTrait>

Downcasts the array for binary-specific behavior.

fn _as_struct_typed(&self) -> Option<&dyn StructArrayTrait>

Downcasts the array for struct-specific behavior.

fn _as_list_typed(&self) -> Option<&dyn ListArrayTrait>

Downcasts the array for list-specific behavior.

fn _as_extension_typed(&self) -> Option<&dyn ExtensionArrayTrait>

Downcasts the array for extension-specific behavior.

impl ArrayVisitorImpl<ProstMetadata<DecimalMetadata>> for DecimalArray

fn _metadata(&self) -> ProstMetadata<DecimalMetadata>

fn _visit_buffers(&self, visitor: &mut dyn ArrayBufferVisitor)

fn _visit_children(&self, visitor: &mut dyn ArrayChildVisitor)

fn _nbuffers(&self) -> usize

fn _nchildren(&self) -> usize

impl Clone for DecimalArray

fn clone(&self) -> DecimalArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DecimalArray

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

Formats the value using the given formatter.

impl IsConstantFn<&DecimalArray> for DecimalEncoding

fn is_constant( &self, array: &DecimalArray, _opts: &IsConstantOpts, ) -> VortexResult<Option<bool>>

Preconditions

impl IsSortedFn<&DecimalArray> for DecimalEncoding

fn is_sorted(&self, array: &DecimalArray) -> VortexResult<bool>

Preconditions

fn is_strict_sorted(&self, array: &DecimalArray) -> VortexResult<bool>

impl ScalarAtFn<&DecimalArray> for DecimalEncoding

fn scalar_at(&self, array: &DecimalArray, index: usize) -> VortexResult<Scalar>

impl SliceFn<&DecimalArray> for DecimalEncoding

fn slice( &self, array: &DecimalArray, start: usize, stop: usize, ) -> VortexResult<ArrayRef>

Return a zero-copy slice of an array, between start (inclusive) and end (exclusive). If start >= stop, returns an empty array of the same type as self. Assumes that start or stop are out of bounds, may panic otherwise.

impl TakeFn<&DecimalArray> for DecimalEncoding

fn take( &self, array: &DecimalArray, indices: &dyn Array, ) -> VortexResult<ArrayRef>

Create a new array by taking the values from the array at the given indices.

fn take_into( &self, array: A, indices: &dyn Array, builder: &mut dyn ArrayBuilder, ) -> VortexResult<()>

Has the same semantics as Self::take but materializes the result into the provided builder.

impl ToArrowFn<&DecimalArray> for DecimalEncoding

fn to_arrow( &self, array: &DecimalArray, data_type: &DataType, ) -> VortexResult<Option<ArrowArrayRef>>

Convert the array to an Arrow array of the given type.

fn preferred_arrow_data_type(&self, _array: A) -> VortexResult<Option<DataType>>

Return the preferred Arrow DataType of the encoding, or None of the canonical DataType for the array’s Vortex vortex_dtype::DType should be used.

impl TryFrom<Arc<dyn Array>> for DecimalArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ArrayRef) -> Result<Self, Self::Error>

Performs the conversion.

impl DecimalArrayTrait for DecimalArray