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

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

use crate::Canonical;
use crate::builders::ArrayBuilder;
use crate::vtable::VTable;

// TODO(ngates): rename to `DecodeVTable`.
pub trait CanonicalVTable<V: VTable> {
    /// Returns the canonical representation of the array.
    ///
    /// ## Post-conditions
    /// - The length is equal to that of the input array.
    /// - The [`vortex_dtype::DType`] is equal to that of the input array.
    // TODO(ngates): rename to `decode`
    fn canonicalize(array: &V::Array) -> Canonical;

    /// Writes the array into a canonical builder.
    ///
    /// ## Post-conditions
    /// - The length of the builder is incremented by the length of the input array.
    fn append_to_builder(array: &V::Array, builder: &mut dyn ArrayBuilder) {
        let canonical = Self::canonicalize(array);
        builder.extend_from_array(canonical.as_ref())
    }
}