Skip to main content

reifydb_type/value/container/
bool.rs

1// SPDX-License-Identifier: Apache-2.0
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(Some)
181	}
182
183	pub fn slice(&self, start: usize, end: usize) -> Self {
184		let count = (end - start).min(self.len().saturating_sub(start));
185		let mut new_data = DataBitVec::spawn(&self.data, count);
186		for i in start..(start + count) {
187			DataBitVec::push(&mut new_data, DataBitVec::get(&self.data, i));
188		}
189		Self {
190			data: new_data,
191		}
192	}
193
194	pub fn filter(&mut self, mask: &S::BitVec) {
195		let mut new_data = DataBitVec::spawn(&self.data, DataBitVec::count_ones(mask));
196
197		for (i, keep) in DataBitVec::iter(mask).enumerate() {
198			if keep && i < self.len() {
199				DataBitVec::push(&mut new_data, DataBitVec::get(&self.data, i));
200			}
201		}
202
203		self.data = new_data;
204	}
205
206	pub fn reorder(&mut self, indices: &[usize]) {
207		let mut new_data = DataBitVec::spawn(&self.data, indices.len());
208
209		for &idx in indices {
210			if idx < self.len() {
211				DataBitVec::push(&mut new_data, DataBitVec::get(&self.data, idx));
212			} else {
213				DataBitVec::push(&mut new_data, false);
214			}
215		}
216
217		self.data = new_data;
218	}
219
220	pub fn take(&self, num: usize) -> Self {
221		Self {
222			data: DataBitVec::take(&self.data, num),
223		}
224	}
225}
226
227impl<S: Storage> IntoIterator for BoolContainer<S> {
228	type Item = Option<bool>;
229	type IntoIter = std::iter::Map<std::vec::IntoIter<bool>, fn(bool) -> Option<bool>>;
230
231	fn into_iter(self) -> Self::IntoIter {
232		let data: Vec<bool> = DataBitVec::iter(&self.data).collect();
233		data.into_iter().map(Some as fn(bool) -> Option<bool>)
234	}
235}
236
237impl Default for BoolContainer<Cow> {
238	fn default() -> Self {
239		Self::with_capacity(0)
240	}
241}
242
243#[cfg(test)]
244pub mod tests {
245	use super::*;
246	use crate::util::bitvec::BitVec;
247
248	#[test]
249	fn test_new() {
250		let data = vec![true, false, true];
251		let container = BoolContainer::new(data.clone());
252
253		assert_eq!(container.len(), 3);
254		assert_eq!(container.get(0), Some(true));
255		assert_eq!(container.get(1), Some(false));
256		assert_eq!(container.get(2), Some(true));
257	}
258
259	#[test]
260	fn test_from_vec() {
261		let data = vec![true, false, true];
262		let container = BoolContainer::from_vec(data);
263
264		assert_eq!(container.len(), 3);
265		assert_eq!(container.get(0), Some(true));
266		assert_eq!(container.get(1), Some(false));
267		assert_eq!(container.get(2), Some(true));
268
269		// All should be defined
270		for i in 0..3 {
271			assert!(container.is_defined(i));
272		}
273	}
274
275	#[test]
276	fn test_with_capacity() {
277		let container = BoolContainer::with_capacity(10);
278		assert_eq!(container.len(), 0);
279		assert!(container.is_empty());
280		assert!(container.capacity() >= 10);
281	}
282
283	#[test]
284	fn test_push() {
285		let mut container = BoolContainer::with_capacity(3);
286
287		container.push(true);
288		container.push(false);
289		container.push_default();
290
291		assert_eq!(container.len(), 3);
292		assert_eq!(container.get(0), Some(true));
293		assert_eq!(container.get(1), Some(false));
294		assert_eq!(container.get(2), Some(false)); // default pushes false
295
296		assert!(container.is_defined(0));
297		assert!(container.is_defined(1));
298		assert!(container.is_defined(2));
299	}
300
301	#[test]
302	fn test_extend() {
303		let mut container1 = BoolContainer::from_vec(vec![true, false]);
304		let container2 = BoolContainer::from_vec(vec![false, true]);
305
306		container1.extend(&container2).unwrap();
307
308		assert_eq!(container1.len(), 4);
309		assert_eq!(container1.get(0), Some(true));
310		assert_eq!(container1.get(1), Some(false));
311		assert_eq!(container1.get(2), Some(false));
312		assert_eq!(container1.get(3), Some(true));
313	}
314
315	#[test]
316	fn test_iter() {
317		let data = vec![true, false, true];
318		let container = BoolContainer::new(data);
319
320		let collected: Vec<Option<bool>> = container.iter().collect();
321		assert_eq!(collected, vec![Some(true), Some(false), Some(true)]);
322	}
323
324	#[test]
325	fn test_slice() {
326		let container = BoolContainer::from_vec(vec![true, false, true, false]);
327		let sliced = container.slice(1, 3);
328
329		assert_eq!(sliced.len(), 2);
330		assert_eq!(sliced.get(0), Some(false));
331		assert_eq!(sliced.get(1), Some(true));
332	}
333
334	#[test]
335	fn test_filter() {
336		let mut container = BoolContainer::from_vec(vec![true, false, true, false]);
337		let mask = BitVec::from_slice(&[true, false, true, false]);
338
339		container.filter(&mask);
340
341		assert_eq!(container.len(), 2);
342		assert_eq!(container.get(0), Some(true));
343		assert_eq!(container.get(1), Some(true));
344	}
345
346	#[test]
347	fn test_reorder() {
348		let mut container = BoolContainer::from_vec(vec![true, false, true]);
349		let indices = [2, 0, 1];
350
351		container.reorder(&indices);
352
353		assert_eq!(container.len(), 3);
354		assert_eq!(container.get(0), Some(true)); // was index 2
355		assert_eq!(container.get(1), Some(true)); // was index 0
356		assert_eq!(container.get(2), Some(false)); // was index 1
357	}
358
359	#[test]
360	fn test_reorder_with_out_of_bounds() {
361		let mut container = BoolContainer::from_vec(vec![true, false]);
362		let indices = [1, 5, 0]; // index 5 is out of bounds
363
364		container.reorder(&indices);
365
366		assert_eq!(container.len(), 3);
367		assert_eq!(container.get(0), Some(false)); // was index 1
368		assert_eq!(container.get(1), Some(false)); // out of bounds -> default (false)
369		assert_eq!(container.get(2), Some(true)); // was index 0
370	}
371
372	#[test]
373	fn testault() {
374		let container = BoolContainer::default();
375		assert_eq!(container.len(), 0);
376		assert!(container.is_empty());
377	}
378}