Skip to main content

reifydb_type/value/container/
bool.rs

1// SPDX-License-Identifier: MIT
2// Copyright (c) 2025 ReifyDB
3
4use std::{
5	fmt::{self, Debug},
6	ops::Deref,
7	result::Result as StdResult,
8};
9
10use serde::{Deserialize, Deserializer, Serialize, Serializer};
11
12use crate::{
13	Result,
14	storage::{Cow, DataBitVec, Storage},
15	util::bitvec::BitVec,
16	value::{Value, r#type::Type},
17};
18
19pub struct BoolContainer<S: Storage = Cow> {
20	data: S::BitVec,
21}
22
23impl<S: Storage> Clone for BoolContainer<S> {
24	fn clone(&self) -> Self {
25		Self {
26			data: self.data.clone(),
27		}
28	}
29}
30
31impl<S: Storage> Debug for BoolContainer<S>
32where
33	S::BitVec: Debug,
34{
35	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
36		f.debug_struct("BoolContainer").field("data", &self.data).finish()
37	}
38}
39
40impl<S: Storage> PartialEq for BoolContainer<S>
41where
42	S::BitVec: PartialEq,
43{
44	fn eq(&self, other: &Self) -> bool {
45		self.data == other.data
46	}
47}
48
49impl Serialize for BoolContainer<Cow> {
50	fn serialize<Ser: Serializer>(&self, serializer: Ser) -> StdResult<Ser::Ok, Ser::Error> {
51		#[derive(Serialize)]
52		struct Helper<'a> {
53			data: &'a BitVec,
54		}
55		Helper {
56			data: &self.data,
57		}
58		.serialize(serializer)
59	}
60}
61
62impl<'de> Deserialize<'de> for BoolContainer<Cow> {
63	fn deserialize<D: Deserializer<'de>>(deserializer: D) -> StdResult<Self, D::Error> {
64		#[derive(Deserialize)]
65		struct Helper {
66			data: BitVec,
67		}
68		let h = Helper::deserialize(deserializer)?;
69		Ok(BoolContainer {
70			data: h.data,
71		})
72	}
73}
74
75impl Deref for BoolContainer<Cow> {
76	type Target = BitVec;
77
78	fn deref(&self) -> &Self::Target {
79		&self.data
80	}
81}
82
83impl BoolContainer<Cow> {
84	pub fn new(data: Vec<bool>) -> Self {
85		Self {
86			data: BitVec::from_slice(&data),
87		}
88	}
89
90	pub fn with_capacity(capacity: usize) -> Self {
91		Self {
92			data: BitVec::with_capacity(capacity),
93		}
94	}
95
96	pub fn from_vec(data: Vec<bool>) -> Self {
97		Self {
98			data: BitVec::from_slice(&data),
99		}
100	}
101}
102
103impl<S: Storage> BoolContainer<S> {
104	pub fn from_parts(data: S::BitVec) -> Self {
105		Self {
106			data,
107		}
108	}
109
110	pub fn len(&self) -> usize {
111		DataBitVec::len(&self.data)
112	}
113
114	pub fn capacity(&self) -> usize {
115		DataBitVec::capacity(&self.data)
116	}
117
118	pub fn is_empty(&self) -> bool {
119		DataBitVec::len(&self.data) == 0
120	}
121
122	pub fn clear(&mut self) {
123		DataBitVec::clear(&mut self.data);
124	}
125
126	pub fn push(&mut self, value: bool) {
127		DataBitVec::push(&mut self.data, value);
128	}
129
130	pub fn push_default(&mut self) {
131		DataBitVec::push(&mut self.data, false);
132	}
133
134	pub fn get(&self, index: usize) -> Option<bool> {
135		if index < self.len() {
136			Some(DataBitVec::get(&self.data, index))
137		} else {
138			None
139		}
140	}
141
142	pub fn is_defined(&self, idx: usize) -> bool {
143		idx < self.len()
144	}
145
146	pub fn is_fully_defined(&self) -> bool {
147		true
148	}
149
150	pub fn data(&self) -> &S::BitVec {
151		&self.data
152	}
153
154	pub fn data_mut(&mut self) -> &mut S::BitVec {
155		&mut self.data
156	}
157
158	pub fn as_string(&self, index: usize) -> String {
159		if index < self.len() {
160			DataBitVec::get(&self.data, index).to_string()
161		} else {
162			"none".to_string()
163		}
164	}
165
166	pub fn get_value(&self, index: usize) -> Value {
167		if index < self.len() {
168			Value::Boolean(DataBitVec::get(&self.data, index))
169		} else {
170			Value::none_of(Type::Boolean)
171		}
172	}
173
174	pub fn extend(&mut self, other: &Self) -> Result<()> {
175		DataBitVec::extend_from(&mut self.data, &other.data);
176		Ok(())
177	}
178
179	pub fn iter(&self) -> impl Iterator<Item = Option<bool>> + '_ {
180		DataBitVec::iter(&self.data).map(|v| Some(v))
181	}
182
183	pub fn into_iter(self) -> impl Iterator<Item = Option<bool>> {
184		let data: Vec<bool> = DataBitVec::iter(&self.data).collect();
185		data.into_iter().map(|v| Some(v))
186	}
187
188	pub fn slice(&self, start: usize, end: usize) -> Self {
189		let count = (end - start).min(self.len().saturating_sub(start));
190		let mut new_data = DataBitVec::spawn(&self.data, count);
191		for i in start..(start + count) {
192			DataBitVec::push(&mut new_data, DataBitVec::get(&self.data, i));
193		}
194		Self {
195			data: new_data,
196		}
197	}
198
199	pub fn filter(&mut self, mask: &S::BitVec) {
200		let mut new_data = DataBitVec::spawn(&self.data, DataBitVec::count_ones(mask));
201
202		for (i, keep) in DataBitVec::iter(mask).enumerate() {
203			if keep && i < self.len() {
204				DataBitVec::push(&mut new_data, DataBitVec::get(&self.data, i));
205			}
206		}
207
208		self.data = new_data;
209	}
210
211	pub fn reorder(&mut self, indices: &[usize]) {
212		let mut new_data = DataBitVec::spawn(&self.data, indices.len());
213
214		for &idx in indices {
215			if idx < self.len() {
216				DataBitVec::push(&mut new_data, DataBitVec::get(&self.data, idx));
217			} else {
218				DataBitVec::push(&mut new_data, false);
219			}
220		}
221
222		self.data = new_data;
223	}
224
225	pub fn take(&self, num: usize) -> Self {
226		Self {
227			data: DataBitVec::take(&self.data, num),
228		}
229	}
230}
231
232impl Default for BoolContainer<Cow> {
233	fn default() -> Self {
234		Self::with_capacity(0)
235	}
236}
237
238#[cfg(test)]
239pub mod tests {
240	use super::*;
241	use crate::util::bitvec::BitVec;
242
243	#[test]
244	fn test_new() {
245		let data = vec![true, false, true];
246		let container = BoolContainer::new(data.clone());
247
248		assert_eq!(container.len(), 3);
249		assert_eq!(container.get(0), Some(true));
250		assert_eq!(container.get(1), Some(false));
251		assert_eq!(container.get(2), Some(true));
252	}
253
254	#[test]
255	fn test_from_vec() {
256		let data = vec![true, false, true];
257		let container = BoolContainer::from_vec(data);
258
259		assert_eq!(container.len(), 3);
260		assert_eq!(container.get(0), Some(true));
261		assert_eq!(container.get(1), Some(false));
262		assert_eq!(container.get(2), Some(true));
263
264		// All should be defined
265		for i in 0..3 {
266			assert!(container.is_defined(i));
267		}
268	}
269
270	#[test]
271	fn test_with_capacity() {
272		let container = BoolContainer::with_capacity(10);
273		assert_eq!(container.len(), 0);
274		assert!(container.is_empty());
275		assert!(container.capacity() >= 10);
276	}
277
278	#[test]
279	fn test_push() {
280		let mut container = BoolContainer::with_capacity(3);
281
282		container.push(true);
283		container.push(false);
284		container.push_default();
285
286		assert_eq!(container.len(), 3);
287		assert_eq!(container.get(0), Some(true));
288		assert_eq!(container.get(1), Some(false));
289		assert_eq!(container.get(2), Some(false)); // default pushes false
290
291		assert!(container.is_defined(0));
292		assert!(container.is_defined(1));
293		assert!(container.is_defined(2));
294	}
295
296	#[test]
297	fn test_extend() {
298		let mut container1 = BoolContainer::from_vec(vec![true, false]);
299		let container2 = BoolContainer::from_vec(vec![false, true]);
300
301		container1.extend(&container2).unwrap();
302
303		assert_eq!(container1.len(), 4);
304		assert_eq!(container1.get(0), Some(true));
305		assert_eq!(container1.get(1), Some(false));
306		assert_eq!(container1.get(2), Some(false));
307		assert_eq!(container1.get(3), Some(true));
308	}
309
310	#[test]
311	fn test_iter() {
312		let data = vec![true, false, true];
313		let container = BoolContainer::new(data);
314
315		let collected: Vec<Option<bool>> = container.iter().collect();
316		assert_eq!(collected, vec![Some(true), Some(false), Some(true)]);
317	}
318
319	#[test]
320	fn test_slice() {
321		let container = BoolContainer::from_vec(vec![true, false, true, false]);
322		let sliced = container.slice(1, 3);
323
324		assert_eq!(sliced.len(), 2);
325		assert_eq!(sliced.get(0), Some(false));
326		assert_eq!(sliced.get(1), Some(true));
327	}
328
329	#[test]
330	fn test_filter() {
331		let mut container = BoolContainer::from_vec(vec![true, false, true, false]);
332		let mask = BitVec::from_slice(&[true, false, true, false]);
333
334		container.filter(&mask);
335
336		assert_eq!(container.len(), 2);
337		assert_eq!(container.get(0), Some(true));
338		assert_eq!(container.get(1), Some(true));
339	}
340
341	#[test]
342	fn test_reorder() {
343		let mut container = BoolContainer::from_vec(vec![true, false, true]);
344		let indices = [2, 0, 1];
345
346		container.reorder(&indices);
347
348		assert_eq!(container.len(), 3);
349		assert_eq!(container.get(0), Some(true)); // was index 2
350		assert_eq!(container.get(1), Some(true)); // was index 0
351		assert_eq!(container.get(2), Some(false)); // was index 1
352	}
353
354	#[test]
355	fn test_reorder_with_out_of_bounds() {
356		let mut container = BoolContainer::from_vec(vec![true, false]);
357		let indices = [1, 5, 0]; // index 5 is out of bounds
358
359		container.reorder(&indices);
360
361		assert_eq!(container.len(), 3);
362		assert_eq!(container.get(0), Some(false)); // was index 1
363		assert_eq!(container.get(1), Some(false)); // out of bounds -> default (false)
364		assert_eq!(container.get(2), Some(true)); // was index 0
365	}
366
367	#[test]
368	fn test_default() {
369		let container = BoolContainer::default();
370		assert_eq!(container.len(), 0);
371		assert!(container.is_empty());
372	}
373}