mod kernel;
mod operations;
mod plugin;
pub use plugin::DecimalPlugin;
mod validity;
use std::hash::Hash;
use std::hash::Hasher;
use vortex_error::VortexResult;
use vortex_error::vortex_bail;
use vortex_error::vortex_ensure_eq;
use vortex_session::VortexSession;
use vortex_session::registry::CachedId;
use crate::ArrayParts;
use crate::ArrayRef;
use crate::EqMode;
use crate::ExecutionCtx;
use crate::ExecutionResult;
use crate::array::Array;
use crate::array::ArrayId;
use crate::array::ArrayView;
use crate::array::VTable;
use crate::arrays::decimal::DecimalData;
use crate::arrays::decimal::array::DecimalSlots;
use crate::arrays::decimal::compute::rules::RULES;
use crate::arrays::fixed_width::vtable as fixed_width;
use crate::buffer::BufferHandle;
use crate::builders::ArrayBuilder;
use crate::builders::DecimalBuilder;
use crate::dtype::DType;
use crate::hash::ArrayEq;
use crate::hash::ArrayHash;
use crate::serde::ArrayChildren;
pub type DecimalArray = Array<Decimal>;
pub(crate) fn initialize(session: &VortexSession) {
kernel::initialize(session);
}
impl ArrayHash for DecimalData {
fn array_hash<H: Hasher>(&self, state: &mut H, accuracy: EqMode) {
self.values.array_hash(state, accuracy);
std::mem::discriminant(&self.values_type).hash(state);
}
}
impl ArrayEq for DecimalData {
fn array_eq(&self, other: &Self, accuracy: EqMode) -> bool {
self.values.array_eq(&other.values, accuracy) && self.values_type == other.values_type
}
}
impl VTable for Decimal {
type TypedArrayData = DecimalData;
type OperationsVTable = Self;
type ValidityVTable = Self;
fn id(&self) -> ArrayId {
static ID: CachedId = CachedId::new("vortex.decimal");
*ID
}
fn nbuffers(_array: ArrayView<'_, Self>) -> usize {
1
}
fn buffer(array: ArrayView<'_, Self>, idx: usize) -> BufferHandle {
fixed_width::buffer("DecimalArray", &array.values, idx)
}
fn buffer_name(_array: ArrayView<'_, Self>, idx: usize) -> Option<String> {
fixed_width::buffer_name(idx)
}
fn with_buffers(
&self,
array: ArrayView<'_, Self>,
buffers: &[BufferHandle],
) -> VortexResult<ArrayParts<Self>> {
let mut data = array.data().clone();
data.values = fixed_width::single_buffer(buffers)?;
Ok(ArrayParts::new(
self.clone(),
array.dtype().clone(),
array.len(),
data,
array.slots().iter().cloned().collect(),
))
}
fn serialize(
_array: ArrayView<'_, Self>,
_session: &VortexSession,
) -> VortexResult<Option<Vec<u8>>> {
Ok(None)
}
fn validate(
&self,
data: &DecimalData,
dtype: &DType,
len: usize,
slots: &[Option<ArrayRef>],
) -> VortexResult<()> {
let DType::Decimal(_, nullability) = dtype else {
vortex_bail!("Expected decimal dtype, got {dtype:?}");
};
vortex_ensure_eq!(
data.len(),
len,
"DecimalArray length does not match outer length",
);
let validity =
crate::array::child_to_validity(slots[DecimalSlots::VALIDITY].as_ref(), *nullability);
if let Some(validity_len) = validity.maybe_len() {
vortex_ensure_eq!(
validity_len,
len,
"DecimalArray validity len does not match outer length",
);
}
Ok(())
}
fn deserialize(
&self,
_dtype: &DType,
_len: usize,
_metadata: &[u8],
_buffers: &[BufferHandle],
_children: &dyn ArrayChildren,
_session: &VortexSession,
) -> VortexResult<ArrayParts<Self>> {
vortex_bail!("Decimal deserialization requires DecimalPlugin")
}
fn slot_name(_array: ArrayView<'_, Self>, idx: usize) -> String {
DecimalSlots::NAMES[idx].to_string()
}
fn execute(array: Array<Self>, _ctx: &mut ExecutionCtx) -> VortexResult<ExecutionResult> {
Ok(ExecutionResult::done(array))
}
fn append_to_builder(
array: ArrayView<'_, Self>,
builder: &mut dyn ArrayBuilder,
ctx: &mut ExecutionCtx,
) -> VortexResult<()> {
let Some(builder) = builder.as_any_mut().downcast_mut::<DecimalBuilder>() else {
vortex_bail!("append_to_builder for Decimal requires a DecimalBuilder");
};
builder.append_decimal_array(&array.into_owned(), ctx)
}
fn reduce_parent(
array: ArrayView<'_, Self>,
parent: &ArrayRef,
child_idx: usize,
) -> VortexResult<Option<ArrayRef>> {
RULES.evaluate(array, parent, child_idx)
}
}
#[derive(Clone, Debug)]
pub struct Decimal;