From 1af3efb38f97be6286cb37af9845f141ae369557 Mon Sep 17 00:00:00 2001
From: Inga <inga-lovinde@noreply.oomza.cutegay.software>
Date: Tue, 14 Nov 2023 11:38:11 +0000
Subject: [PATCH] improved comments

---
 hostnames_allocator/src/ranged_number_allocator.rs | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/hostnames_allocator/src/ranged_number_allocator.rs b/hostnames_allocator/src/ranged_number_allocator.rs
index c322edf..16d9a2b 100644
--- a/hostnames_allocator/src/ranged_number_allocator.rs
+++ b/hostnames_allocator/src/ranged_number_allocator.rs
@@ -1,6 +1,10 @@
 use std::{collections::BTreeMap, ops::Bound};
 
 pub struct RangedNumberAllocator {
+    // Keys are range starts, values are range ends (inclusive).
+    // The following invariants always hold:
+    // 1. key <= value;
+    // 2. if key1 < key2, then key1 < value1+1 < key2.
     pub tree: BTreeMap<u32, u32>,
 }
 
@@ -56,6 +60,7 @@ impl RangedNumberAllocator {
                     // There is another range; eliminated scenario 2, left with 3-4
                     if next_range_start == range_end + 2 {
                         // Scenario 3
+                        // Update current range end, and remove next range
                         *cursor.value_mut().unwrap() = next_range_end;
                         cursor.move_next();
                         cursor.remove_current_and_move_back().unwrap();
@@ -72,6 +77,7 @@ impl RangedNumberAllocator {
                 }
             } else if range_start == 2 {
                 // Scenario 5
+                // Replace current range with the one starting at 1
                 cursor.insert_before(1, range_end);
                 cursor.remove_current().unwrap();
                 return 1;
@@ -81,6 +87,7 @@ impl RangedNumberAllocator {
                 return 1;
             }
         } else {
+            // Scenario 1
             cursor.insert_after(1, 1);
             return 1;
         }