Describe MacaqueTS using bullet list

Author: aabduvakhobov

crates/modelardb_compression/src/models/macaque_v.rs

@@ -175,11 +175,11 @@ impl MacaqueV {
         let factorized_epsilon = abs_error_bound / 2f32.powi(exponent);
         // Rewriting the last 23 - ⌈log2 factorized_epsilon⌉ mantissa bits
         // never exceeds the error bound. However, in that case, one more bit
-        // can be rewritten if the majority of the least mantissa bits are 0.
-        // Thus, we rewrite bits using 23 - ⌊log2 factorized_epsilon⌋ and
+        // can be rewritten if the majority of the least significant mantissa bits
+        // are 0. Thus, we rewrite bits using 23 - ⌊log2 factorized_epsilon⌋ and
         // perform an extra check to ensure the error bound is not exceeded.
         // If the error bound is exceeded, we rewrite 23 - ⌈log2 factorized_epsilon⌉
-        // least mantissa bits.
+        // least significant mantissa bits.
         let mut rewrite_position = 23 - factorized_epsilon.log2().abs().floor() as i32;
         let mut rewritten_value = f32::from_bits(rewrite_bits_by_n(value_as_u32, rewrite_position));
 
@@ -319,7 +319,7 @@ pub fn grid(
     }
 }
 
-// Extract the unbiased exponent from single precision float.
+// Extract the unbiased exponent from `value`.
 fn get_exponent(value: f32) -> i32 {
     let n_bits: u32 = value.to_bits();
     let biased_exponent = ((n_bits >> 23) & 0xff) as i32;

crates/modelardb_compression/src/models/timestamps.rs

@@ -15,21 +15,20 @@
 
 //! Implementation of MacaqueTS, a lossless compression for timestamps. MacaqueTS uses
 //! optimized compression methods depending on the number of data points in a compressed segment
-//! and if its timestamps have been sampled at a regular sampling interval.
-//!
-//! - (1) If a segment only contains one data point, its timestamp is stored as both the segment's
+//! and if its timestamps have been sampled at a regular sampling interval:
+//! * If a segment only contains one data point, its timestamp is stored as both the segment's
 //!   `start_time` and `end_time`.
-//! - (2) If a segment only contains two data points, the timestamps are stored as the segment's
+//! * If a segment only contains two data points, the timestamps are stored as the segment's
 //!   `start_time` and `end_time`, respectively.
-//! - (3) If a segment contains more than two data points, the first and last timestamps
+//! * If a segment contains more than two data points, the first and last timestamps
 //!   are stored as the segment's `start_time` and `end_time`, respectively, while its
-//!   residual timestamps are compressed using one of two methods.
-//!    - (1) If the data points in the segment have been collected at a regular sampling interval,
-//!      the residual timestamps are compressed as the segment's length with the
-//!      prefix zero bits stripped.
-//!    - (2) If none of the above apply, an extended version of the compression method proposed
-//!      for timestamps for the time series management system Gorilla in the [Gorilla paper]
-//!      is used as a fallback.
+//!   residual timestamps are compressed using one of two methods:
+//!   * If the data points in the segment have been collected at a regular sampling interval,
+//!     the residual timestamps are compressed as the segment's length with the
+//!     prefix zero bits stripped.
+//!   * If none of the above apply, an extended version of the compression method proposed
+//!     for timestamps for the time series management system Gorilla in the [Gorilla paper]
+//!     is used as a fallback.
 //!
 //! MacaqueTS extends Gorilla's timestamp compression method by using zero as the first delta
 //! instead of computing it explicitly. MacaqueTS also extends the flag ranges used by Gorilla