BitView

Signed-off-by: Nicholas Gates <[email protected]>

Author: gatesn

encodings/fastlanes/src/bitpacking/array/bitpack_pipeline.rs

@@ -3,8 +3,9 @@
 
 use fastlanes::{BitPacking, FastLanes};
 use static_assertions::const_assert_eq;
-use vortex_array::pipeline::bit_view::BitView;
-use vortex_array::pipeline::{BindContext, Kernel, KernelCtx, N, PipelineInputs, PipelinedNode};
+use vortex_array::pipeline::{
+    BindContext, BitView, Kernel, KernelCtx, N, PipelineInputs, PipelinedNode,
+};
 use vortex_buffer::Buffer;
 use vortex_dtype::{PTypeDowncastExt, PhysicalPType, match_each_integer_ptype};
 use vortex_error::VortexResult;

vortex-array/src/pipeline/driver/input.rs

@@ -4,8 +4,7 @@
 use vortex_error::{VortexExpect, VortexResult};
 use vortex_vector::{VectorMut, VectorMutOps, VectorOps};
 
-use crate::pipeline::bit_view::BitView;
-use crate::pipeline::{Kernel, KernelCtx, N};
+use crate::pipeline::{BitView, Kernel, KernelCtx, N};
 
 /// A kernel that feeds a batch vector into the pipeline in chunks of size `N` with zero-copy.
 pub(super) struct InputKernel {

vortex-array/src/pipeline/driver/mod.rs

@@ -15,11 +15,10 @@ use vortex_mask::Mask;
 use vortex_utils::aliases::hash_map::{HashMap, RandomState};
 use vortex_vector::{Vector, VectorMut, VectorMutOps};
 
-use crate::pipeline::bit_view::{BitView, BitViewExt};
 use crate::pipeline::driver::allocation::{OutputTarget, allocate_vectors};
 use crate::pipeline::driver::bind::bind_kernels;
 use crate::pipeline::driver::toposort::topological_sort;
-use crate::pipeline::{Kernel, KernelCtx, N, PipelineInputs};
+use crate::pipeline::{BitView, Kernel, KernelCtx, N, PipelineInputs};
 use crate::{Array, ArrayEq, ArrayHash, ArrayOperator, ArrayRef, ArrayVisitor, Precision};
 
 /// A pipeline driver takes a Vortex array and executes it into a canonical vector.

vortex-array/src/pipeline/mod.rs

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: Copyright the Vortex contributors
 
-pub mod bit_view;
 pub mod driver;
 
 use vortex_error::{VortexExpect, VortexResult};
 use vortex_vector::{Vector, VectorMut};
 
-use crate::pipeline::bit_view::BitView;
+/// A view over a fixed-size `N`-bit vector used in Vortex pipeline execution.
+pub type BitView<'a> = vortex_buffer::BitView<'a, N_BYTES>;
 
 /// The number of elements in each step of a Vortex evaluation operator.
 pub const N: usize = 1024;

vortex-buffer/src/bit/buf_mut.rs

@@ -84,11 +84,6 @@ impl BitBufferMut {
         }
     }
 
-    /// Consumes the buffer and return the underlying byte buffer.
-    pub fn into_inner(self) -> ByteBufferMut {
-        self.buffer
-    }
-
     /// Create a new mutable buffer with requested `len` and all bits set to `true`.
     pub fn new_set(len: usize) -> Self {
         Self {
@@ -122,6 +117,16 @@ impl BitBufferMut {
         }
     }
 
+    /// Return the underlying byte buffer.
+    pub fn inner(&self) -> &ByteBufferMut {
+        &self.buffer
+    }
+
+    /// Consumes the buffer and return the underlying byte buffer.
+    pub fn into_inner(self) -> ByteBufferMut {
+        self.buffer
+    }
+
     /// Get the current populated length of the buffer.
     #[inline(always)]
     pub fn len(&self) -> usize {
@@ -134,6 +139,12 @@ impl BitBufferMut {
         self.len == 0
     }
 
+    /// Get the current bit offset of the buffer.
+    #[inline(always)]
+    pub fn offset(&self) -> usize {
+        self.offset
+    }
+
     /// Get the value at the requested index.
     #[inline(always)]
     pub fn value(&self, index: usize) -> bool {

vortex-buffer/src/bit/mod.rs

@@ -12,13 +12,15 @@ mod buf;
 mod buf_mut;
 mod macros;
 mod ops;
+mod view;
 
 pub use arrow_buffer::bit_chunk_iterator::{
     BitChunkIterator, BitChunks, UnalignedBitChunk, UnalignedBitChunkIterator,
 };
 pub use arrow_buffer::bit_iterator::{BitIndexIterator, BitIterator, BitSliceIterator};
 pub use buf::*;
 pub use buf_mut::*;
+pub use view::*;
 
 /// Get the bit value at `index` out of `buf`.
 #[inline(always)]