pub struct DecimalArray { /* private fields */ }
Expand description
Array for decimal-typed real numbers
Implementations§
Source§impl DecimalArray
impl DecimalArray
Sourcepub fn new<T: NativeDecimalType>(
buffer: Buffer<T>,
decimal_dtype: DecimalDType,
validity: Validity,
) -> Self
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.
Sourcepub fn byte_buffer(&self) -> ByteBuffer
pub fn byte_buffer(&self) -> ByteBuffer
Returns the underlying ByteBuffer
of the array.
pub fn buffer<T: NativeDecimalType>(&self) -> Buffer<T>
Sourcepub fn decimal_dtype(&self) -> DecimalDType
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§
Source§impl ArrayCanonicalImpl for DecimalArray
impl ArrayCanonicalImpl for DecimalArray
Source§fn _to_canonical(&self) -> VortexResult<Canonical>
fn _to_canonical(&self) -> VortexResult<Canonical>
Source§fn _append_to_builder(&self, builder: &mut dyn ArrayBuilder) -> VortexResult<()>
fn _append_to_builder(&self, builder: &mut dyn ArrayBuilder) -> VortexResult<()>
Source§impl ArrayImpl for DecimalArray
impl ArrayImpl for DecimalArray
type Encoding = DecimalEncoding
fn _len(&self) -> usize
fn _dtype(&self) -> &DType
fn _vtable(&self) -> VTableRef
Source§fn _with_children(&self, _children: &[ArrayRef]) -> VortexResult<Self>
fn _with_children(&self, _children: &[ArrayRef]) -> VortexResult<Self>
Source§fn _invoke(
&self,
_compute_fn: &ComputeFn,
_args: &InvocationArgs<'_>,
) -> VortexResult<Option<Output>>
fn _invoke( &self, _compute_fn: &ComputeFn, _args: &InvocationArgs<'_>, ) -> VortexResult<Option<Output>>
Source§impl ArrayStatisticsImpl for DecimalArray
impl ArrayStatisticsImpl for DecimalArray
fn _stats_ref(&self) -> StatsSetRef<'_>
Source§impl ArrayValidityImpl for DecimalArray
impl ArrayValidityImpl for DecimalArray
Source§fn _is_valid(&self, index: usize) -> VortexResult<bool>
fn _is_valid(&self, index: usize) -> VortexResult<bool>
index
item is valid. Read moreSource§fn _all_valid(&self) -> VortexResult<bool>
fn _all_valid(&self) -> VortexResult<bool>
Source§fn _all_invalid(&self) -> VortexResult<bool>
fn _all_invalid(&self) -> VortexResult<bool>
Source§fn _validity_mask(&self) -> VortexResult<Mask>
fn _validity_mask(&self) -> VortexResult<Mask>
Source§fn _valid_count(&self) -> VortexResult<usize>
fn _valid_count(&self) -> VortexResult<usize>
Source§fn _invalid_count(&self) -> VortexResult<usize>
fn _invalid_count(&self) -> VortexResult<usize>
Source§impl ArrayVariantsImpl for DecimalArray
impl ArrayVariantsImpl for DecimalArray
Source§fn _as_decimal_typed(&self) -> Option<&dyn DecimalArrayTrait>
fn _as_decimal_typed(&self) -> Option<&dyn DecimalArrayTrait>
Source§fn _as_null_typed(&self) -> Option<&dyn NullArrayTrait>
fn _as_null_typed(&self) -> Option<&dyn NullArrayTrait>
Source§fn _as_bool_typed(&self) -> Option<&dyn BoolArrayTrait>
fn _as_bool_typed(&self) -> Option<&dyn BoolArrayTrait>
Source§fn _as_primitive_typed(&self) -> Option<&dyn PrimitiveArrayTrait>
fn _as_primitive_typed(&self) -> Option<&dyn PrimitiveArrayTrait>
Source§fn _as_utf8_typed(&self) -> Option<&dyn Utf8ArrayTrait>
fn _as_utf8_typed(&self) -> Option<&dyn Utf8ArrayTrait>
Source§fn _as_binary_typed(&self) -> Option<&dyn BinaryArrayTrait>
fn _as_binary_typed(&self) -> Option<&dyn BinaryArrayTrait>
Source§fn _as_struct_typed(&self) -> Option<&dyn StructArrayTrait>
fn _as_struct_typed(&self) -> Option<&dyn StructArrayTrait>
Source§fn _as_list_typed(&self) -> Option<&dyn ListArrayTrait>
fn _as_list_typed(&self) -> Option<&dyn ListArrayTrait>
Source§fn _as_extension_typed(&self) -> Option<&dyn ExtensionArrayTrait>
fn _as_extension_typed(&self) -> Option<&dyn ExtensionArrayTrait>
Source§impl ArrayVisitorImpl<ProstMetadata<DecimalMetadata>> for DecimalArray
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
Source§impl Clone for DecimalArray
impl Clone for DecimalArray
Source§fn clone(&self) -> DecimalArray
fn clone(&self) -> DecimalArray
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DecimalArray
impl Debug for DecimalArray
Source§impl IsConstantFn<&DecimalArray> for DecimalEncoding
impl IsConstantFn<&DecimalArray> for DecimalEncoding
Source§fn is_constant(
&self,
array: &DecimalArray,
_opts: &IsConstantOpts,
) -> VortexResult<Option<bool>>
fn is_constant( &self, array: &DecimalArray, _opts: &IsConstantOpts, ) -> VortexResult<Option<bool>>
Source§impl IsSortedFn<&DecimalArray> for DecimalEncoding
impl IsSortedFn<&DecimalArray> for DecimalEncoding
Source§fn is_sorted(&self, array: &DecimalArray) -> VortexResult<bool>
fn is_sorted(&self, array: &DecimalArray) -> VortexResult<bool>
fn is_strict_sorted(&self, array: &DecimalArray) -> VortexResult<bool>
Source§impl ScalarAtFn<&DecimalArray> for DecimalEncoding
impl ScalarAtFn<&DecimalArray> for DecimalEncoding
fn scalar_at(&self, array: &DecimalArray, index: usize) -> VortexResult<Scalar>
Source§impl SliceFn<&DecimalArray> for DecimalEncoding
impl SliceFn<&DecimalArray> for DecimalEncoding
Source§fn slice(
&self,
array: &DecimalArray,
start: usize,
stop: usize,
) -> VortexResult<ArrayRef>
fn slice( &self, array: &DecimalArray, start: usize, stop: usize, ) -> VortexResult<ArrayRef>
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.Source§impl TakeFn<&DecimalArray> for DecimalEncoding
impl TakeFn<&DecimalArray> for DecimalEncoding
Source§fn take(
&self,
array: &DecimalArray,
indices: &dyn Array,
) -> VortexResult<ArrayRef>
fn take( &self, array: &DecimalArray, indices: &dyn Array, ) -> VortexResult<ArrayRef>
Source§fn take_into(
&self,
array: A,
indices: &dyn Array,
builder: &mut dyn ArrayBuilder,
) -> VortexResult<()>
fn take_into( &self, array: A, indices: &dyn Array, builder: &mut dyn ArrayBuilder, ) -> VortexResult<()>
Self::take
but materializes the result into the provided
builder.Source§impl ToArrowFn<&DecimalArray> for DecimalEncoding
impl ToArrowFn<&DecimalArray> for DecimalEncoding
Source§fn to_arrow(
&self,
array: &DecimalArray,
data_type: &DataType,
) -> VortexResult<Option<ArrowArrayRef>>
fn to_arrow( &self, array: &DecimalArray, data_type: &DataType, ) -> VortexResult<Option<ArrowArrayRef>>
Source§fn preferred_arrow_data_type(&self, _array: A) -> VortexResult<Option<DataType>>
fn preferred_arrow_data_type(&self, _array: A) -> VortexResult<Option<DataType>>
DataType
of the encoding, or None of the canonical
DataType
for the array’s Vortex vortex_dtype::DType
should be used.impl DecimalArrayTrait for DecimalArray
Auto Trait Implementations§
impl !Freeze for DecimalArray
impl !RefUnwindSafe for DecimalArray
impl Send for DecimalArray
impl Sync for DecimalArray
impl Unpin for DecimalArray
impl !UnwindSafe for DecimalArray
Blanket Implementations§
Source§impl<A> Array for Awhere
A: ArrayImpl + 'static,
impl<A> Array for Awhere
A: ArrayImpl + 'static,
Source§fn is_valid(&self, index: usize) -> Result<bool, VortexError>
fn is_valid(&self, index: usize) -> Result<bool, VortexError>
Returns whether the item at index
is valid.
Source§fn is_invalid(&self, index: usize) -> Result<bool, VortexError>
fn is_invalid(&self, index: usize) -> Result<bool, VortexError>
Returns whether the item at index
is invalid.
Source§fn all_valid(&self) -> Result<bool, VortexError>
fn all_valid(&self) -> Result<bool, VortexError>
Returns whether all items in the array are valid.
This is usually cheaper than computing a precise valid_count
.
Source§fn all_invalid(&self) -> Result<bool, VortexError>
fn all_invalid(&self) -> Result<bool, VortexError>
Returns whether the array is all invalid.
This is usually cheaper than computing a precise invalid_count
.
Source§fn valid_count(&self) -> Result<usize, VortexError>
fn valid_count(&self) -> Result<usize, VortexError>
Returns the number of valid elements in the array.
Source§fn invalid_count(&self) -> Result<usize, VortexError>
fn invalid_count(&self) -> Result<usize, VortexError>
Returns the number of invalid elements in the array.
Source§fn validity_mask(&self) -> Result<Mask, VortexError>
fn validity_mask(&self) -> Result<Mask, VortexError>
Returns the canonical validity mask for the array.
Source§fn to_canonical(&self) -> Result<Canonical, VortexError>
fn to_canonical(&self) -> Result<Canonical, VortexError>
Returns the canonical representation of the array.
Source§fn append_to_builder(
&self,
builder: &mut dyn ArrayBuilder,
) -> Result<(), VortexError>
fn append_to_builder( &self, builder: &mut dyn ArrayBuilder, ) -> Result<(), VortexError>
Writes the array into the canonical builder.
The DType
of the builder must match that of the array.
Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Any
trait object.Source§fn vtable(&self) -> ArcRef<dyn EncodingVTable>
fn vtable(&self) -> ArcRef<dyn EncodingVTable>
Source§fn statistics(&self) -> StatsSetRef<'_>
fn statistics(&self) -> StatsSetRef<'_>
Source§fn with_children(
&self,
children: &[Arc<dyn Array>],
) -> Result<Arc<dyn Array>, VortexError>
fn with_children( &self, children: &[Arc<dyn Array>], ) -> Result<Arc<dyn Array>, VortexError>
Source§fn invoke(
&self,
compute_fn: &ComputeFn,
args: &InvocationArgs<'_>,
) -> Result<Option<Output>, VortexError>
fn invoke( &self, compute_fn: &ComputeFn, args: &InvocationArgs<'_>, ) -> Result<Option<Output>, VortexError>
Source§fn is_encoding(&self, encoding: EncodingId) -> bool
fn is_encoding(&self, encoding: EncodingId) -> bool
Source§fn is_canonical(&self) -> bool
fn is_canonical(&self) -> bool
Source§impl<A> ArrayIteratorArrayExt for A
impl<A> ArrayIteratorArrayExt for A
Source§fn to_array_iterator(&self) -> impl ArrayIterator + 'static
fn to_array_iterator(&self) -> impl ArrayIterator + 'static
ArrayIterator
over the array.Source§impl<A> ArrayStatistics for Awhere
A: Array + 'static,
impl<A> ArrayStatistics for Awhere
A: Array + 'static,
Source§fn is_constant(&self) -> bool
fn is_constant(&self) -> bool
Source§fn as_constant(&self) -> Option<Scalar>
fn as_constant(&self) -> Option<Scalar>
Self::is_constant
is true, return the actual constant value as a Scalar
.Source§impl<A> ArrayStreamArrayExt for A
impl<A> ArrayStreamArrayExt for A
Source§fn to_array_stream(&self) -> impl ArrayStream + 'static
fn to_array_stream(&self) -> impl ArrayStream + 'static
ArrayStream
over the array.Source§impl<A> ArrayVariants for Awhere
A: ArrayImpl,
impl<A> ArrayVariants for Awhere
A: ArrayImpl,
Source§fn as_null_typed(&self) -> Option<&dyn NullArrayTrait>
fn as_null_typed(&self) -> Option<&dyn NullArrayTrait>
Downcasts the array for null-specific behavior.
Source§fn as_bool_typed(&self) -> Option<&dyn BoolArrayTrait>
fn as_bool_typed(&self) -> Option<&dyn BoolArrayTrait>
Downcasts the array for bool-specific behavior.
Source§fn as_primitive_typed(&self) -> Option<&dyn PrimitiveArrayTrait>
fn as_primitive_typed(&self) -> Option<&dyn PrimitiveArrayTrait>
Downcasts the array for primitive-specific behavior.
Source§fn as_decimal_typed(&self) -> Option<&dyn DecimalArrayTrait>
fn as_decimal_typed(&self) -> Option<&dyn DecimalArrayTrait>
Downcasts the array for decimal-specific behavior.
Source§fn as_utf8_typed(&self) -> Option<&dyn Utf8ArrayTrait>
fn as_utf8_typed(&self) -> Option<&dyn Utf8ArrayTrait>
Downcasts the array for utf8-specific behavior.
Source§fn as_binary_typed(&self) -> Option<&dyn BinaryArrayTrait>
fn as_binary_typed(&self) -> Option<&dyn BinaryArrayTrait>
Downcasts the array for binary-specific behavior.
Source§fn as_struct_typed(&self) -> Option<&dyn StructArrayTrait>
fn as_struct_typed(&self) -> Option<&dyn StructArrayTrait>
Downcasts the array for struct-specific behavior.
Source§fn as_list_typed(&self) -> Option<&dyn ListArrayTrait>
fn as_list_typed(&self) -> Option<&dyn ListArrayTrait>
Downcasts the array for list-specific behavior.
Source§fn as_extension_typed(&self) -> Option<&dyn ExtensionArrayTrait>
fn as_extension_typed(&self) -> Option<&dyn ExtensionArrayTrait>
Downcasts the array for extension-specific behavior.
Source§impl<A> ArrayVisitor for Awhere
A: ArrayImpl,
impl<A> ArrayVisitor for Awhere
A: ArrayImpl,
Source§impl<A> ArrayVisitorExt for A
impl<A> ArrayVisitorExt for A
Source§fn nbuffers_recursive(&self) -> usize
fn nbuffers_recursive(&self) -> usize
Source§fn depth_first_traversal(&self) -> impl Iterator<Item = ArrayRef>
fn depth_first_traversal(&self) -> impl Iterator<Item = ArrayRef>
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more