vortex-array 0.68.0

Vortex in memory columnar data format
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

use std::fmt;
use std::fmt::Display;
use std::fmt::Formatter;

use vortex_error::VortexResult;
use vortex_error::vortex_bail;
use vortex_session::VortexSession;

use crate::ArrayRef;
use crate::Columnar;
use crate::ExecutionCtx;
use crate::aggregate_fn::AggregateFn;
use crate::aggregate_fn::AggregateFnId;
use crate::aggregate_fn::AggregateFnRef;
use crate::aggregate_fn::AggregateFnVTable;
use crate::dtype::DType;
use crate::scalar::Scalar;

/// Options payload for a foreign aggregate function.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct ForeignAggregateFnOptions {
    metadata: Vec<u8>,
}

impl ForeignAggregateFnOptions {
    pub fn new(metadata: Vec<u8>) -> Self {
        Self { metadata }
    }
}

impl Display for ForeignAggregateFnOptions {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "foreign(metadata={}B)", self.metadata.len())
    }
}

/// Aggregate-function placeholder used when deserializing an unknown aggregate function ID.
#[derive(Clone, Debug)]
pub struct ForeignAggregateFnVTable {
    id: AggregateFnId,
}

impl ForeignAggregateFnVTable {
    pub fn new(id: AggregateFnId) -> Self {
        Self { id }
    }
}

impl AggregateFnVTable for ForeignAggregateFnVTable {
    type Options = ForeignAggregateFnOptions;
    type Partial = ();

    fn id(&self) -> AggregateFnId {
        self.id.clone()
    }

    fn serialize(&self, options: &Self::Options) -> VortexResult<Option<Vec<u8>>> {
        Ok(Some(options.metadata.clone()))
    }

    fn deserialize(
        &self,
        metadata: &[u8],
        _session: &VortexSession,
    ) -> VortexResult<Self::Options> {
        Ok(ForeignAggregateFnOptions::new(metadata.to_vec()))
    }

    fn return_dtype(&self, _options: &Self::Options, _input_dtype: &DType) -> Option<DType> {
        None
    }

    fn partial_dtype(&self, _options: &Self::Options, _input_dtype: &DType) -> Option<DType> {
        None
    }

    fn empty_partial(
        &self,
        _options: &Self::Options,
        _input_dtype: &DType,
    ) -> VortexResult<Self::Partial> {
        vortex_bail!("Cannot execute unknown aggregate function '{}'", self.id)
    }

    fn combine_partials(&self, _partial: &mut Self::Partial, _other: Scalar) -> VortexResult<()> {
        vortex_bail!("Cannot execute unknown aggregate function '{}'", self.id)
    }

    fn to_scalar(&self, _partial: &Self::Partial) -> VortexResult<Scalar> {
        vortex_bail!("Cannot execute unknown aggregate function '{}'", self.id)
    }

    fn reset(&self, _partial: &mut Self::Partial) {}

    fn is_saturated(&self, _state: &Self::Partial) -> bool {
        false
    }

    fn accumulate(
        &self,
        _state: &mut Self::Partial,
        _batch: &Columnar,
        _ctx: &mut ExecutionCtx,
    ) -> VortexResult<()> {
        vortex_bail!("Cannot execute unknown aggregate function '{}'", self.id)
    }

    fn finalize(&self, _states: ArrayRef) -> VortexResult<ArrayRef> {
        vortex_bail!("Cannot execute unknown aggregate function '{}'", self.id)
    }
}

pub fn new_foreign_aggregate_fn(id: AggregateFnId, metadata: Vec<u8>) -> AggregateFnRef {
    AggregateFn::new(
        ForeignAggregateFnVTable::new(id),
        ForeignAggregateFnOptions::new(metadata),
    )
    .erased()
}