16992335779

Committed 15 Aug 2025 02:38PM UTC coverage: 87.202% (-0.5%) from 87.72%

Build # 16992335779

Build Type

Pull #2456

github

Committed by

web-flow

Commit Message

Merge 39c262e2c into 4a23f65b3

Pull Request Pull Request #2456: feat: basic BoolBuffer / BoolBufferMut

Run Details

476 of 1231 new or added lines in 107 files covered. (38.67%)

74 existing lines in 19 files now uncovered.

56525 of 64821 relevant lines covered (87.2%)

623742.27 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

82.29

/vortex-array/src/builders/bool.rs

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

use std::any::Any;

use arrow_buffer::BooleanBufferBuilder;
use vortex_dtype::{DType, Nullability};
use vortex_error::{VortexResult, vortex_bail};
use vortex_mask::Mask;

use crate::arrays::BoolArray;
use crate::builders::ArrayBuilder;
use crate::builders::lazy_validity_builder::LazyNullBufferBuilder;
use crate::{Array, ArrayRef, Canonical, IntoArray};

pub struct BoolBuilder {
    inner: BooleanBufferBuilder,
    nulls: LazyNullBufferBuilder,
    nullability: Nullability,
    dtype: DType,
}

impl BoolBuilder {
    pub fn new(nullability: Nullability) -> Self {
        Self::with_capacity(nullability, 1024) // Same as Arrow builders
    }

    pub fn with_capacity(nullability: Nullability, capacity: usize) -> Self {
        Self {
            inner: BooleanBufferBuilder::new(capacity),
            nulls: LazyNullBufferBuilder::new(capacity),
            nullability,
            dtype: DType::Bool(nullability),
        }
    }

    pub fn append_value(&mut self, value: bool) {
        self.append_values(value, 1)
    }

    pub fn append_values(&mut self, value: bool, n: usize) {
        self.inner.append_n(n, value);
        self.nulls.append_n_non_nulls(n)
    }

    pub fn append_option(&mut self, value: Option<bool>) {
        match value {
            Some(value) => self.append_value(value),
            None => self.append_null(),
        }
    }
}

impl ArrayBuilder for BoolBuilder {
    fn as_any(&self) -> &dyn Any {
        self
    }

    fn as_any_mut(&mut self) -> &mut dyn Any {
        self
    }

    fn dtype(&self) -> &DType {
        &self.dtype
    }

    fn len(&self) -> usize {
        self.inner.len()
    }

    fn append_zeros(&mut self, n: usize) {
        self.append_values(false, n)
    }

    fn append_nulls(&mut self, n: usize) {
        self.inner.append_n(n, false);
        self.nulls.append_n_nulls(n)
    }

    fn extend_from_array(&mut self, array: &dyn Array) -> VortexResult<()> {
        let array = array.to_canonical()?;
        let Canonical::Bool(array) = array else {
            vortex_bail!("Expected Canonical::Bool, found {:?}", array);
        };

        self.inner.append_buffer(array.boolean_buffer());
        self.nulls.append_validity_mask(array.validity_mask()?);

        Ok(())
    }

    fn ensure_capacity(&mut self, capacity: usize) {
        if capacity > self.inner.capacity() {
            self.nulls.ensure_capacity(capacity);
            self.inner.reserve(capacity - self.inner.capacity());
        }
    }

    fn set_validity(&mut self, validity: Mask) {
        self.nulls = LazyNullBufferBuilder::new(validity.len());
        self.nulls.append_validity_mask(validity);
    }

    fn finish(&mut self) -> ArrayRef {
        assert_eq!(
            self.nulls.len(),
            self.inner.len(),
            "Null count and value count should match when calling BoolBuilder::finish."
        );

        BoolArray::new(
            self.inner.finish(),
            self.nulls.finish_with_nullability(self.nullability),
        )
        .into_array()
    }
}

#[cfg(test)]
mod tests {
    use rand::prelude::StdRng;
    use rand::{Rng, SeedableRng};

    use crate::array::Array;
    use crate::arrays::{BoolArray, ChunkedArray};
    use crate::builders::builder_with_capacity;
    use crate::canonical::ToCanonical;
    use crate::vtable::ValidityHelper;
    use crate::{ArrayRef, IntoArray};
    fn make_opt_bool_chunks(len: usize, chunk_count: usize) -> ArrayRef {
        let mut rng = StdRng::seed_from_u64(0);

        (0..chunk_count)
            .map(|_| {
                BoolArray::from_iter((0..len).map(|_| match rng.random_range::<u8, _>(0..=2) {
                    0 => Some(false),
                    1 => Some(true),
                    2 => None,
                    _ => unreachable!(),
                }))
                .into_array()
            })
            .collect::<ChunkedArray>()
            .into_array()
    }

    #[test]
    fn tests() {
        let len = 1000;
        let chunk_count = 10;
        let chunk = make_opt_bool_chunks(len, chunk_count);

        let mut builder = builder_with_capacity(chunk.dtype(), len * chunk_count);
        chunk.clone().append_to_builder(builder.as_mut()).unwrap();
        let canon_into = builder
            .finish()
            .to_canonical()
            .unwrap()
            .into_bool()
            .unwrap();

        let into_canon = chunk.to_bool().unwrap();

        assert_eq!(canon_into.validity(), into_canon.validity());
        assert_eq!(canon_into.boolean_buffer(), into_canon.boolean_buffer());
    }
}

1	// SPDX-License-Identifier: Apache-2.0
2	// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4	use std::any::Any;
5
6	use arrow_buffer::BooleanBufferBuilder;
7	use vortex_dtype::{DType, Nullability};
8	use vortex_error::{VortexResult, vortex_bail};
9	use vortex_mask::Mask;
10
11	use crate::arrays::BoolArray;
12	use crate::builders::ArrayBuilder;
13	use crate::builders::lazy_validity_builder::LazyNullBufferBuilder;
14	use crate::{Array, ArrayRef, Canonical, IntoArray};
15
16	pub struct BoolBuilder {
17	inner: BooleanBufferBuilder,
18	nulls: LazyNullBufferBuilder,
19	nullability: Nullability,
20	dtype: DType,
21	}
22
23	impl BoolBuilder {
24	pub fn new(nullability: Nullability) -> Self {
25	Self::with_capacity(nullability, 1024) // Same as Arrow builders	×
26	}	×
27
28	pub fn with_capacity(nullability: Nullability, capacity: usize) -> Self {	5,888✔
29	Self {	5,888✔
30	inner: BooleanBufferBuilder::new(capacity),	5,888✔
31	nulls: LazyNullBufferBuilder::new(capacity),	5,888✔
32	nullability,	5,888✔
33	dtype: DType::Bool(nullability),	5,888✔
34	}	5,888✔
35	}	5,888✔
36
37	pub fn append_value(&mut self, value: bool) {	7,368✔
38	self.append_values(value, 1)	7,368✔
39	}	7,368✔
40
41	pub fn append_values(&mut self, value: bool, n: usize) {	7,368✔
42	self.inner.append_n(n, value);	7,368✔
43	self.nulls.append_n_non_nulls(n)	7,368✔
44	}	7,368✔
45
46	pub fn append_option(&mut self, value: Option<bool>) {	312✔
47	match value {	312✔
48	Some(value) => self.append_value(value),	312✔
UNCOV 49	None => self.append_null(),	×
50	}
51	}	312✔
52	}
53
54	impl ArrayBuilder for BoolBuilder {
55	fn as_any(&self) -> &dyn Any {
56	self	×
57	}	×
58
59	fn as_any_mut(&mut self) -> &mut dyn Any {	312✔
60	self	312✔
61	}	312✔
62
63	fn dtype(&self) -> &DType {	338✔
64	&self.dtype	338✔
65	}	338✔
66
67	fn len(&self) -> usize {	52✔
68	self.inner.len()	52✔
69	}	52✔
70
71	fn append_zeros(&mut self, n: usize) {
72	self.append_values(false, n)	×
73	}	×
74
75	fn append_nulls(&mut self, n: usize) {
76	self.inner.append_n(n, false);	×
NEW 77	self.nulls.append_n_nulls(n)	×
78	}	×
79
80	fn extend_from_array(&mut self, array: &dyn Array) -> VortexResult<()> {	303✔
81	let array = array.to_canonical()?;	303✔
82	let Canonical::Bool(array) = array else {	303✔
UNCOV 83	vortex_bail!("Expected Canonical::Bool, found {:?}", array);	×
84	};
85
86	self.inner.append_buffer(array.boolean_buffer());	303✔
87	self.nulls.append_validity_mask(array.validity_mask()?);	303✔
88
89	Ok(())	303✔
90	}	303✔
91
92	fn ensure_capacity(&mut self, capacity: usize) {
93	if capacity > self.inner.capacity() {	×
94	self.nulls.ensure_capacity(capacity);	×
95	self.inner.reserve(capacity - self.inner.capacity());	×
96	}	×
97	}	×
98
99	fn set_validity(&mut self, validity: Mask) {	91✔
100	self.nulls = LazyNullBufferBuilder::new(validity.len());	91✔
101	self.nulls.append_validity_mask(validity);	91✔
102	}	91✔
103
104	fn finish(&mut self) -> ArrayRef {	5,888✔
105	assert_eq!(	5,888✔
106	self.nulls.len(),	5,888✔
107	self.inner.len(),	5,888✔
UNCOV 108	"Null count and value count should match when calling BoolBuilder::finish."	×
109	);
110
111	BoolArray::new(	5,888✔
112	self.inner.finish(),	5,888✔
113	self.nulls.finish_with_nullability(self.nullability),	5,888✔
114	)	5,888✔
115	.into_array()	5,888✔
116	}	5,888✔
117	}
118
119	#[cfg(test)]
120	mod tests {
121	use rand::prelude::StdRng;
122	use rand::{Rng, SeedableRng};
123
124	use crate::array::Array;
125	use crate::arrays::{BoolArray, ChunkedArray};
126	use crate::builders::builder_with_capacity;
127	use crate::canonical::ToCanonical;
128	use crate::vtable::ValidityHelper;
129	use crate::{ArrayRef, IntoArray};
130	fn make_opt_bool_chunks(len: usize, chunk_count: usize) -> ArrayRef {	1✔
131	let mut rng = StdRng::seed_from_u64(0);	1✔
132
133	(0..chunk_count)	1✔
134	.map(\|_\| {	10✔
135	BoolArray::from_iter((0..len).map(\|_\| match rng.random_range::<u8, _>(0..=2) {	10,000✔
136	0 => Some(false),	3,350✔
137	1 => Some(true),	3,355✔
138	2 => None,	3,295✔
139	_ => unreachable!(),
140	}))	10,000✔
141	.into_array()	10✔
142	})	10✔
143	.collect::<ChunkedArray>()	1✔
144	.into_array()	1✔
145	}	1✔
146
147	#[test]
148	fn tests() {	1✔
149	let len = 1000;	1✔
150	let chunk_count = 10;	1✔
151	let chunk = make_opt_bool_chunks(len, chunk_count);	1✔
152
153	let mut builder = builder_with_capacity(chunk.dtype(), len * chunk_count);	1✔
154	chunk.clone().append_to_builder(builder.as_mut()).unwrap();	1✔
155	let canon_into = builder	1✔
156	.finish()	1✔
157	.to_canonical()	1✔
158	.unwrap()	1✔
159	.into_bool()	1✔
160	.unwrap();	1✔
161
162	let into_canon = chunk.to_bool().unwrap();	1✔
163
164	assert_eq!(canon_into.validity(), into_canon.validity());	1✔
165	assert_eq!(canon_into.boolean_buffer(), into_canon.boolean_buffer());	1✔
166	}	1✔
167	}

vortex-data / vortex / 16992335779

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous