vortex-array 0.62.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

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

use vortex_error::VortexExpect;
use vortex_error::VortexResult;

use crate::ArrayRef;
use crate::ExecutionCtx;
use crate::arrays::ScalarFnVTable;
use crate::arrays::scalar_fn::ExactScalarFn;
use crate::arrays::scalar_fn::ScalarFnArrayView;
use crate::kernel::ExecuteParentKernel;
use crate::optimizer::rules::ArrayParentReduceRule;
use crate::scalar_fn::fns::zip::Zip as ZipExpr;
use crate::vtable::VTable;

/// Zip two arrays using a mask without reading buffers.
///
/// This trait is for zip implementations that can operate purely on array metadata
/// and structure without needing to read or execute on the underlying buffers.
/// Implementations should return `None` if the operation requires buffer access.
///
/// Dispatch is on child 0 (if_true). The `if_false` and `mask` are extracted from
/// the parent `ScalarFnArray`.
pub trait ZipReduce: VTable {
    fn zip(
        array: &Self::Array,
        if_false: &ArrayRef,
        mask: &ArrayRef,
    ) -> VortexResult<Option<ArrayRef>>;
}

/// Zip two arrays using a mask, potentially reading buffers.
///
/// Unlike [`ZipReduce`], this trait is for zip implementations that may need
/// to read and execute on the underlying buffers to produce the result.
///
/// Dispatch is on child 0 (if_true). The `if_false` and `mask` are extracted from
/// the parent `ScalarFnArray`.
pub trait ZipKernel: VTable {
    fn zip(
        array: &Self::Array,
        if_false: &ArrayRef,
        mask: &ArrayRef,
        ctx: &mut ExecutionCtx,
    ) -> VortexResult<Option<ArrayRef>>;
}

/// Adaptor that wraps a [`ZipReduce`] impl as an [`ArrayParentReduceRule`].
#[derive(Default, Debug)]
pub struct ZipReduceAdaptor<V>(pub V);

impl<V> ArrayParentReduceRule<V> for ZipReduceAdaptor<V>
where
    V: ZipReduce,
{
    type Parent = ExactScalarFn<ZipExpr>;

    fn reduce_parent(
        &self,
        array: &V::Array,
        parent: ScalarFnArrayView<'_, ZipExpr>,
        child_idx: usize,
    ) -> VortexResult<Option<ArrayRef>> {
        if child_idx != 0 {
            return Ok(None);
        }
        let scalar_fn_array = parent
            .as_opt::<ScalarFnVTable>()
            .vortex_expect("ExactScalarFn matcher confirmed ScalarFnArray");
        let children = scalar_fn_array.children();
        let if_false = &children[1];
        let mask_array = &children[2];
        <V as ZipReduce>::zip(array, if_false, mask_array)
    }
}

/// Adaptor that wraps a [`ZipKernel`] impl as an [`ExecuteParentKernel`].
#[derive(Default, Debug)]
pub struct ZipExecuteAdaptor<V>(pub V);

impl<V> ExecuteParentKernel<V> for ZipExecuteAdaptor<V>
where
    V: ZipKernel,
{
    type Parent = ExactScalarFn<ZipExpr>;

    fn execute_parent(
        &self,
        array: &V::Array,
        parent: ScalarFnArrayView<'_, ZipExpr>,
        child_idx: usize,
        ctx: &mut ExecutionCtx,
    ) -> VortexResult<Option<ArrayRef>> {
        if child_idx != 0 {
            return Ok(None);
        }
        let scalar_fn_array = parent
            .as_opt::<ScalarFnVTable>()
            .vortex_expect("ExactScalarFn matcher confirmed ScalarFnArray");
        let children = scalar_fn_array.children();
        let if_false = &children[1];
        let mask_array = &children[2];
        <V as ZipKernel>::zip(array, if_false, mask_array, ctx)
    }
}