risingwave_frontend/utils/
index_set.rs

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
127
128
129
130
131
132
133
134
135
136
137
// Copyright 2024 RisingWave Labs
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::ops::{BitAnd, BitOr};

use fixedbitset::FixedBitSet;

/// A set of deduplicated column indices.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct IndexSet {
    bitset: FixedBitSet,
}

impl IndexSet {
    /// Create an empty set.
    pub fn empty() -> Self {
        Self {
            bitset: FixedBitSet::new(),
        }
    }

    /// Get the number of indices.
    pub fn len(&self) -> usize {
        self.bitset.count_ones(..)
    }

    /// Check if the set is empty.
    pub fn is_empty(&self) -> bool {
        self.bitset.is_clear()
    }

    /// Check if the given index is contained.
    pub fn contains(&self, index: usize) -> bool {
        self.bitset.contains(index)
    }

    /// Iterator over indices.
    pub fn indices(&self) -> impl Iterator<Item = usize> + '_ {
        self.bitset.ones()
    }

    /// Convert to `Vec<usize>`.
    pub fn to_vec(&self) -> Vec<usize> {
        self.indices().collect()
    }

    /// Convert to `FixedBitSet`.
    pub fn to_bitset(&self) -> FixedBitSet {
        self.bitset.clone()
    }

    /// Iterator over indices as `u32`s. Please only use this when converting to protobuf.
    pub fn indices_as_u32(&self) -> impl Iterator<Item = u32> + '_ {
        self.bitset.ones().map(|i| i as u32)
    }

    /// Convert to `Vec<u32>`. Please only use this when converting to protobuf.
    pub fn to_vec_as_u32(&self) -> Vec<u32> {
        self.indices_as_u32().collect()
    }

    /// Insert an index.
    pub fn insert(&mut self, index: usize) {
        self.bitset.extend_one(index)
    }
}

impl Extend<usize> for IndexSet {
    fn extend<T: IntoIterator<Item = usize>>(&mut self, iter: T) {
        self.bitset.extend(iter)
    }
}

impl From<Vec<usize>> for IndexSet {
    fn from(vec: Vec<usize>) -> Self {
        vec.into_iter().collect()
    }
}

impl FromIterator<usize> for IndexSet {
    fn from_iter<T: IntoIterator<Item = usize>>(iter: T) -> Self {
        IndexSet {
            bitset: iter.into_iter().collect(),
        }
    }
}

impl BitAnd for IndexSet {
    type Output = IndexSet;

    fn bitand(self, rhs: Self) -> Self::Output {
        IndexSet {
            bitset: &self.bitset & &rhs.bitset,
        }
    }
}

impl BitAnd for &IndexSet {
    type Output = IndexSet;

    fn bitand(self, rhs: Self) -> Self::Output {
        IndexSet {
            bitset: &self.bitset & &rhs.bitset,
        }
    }
}

impl BitOr for IndexSet {
    type Output = IndexSet;

    fn bitor(self, rhs: Self) -> Self::Output {
        IndexSet {
            bitset: &self.bitset | &rhs.bitset,
        }
    }
}

impl BitOr for &IndexSet {
    type Output = IndexSet;

    fn bitor(self, rhs: Self) -> Self::Output {
        IndexSet {
            bitset: &self.bitset | &rhs.bitset,
        }
    }
}