|
| 1 | +// SPDX-License-Identifier: Apache-2.0 |
| 2 | +// SPDX-FileCopyrightText: Copyright the Vortex contributors |
| 3 | + |
| 4 | +//! Buffer-level filter dispatch. |
| 5 | +//! |
| 6 | +//! Provides [`filter_buffer`] which filters a [`Buffer<T>`] by [`MaskValues`], attempting an |
| 7 | +//! in-place filter when the buffer has exclusive ownership. |
| 8 | +
|
| 9 | +use vortex_buffer::Buffer; |
| 10 | +use vortex_mask::MaskValues; |
| 11 | + |
| 12 | +use crate::arrays::filter::execute::slice; |
| 13 | + |
| 14 | +/// Filter a [`Buffer<T>`] by [`MaskValues`], returning a new buffer. |
| 15 | +/// |
| 16 | +/// This will attempt to filter in-place (via [`Buffer::try_into_mut`]) when the buffer has |
| 17 | +/// exclusive ownership, avoiding an extra allocation. |
| 18 | +pub(super) fn filter_buffer<T: Copy>(buffer: Buffer<T>, mask: &MaskValues) -> Buffer<T> { |
| 19 | + match buffer.try_into_mut() { |
| 20 | + Ok(mut buffer_mut) => { |
| 21 | + let new_len = slice::filter_slice_mut_by_mask_values(buffer_mut.as_mut_slice(), mask); |
| 22 | + buffer_mut.truncate(new_len); |
| 23 | + buffer_mut.freeze() |
| 24 | + } |
| 25 | + // Otherwise, allocate a new buffer and fill it in. |
| 26 | + Err(buffer) => slice::filter_slice_by_mask_values(buffer.as_slice(), mask), |
| 27 | + } |
| 28 | +} |
| 29 | + |
| 30 | +#[cfg(test)] |
| 31 | +mod tests { |
| 32 | + use vortex_buffer::BufferMut; |
| 33 | + use vortex_buffer::buffer; |
| 34 | + use vortex_mask::Mask; |
| 35 | + |
| 36 | + use super::*; |
| 37 | + |
| 38 | + // Helper to get `MaskValues` from a `Mask`. |
| 39 | + fn mask_values(mask: &Mask) -> &MaskValues { |
| 40 | + match mask { |
| 41 | + Mask::Values(v) => v.as_ref(), |
| 42 | + _ => panic!("expected Mask::Values"), |
| 43 | + } |
| 44 | + } |
| 45 | + |
| 46 | + #[test] |
| 47 | + fn test_filter_buffer_by_indices() { |
| 48 | + let buf = buffer![10u32, 20, 30, 40, 50]; |
| 49 | + let mask = Mask::from_iter([true, false, true, false, true]); |
| 50 | + |
| 51 | + let result = filter_buffer(buf, mask_values(&mask)); |
| 52 | + assert_eq!(result, buffer![10u32, 30, 50]); |
| 53 | + } |
| 54 | + |
| 55 | + #[test] |
| 56 | + fn test_filter_indices_direct() { |
| 57 | + let buf = buffer![100u32, 200, 300, 400]; |
| 58 | + let mask = Mask::from_iter([true, false, true, true]); |
| 59 | + let result = filter_buffer(buf, mask_values(&mask)); |
| 60 | + assert_eq!(result, buffer![100u32, 300, 400]); |
| 61 | + } |
| 62 | + |
| 63 | + #[test] |
| 64 | + fn test_filter_sparse() { |
| 65 | + let buf = Buffer::from(BufferMut::from_iter(0u32..1000)); |
| 66 | + // Keep every third element. |
| 67 | + let mask = Mask::from_iter((0..1000).map(|i| i % 3 == 0)); |
| 68 | + |
| 69 | + let result = filter_buffer(buf, mask_values(&mask)); |
| 70 | + let expected: Vec<u32> = (0..1000).filter(|i| i % 3 == 0).collect(); |
| 71 | + assert_eq!(result.as_slice(), &expected[..]); |
| 72 | + } |
| 73 | + |
| 74 | + #[test] |
| 75 | + fn test_filter_dense() { |
| 76 | + let buf = buffer![1u32, 2, 3, 4, 5, 6, 7, 8, 9, 10]; |
| 77 | + // Dense selection (80% selected). |
| 78 | + let mask = Mask::from_iter([true, true, true, true, false, true, true, true, false, true]); |
| 79 | + |
| 80 | + let result = filter_buffer(buf, mask_values(&mask)); |
| 81 | + assert_eq!(result, buffer![1u32, 2, 3, 4, 6, 7, 8, 10]); |
| 82 | + } |
| 83 | +} |
0 commit comments