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
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors
use itertools::Itertools;
use vortex_error::VortexResult;
use vortex_error::vortex_bail;
use vortex_session::registry::Id;
use crate::Array;
use crate::ArrayRef;
use crate::ArrayVisitor;
use crate::session::ArrayRegistry;
/// Options for normalizing an array.
pub struct NormalizeOptions<'a> {
/// The set of allowed array encodings (in addition to the canonical ones) that are permitted
/// in the normalized array.
pub allowed: &'a ArrayRegistry,
/// The operation to perform when a non-allowed encoding is encountered.
pub operation: Operation,
}
/// The operation to perform when a non-allowed encoding is encountered.
pub enum Operation {
Error,
// TODO(joe): add into canonical variant
}
impl dyn Array + '_ {
/// Normalize the array according to given options.
///
/// This operation performs a recursive traversal of the array. Any non-allowed encoding is
/// normalized per the configured operation.
pub fn normalize(self: ArrayRef, options: &mut NormalizeOptions) -> VortexResult<ArrayRef> {
let array_ids = options.allowed.ids().collect_vec();
self.normalize_with_error(&array_ids)?;
// Note this takes ownership so we can at a later date remove non-allowed encodings.
Ok(self)
}
fn normalize_with_error(self: &ArrayRef, allowed: &[Id]) -> VortexResult<()> {
if !allowed.contains(&self.encoding_id()) {
vortex_bail!(AssertionFailed: "normalize forbids encoding ({})", self.encoding_id())
}
for child in ArrayVisitor::children(self) {
let child: ArrayRef = child;
child.normalize_with_error(allowed)?
}
Ok(())
}
}