WIP

IntersectMBO · Dec 1, 2023 · 9c7d94c · 9c7d94c
1 parent f269aea
commit 9c7d94c
Showing 1 changed file with 9 additions and 7 deletions.
diff --git a/bench/cardano-topology/src/Cardano/Benchmarking/Topology.hs b/bench/cardano-topology/src/Cardano/Benchmarking/Topology.hs
@@ -89,6 +89,7 @@ data Spec = Spec
 idName :: Int -> String
 idName = ("node-" <>) . show
 
+-- | Create a node from Spec adding the default values.
 mkNode :: Spec -> Types.Node
 mkNode Spec{..} = Types.Node{..} where
         name = idName nodeId
@@ -101,8 +102,8 @@ mkNode Spec{..} = Types.Node{..} where
 
 mkCoreNodes' :: CoreNodesParams -> [Spec]
 mkCoreNodes' Line{..} = breakLoop tpSize phase1 where
-        specIds = [0..(tpSize - 1)]
-        -- Assign locations and pool counts;  set initial links.
+        specIds = [0..(tpSize - 1)] -- Nodes ids starting from zero.
+        -- Assign pool counts, empty list of links and the only locations.
         phase0 = mkInitial <$> specIds
                 where
                         mkInitial :: Int -> Spec
@@ -116,8 +117,8 @@ mkCoreNodes' Line{..} = breakLoop tpSize phase1 where
         -- Connect into a ring
         phase1 = intraConnectRing False True phase0
 mkCoreNodes' UniCircle{..} = phase1 where
-        specIds = [0..(tpSize - 1)]
-        -- Assign locations and pool counts;  set initial links.
+        specIds = [0..(tpSize - 1)] -- Nodes ids starting from zero.
+        -- Assign pool counts, empty list of links and the only locations.
         phase0 = mkInitial <$> specIds
                 where
                         mkInitial :: Int -> Spec
@@ -131,9 +132,10 @@ mkCoreNodes' UniCircle{..} = phase1 where
         -- Connect into a ring
         phase1 = intraConnectRing False False phase0
 mkCoreNodes' Torus{..} = concat phase3 where
-        specIds = [0..(tpSize - 1)]
+        specIds = [0..(tpSize - 1)] -- Nodes ids starting from zero.
+        -- A list of repating locations (in the same order).
         specLocs = take tpSize $ cycle tpLocations
-        -- Assign locations and pool counts;  set initial links.
+        -- Assign pool counts, empty list of links and the locations in order.
         phase0 = zipWith mkInitial specIds specLocs
                 where
                         mkInitial :: Int -> Types.Location -> Spec
@@ -143,7 +145,7 @@ mkCoreNodes' Torus{..} = concat phase3 where
                                         , mpools = tpIdPools id
                                         , ..
                                 }
-        -- Split into per-location lists.
+        -- Split into per-location lists (list of lists).
         phase1 =
                         [
                                   filter ((== l) . loc) phase0