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
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
123
124
125
126

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

use itertools::Itertools;
use vortex_dtype::NativePType;
use vortex_dtype::match_each_native_ptype;
use vortex_error::VortexResult;
use vortex_mask::Mask;

use crate::arrays::PrimitiveArray;
use crate::arrays::PrimitiveVTable;
use crate::compute::IsSortedIteratorExt;
use crate::compute::IsSortedKernel;
use crate::compute::IsSortedKernelAdapter;
use crate::register_kernel;

impl IsSortedKernel for PrimitiveVTable {
    fn is_sorted(&self, array: &PrimitiveArray) -> VortexResult<Option<bool>> {
        match_each_native_ptype!(array.ptype(), |P| {
            compute_is_sorted::<P>(array, false).map(Some)
        })
    }

    fn is_strict_sorted(&self, array: &PrimitiveArray) -> VortexResult<Option<bool>> {
        match_each_native_ptype!(array.ptype(), |P| {
            compute_is_sorted::<P>(array, true).map(Some)
        })
    }
}

register_kernel!(IsSortedKernelAdapter(PrimitiveVTable).lift());

#[derive(Copy, Clone)]
struct ComparablePrimitive<T: NativePType>(T);

impl<T> From<&T> for ComparablePrimitive<T>
where
    T: NativePType,
{
    fn from(value: &T) -> Self {
        Self(*value)
    }
}

impl<T> PartialOrd for ComparablePrimitive<T>
where
    T: NativePType,
{
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.0.total_compare(other.0))
    }
}

impl<T> PartialEq for ComparablePrimitive<T>
where
    T: NativePType,
{
    fn eq(&self, other: &Self) -> bool {
        self.0.is_eq(other.0)
    }
}

fn compute_is_sorted<T: NativePType>(array: &PrimitiveArray, strict: bool) -> VortexResult<bool> {
    match array.validity_mask()? {
        Mask::AllFalse(_) => Ok(!strict),
        Mask::AllTrue(_) => {
            let slice = array.as_slice::<T>();
            let iter = slice.iter().map(ComparablePrimitive::from);

            Ok(if strict {
                iter.is_strict_sorted()
            } else {
                iter.is_sorted()
            })
        }
        Mask::Values(mask_values) => {
            let iter = mask_values
                .bit_buffer()
                .iter()
                .zip_eq(array.as_slice::<T>())
                .map(|(is_valid, value)| is_valid.then_some(ComparablePrimitive::from(value)));

            Ok(if strict {
                iter.is_strict_sorted()
            } else {
                iter.is_sorted()
            })
        }
    }
}

#[cfg(test)]
mod tests {
    use rstest::rstest;
    use vortex_error::VortexExpect;

    use super::*;
    use crate::compute::is_sorted;
    use crate::compute::is_strict_sorted;

    #[rstest]
    #[case(PrimitiveArray::from_iter([1, 2, 3, 4, 5]), true)]
    #[case(PrimitiveArray::from_iter([1, 1, 2, 3, 4, 5]), true)]
    #[case(PrimitiveArray::from_option_iter([None, None, Some(1i32), Some(2)]), true)]
    #[case(PrimitiveArray::from_option_iter([None, None, Some(1i32), Some(1)]), true)]
    #[case(PrimitiveArray::from_option_iter([None, Some(5_u8), None]), false)]
    fn test_primitive_is_sorted(#[case] array: PrimitiveArray, #[case] expected: bool) {
        assert_eq!(
            is_sorted(array.as_ref()).vortex_expect("operation should succeed in test"),
            Some(expected)
        );
    }

    #[rstest]
    #[case(PrimitiveArray::from_iter([1, 2, 3, 4, 5]), true)]
    #[case(PrimitiveArray::from_iter([1, 1, 2, 3, 4, 5]), false)]
    #[case(PrimitiveArray::from_option_iter([None, None, Some(1i32), Some(2), None]), false)]
    #[case(PrimitiveArray::from_option_iter([None, None, Some(1i32), Some(1), None]), false)]
    #[case(PrimitiveArray::from_option_iter([None, Some(5_u8), None]), false)]
    fn test_primitive_is_strict_sorted(#[case] array: PrimitiveArray, #[case] expected: bool) {
        assert_eq!(
            is_strict_sorted(array.as_ref()).vortex_expect("operation should succeed in test"),
            Some(expected)
        );
    }
}