vortex-array 0.59.4

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

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

use std::ops::Not;

use vortex_error::VortexResult;
use vortex_mask::Mask;

use crate::Array;
use crate::ArrayRef;
use crate::IntoArray;
use crate::arrays::ConstantArray;
use crate::builtins::ArrayBuiltins;
use crate::scalar::Scalar;

/// Replace values with null where the mask is true.
///
/// The returned array is nullable but otherwise has the same dtype and length as `array`.
///
/// This function returns a lazy `ScalarFnArray` wrapping the [`Mask`](crate::expr::mask::Mask)
/// expression that defers the actual masking operation until execution time. The mask is inverted
/// (true=mask-out becomes true=keep) and passed as a boolean child to the expression.
pub fn mask(array: &dyn Array, mask: &Mask) -> VortexResult<ArrayRef> {
    let mask = mask.not();
    match mask {
        Mask::AllTrue(_) => array.to_array().cast(array.dtype().as_nullable()),
        Mask::AllFalse(_) => Ok(ConstantArray::new(
            Scalar::null(array.dtype().as_nullable()),
            array.len(),
        )
        .into_array()),
        Mask::Values(val) => array.to_array().mask(val.into_array()),
    }
}