Fix comments in greedy_seed_selector to refer to molecules instead of atoms

Author: AmirhosseinPoolad

vpr/src/pack/greedy_seed_selector.cpp

@@ -175,7 +175,7 @@ GreedySeedSelector::GreedySeedSelector(const AtomNetlist& atom_netlist,
                                        const LogicalModels& models,
                                        const PreClusterTimingManager& pre_cluster_timing_manager)
     : seed_mols_(prepacker.molecules().begin(), prepacker.molecules().end()) {
-    // Seed atoms list is initialized with all atoms in the atom netlist.
+    // Seed molecule list is initialized with all molecule in the netlist.
 
     // Pre-compute the criticality of each atom
     // Default criticalities set to zero (e.g. if not timing driven)
@@ -188,8 +188,8 @@ GreedySeedSelector::GreedySeedSelector(const AtomNetlist& atom_netlist,
         }
     }
 
-    // Maintain a lookup table of the seed gain for each atom. This will be
-    // used to sort the seed atoms.
+    // Maintain a lookup table of the seed gain for each molecule. This will be
+    // used to sort the seed molecules.
     // Initially all gains are zero.
     vtr::vector<PackMoleculeId, float> molecule_gains(seed_mols_.size(), 0.f);
 
@@ -236,20 +236,20 @@ GreedySeedSelector::GreedySeedSelector(const AtomNetlist& atom_netlist,
 
     // Set the starting seed index (the index of the first molecule to propose).
     // The index of the first seed to propose is the first molecule in the
-    // seed atoms vector (i.e. the one with the highest seed gain).
+    // seed molecules vector (i.e. the one with the highest seed gain).
     seed_index_ = 0;
 }
 
 PackMoleculeId GreedySeedSelector::get_next_seed(const ClusterLegalizer& cluster_legalizer) {
     while (seed_index_ < seed_mols_.size()) {
-        // Get the current seed atom at the seed index and increment the
+        // Get the current seed molecule at the seed index and increment the
         // seed index.
         // All previous seed indices have been either proposed already or
         // are already clustered. This process assumes that once an atom
         // is clustered it will never become unclustered.
         PackMoleculeId seed_molecule_id = seed_mols_[seed_index_++];
 
-        // If this atom has been clustered, it cannot be proposed as a seed.
+        // If this molecule has been clustered, it cannot be proposed as a seed.
         // Skip to the next seed.
         if (cluster_legalizer.is_mol_clustered(seed_molecule_id)) {
             continue;
@@ -258,7 +258,7 @@ PackMoleculeId GreedySeedSelector::get_next_seed(const ClusterLegalizer& cluster
     }
 
     // If the previous loop does not return a molecule, it implies that all
-    // atoms have been clustered or have already been proposed as a seed.
+    // molecule have been clustered or have already been proposed as a seed.
     // Return nullptr to signify that there are no further seeds.
     return PackMoleculeId::INVALID();
 }

vpr/src/pack/greedy_seed_selector.h

@@ -68,20 +68,18 @@ class GreedySeedSelector {
      * This method assumes that once a molecule is clustered, it will never be
      * unclustered.
      *
-     *  @param prepacker
-     *              The prepacker object that stores the molecules.
      *  @param cluster_legalizer
      *              The cluster legalizer object that is used to create the
      *              clusters. This is used to check if a molecule has already
      *              been clustered or not.
      */
     PackMoleculeId get_next_seed(const ClusterLegalizer& cluster_legalizer);
 
-    // TODO: Maybe create an update_seed_gains method to update the seed atoms
+    // TODO: Maybe create an update_seed_gains method to update the seed molecules
     //       list using current clustering information.
 
   private:
-    /// @brief The index of the next seed to propose in the seed_atoms vector.
+    /// @brief The index of the next seed to propose in the seed_mols_ vector.
     ///        This is set to 0 in the constructor and incremented as more seeds
     ///        are proposed.
     size_t seed_index_;