fix: fix inconsistency comment about bitmap (#17452)

fix inconsistency comment about bitmap

Author: forsaken628

scripts/ci/deploy/config/databend-query-node-1.toml

@@ -105,6 +105,7 @@ auto_sync_interval = 60
 [storage]
 # fs | s3 | azblob | obs | oss
 type = "fs"
+# allow_insecure = true
 
 # Set a local folder to store your data.
 # Comment out this block if you're NOT using local file system as storage.

src/common/column/src/bitmap/immutable.rs

@@ -195,8 +195,8 @@ impl Bitmap {
     }
 
     /// Slices `self`, offsetting by `offset` and truncating up to `length` bits.
-    /// # Panic
-    /// Panics iff `offset + length > self.length`, i.e. if the offset and `length`
+    /// # Panics
+    /// Panic iff `offset + length > self.length`, i.e. if the offset and `length`
     /// exceeds the allocated capacity of `self`.
     #[inline]
     pub fn slice(&mut self, offset: usize, length: usize) {
@@ -233,8 +233,8 @@ impl Bitmap {
     }
 
     /// Slices `self`, offsetting by `offset` and truncating up to `length` bits.
-    /// # Panic
-    /// Panics iff `offset + length > self.length`, i.e. if the offset and `length`
+    /// # Panics
+    /// Panic iff `offset + length > self.length`, i.e. if the offset and `length`
     /// exceeds the allocated capacity of `self`.
     #[inline]
     #[must_use]
@@ -358,17 +358,17 @@ impl Bitmap {
     }
 
     /// Creates a new [`Bitmap`] from a slice and length.
-    /// # Panic
-    /// Panics iff `length <= bytes.len() * 8`
+    /// # Panics
+    /// Panic iff `length > slice.as_ref().len() * 8`
     #[inline]
     pub fn from_u8_slice<T: AsRef<[u8]>>(slice: T, length: usize) -> Self {
         Bitmap::try_new(slice.as_ref().to_vec(), length).unwrap()
     }
 
     /// Alias for `Bitmap::try_new().unwrap()`
     /// This function is `O(1)`
-    /// # Panic
-    /// This function panics iff `length <= bytes.len() * 8`
+    /// # Panics
+    /// This function panics iff `length > vec.len() * 8`
     #[inline]
     pub fn from_u8_vec(vec: Vec<u8>, length: usize) -> Self {
         Bitmap::try_new(vec, length).unwrap()

src/common/column/src/bitmap/utils/mod.rs

@@ -65,24 +65,24 @@ pub fn set(byte: u8, i: usize, value: bool) -> u8 {
 
 /// Sets bit at position `i` in `data`
 /// # Panics
-/// panics if `i >= data.len() / 8`
+/// This function will panic iff `i / 8 >= data.len()`
 #[inline]
 pub fn set_bit(data: &mut [u8], i: usize, value: bool) {
     data[i / 8] = set(data[i / 8], i % 8, value);
 }
 
 /// Sets bit at position `i` in `data` without doing bound checks
 /// # Safety
-/// caller must ensure that `i < data.len() / 8`
+/// caller must ensure that `i / 8 < data.len()`
 #[inline]
 pub unsafe fn set_bit_unchecked(data: &mut [u8], i: usize, value: bool) {
     let byte = data.get_unchecked_mut(i / 8);
     *byte = set(*byte, i % 8, value);
 }
 
 /// Returns whether bit at position `i` in `data` is set
-/// # Panic
-/// This function panics iff `i / 8 >= bytes.len()`
+/// # Panics
+/// This function will panic iff `i / 8 >= bytes.len()`
 #[inline]
 pub fn get_bit(bytes: &[u8], i: usize) -> bool {
     is_set(bytes[i / 8], i % 8)
@@ -91,7 +91,7 @@ pub fn get_bit(bytes: &[u8], i: usize) -> bool {
 /// Returns whether bit at position `i` in `data` is set or not.
 ///
 /// # Safety
-/// `i >= data.len() * 8` results in undefined behavior
+/// `i / 8 >= data.len()` results in undefined behavior
 #[inline]
 pub unsafe fn get_bit_unchecked(data: &[u8], i: usize) -> bool {
     (*data.as_ptr().add(i >> 3) & BIT_MASK[i & 7]) != 0
@@ -105,7 +105,7 @@ pub fn bytes_for(bits: usize) -> usize {
 
 /// Returns the number of zero bits in the slice offsetted by `offset` and a length of `length`.
 /// # Panics
-/// This function panics iff `(offset + len).saturating_add(7) / 8 >= slice.len()`
+/// This function panics iff `(offset + len + 7) / 8 > slice.len()`
 /// because it corresponds to the situation where `len` is beyond bounds.
 pub fn count_zeros(slice: &[u8], offset: usize, len: usize) -> usize {
     if len == 0 {