👷 tidy up comments in rle_codec.hpp

Author: AshleyRoll

include/msg/detail/rle_codec.hpp

@@ -55,8 +55,6 @@ template <typename BitSetType> class rle_decoder {
     //  - a positive number for the number of consecutive 1's
     //  - zero if there are no more bits to decode
     //
-    // This encoding is to support efficient intersection using a min-heap
-    //
     // Can traverse only a single time.
     class chunk_enumerator {
       public:
@@ -70,18 +68,14 @@ template <typename BitSetType> class rle_decoder {
         }
 
         // Get the current chunk of continuous bits. -ve values are 0s
-        // +ve values are 1s. range is -255...255. will return 0 if
+        // +ve values are 1s. range is -255...255. will return 0 if finished
         [[nodiscard]] constexpr auto bit_chunk() const -> std::int_fast16_t {
             return bit_value ? current_run : -current_run;
         }
 
         // Advance the bit chunk by the given number of bits. This might consume
         // only a portion of the remain bits in the chunk, skip to the next
         // chunk or skip over multiple chunks.
-        //
-        // Note: No bounds checking is done for efficiency
-        //       The caller is responsible for ensuring that the bitset bounds
-        //       are not exceeded while consuming data.
         constexpr void advance(std::size_t bits) {
             while (bits > 0 && bits_remaining > 0) {
                 // more available than we are consuming?
@@ -115,7 +109,7 @@ template <typename BitSetType> class rle_decoder {
                 return;
             }
 
-            // skipping the next bit for a >255 run?
+            // skipping the next bit count for a > 255 run?
             if (*rle_data == std::byte{0}) {
                 // keep same bit_value and skip this encoded byte
                 ++rle_data;
@@ -250,7 +244,7 @@ struct rle_intersect {
                 // chunks must also be 1s.
                 advance(static_cast<std::size_t>(chunk));
                 while (chunk-- > 0) {
-                    // call F, but abort if returns false
+                    // call F, but abort if it indicates abort requested
                     if (f(bit++)) {
                         return true; // early abort
                     }
@@ -296,6 +290,7 @@ struct rle_intersect {
     }
 };
 
+// at least 1 decoder is required
 template <typename Decoder, std::same_as<Decoder>... Others>
 rle_intersect(Decoder &&d, Others &&...others)
     -> rle_intersect<typename Decoder::bitset_type, Decoder, Others...>;