[SQUASH ME] Documented to legalizer

Removed confusing / unused variables.

Author: AlexandreSinger

vpr/src/pack/cluster_legalizer.cpp

@@ -1194,12 +1194,12 @@ e_block_pack_status ClusterLegalizer::try_pack_molecule(t_pack_molecule* molecul
         }
     }
 
+    std::vector<t_pb_graph_node*> primitives_list(max_molecule_size, nullptr);
     e_block_pack_status block_pack_status = e_block_pack_status::BLK_STATUS_UNDEFINED;
     while (block_pack_status != e_block_pack_status::BLK_PASSED) {
         if (!get_next_primitive_list(cluster_placement_stats_ptr,
                                      molecule,
-                                     primitives_list,
-                                     force_site)) {
+                                     primitives_list.data())) {
             VTR_LOGV(log_verbosity > 3, "\t\tFAILED No candidate primitives available\n");
             block_pack_status = e_block_pack_status::BLK_FAILED_FEASIBLE;
             break; /* no more candidate primitives available, this molecule will not pack, return fail */
@@ -1392,7 +1392,6 @@ ClusterLegalizer::start_new_cluster(t_pack_molecule* molecule,
                !molecule_cluster[molecule].is_valid());
     // Safety asserts to ensure that the API was initialized properly.
     VTR_ASSERT_SAFE(cluster_placement_stats != nullptr &&
-                    primitives_list != nullptr &&
                     lb_type_rr_graphs != nullptr);
 
     const AtomContext& atom_ctx = g_vpr_ctx.atom();
@@ -1465,7 +1464,6 @@ e_block_pack_status ClusterLegalizer::add_mol_to_cluster(t_pack_molecule* molecu
                !molecule_cluster[molecule].is_valid());
     // Safety asserts to ensure that the API was initialized properly.
     VTR_ASSERT_SAFE(cluster_placement_stats != nullptr &&
-                    primitives_list != nullptr &&
                     lb_type_rr_graphs != nullptr);
 
     // Get the cluster.
@@ -1570,25 +1568,16 @@ ClusterLegalizer::ClusterLegalizer(const AtomNetlist& atom_netlist,
                                    ClusterLegalizationStrategy t_cluster_legalization_strategy,
                                    bool t_enable_pin_feasibility_filter,
                                    int t_feasible_block_array_size,
-                                   int t_log_verbosity,
-                                   int t_force_site) : prepacker(t_prepacker) {
-    // Ensure that this is not being initialized twice.
-    VTR_ASSERT(cluster_placement_stats == nullptr &&
-               primitives_list == nullptr &&
-               lb_type_rr_graphs == nullptr);
+                                   int t_log_verbosity) : prepacker(t_prepacker) {
     // Verify that the inputs are valid.
     VTR_ASSERT(t_lb_type_rr_graphs != nullptr);
 
     // Resize the atom_cluster lookup to make the accesses much cheaper.
     atom_cluster.resize(atom_netlist.blocks().size(), LegalizationClusterId::INVALID());
     // Allocate the cluster_placement_stats
     cluster_placement_stats = alloc_and_load_cluster_placement_stats();
-    // Allocate the primitives_lists
-    size_t max_molecule_size = prepacker.get_max_molecule_size();
-    primitives_list = new t_pb_graph_node*[max_molecule_size];
-    for (size_t i = 0; i < max_molecule_size; i++) {
-        primitives_list[i] = nullptr;
-    }
+    // Pre-compute the max size of any molecule.
+    max_molecule_size = prepacker.get_max_molecule_size();
     // Calculate the max cluster size
     //  - Limit maximum number of elements for each cluster to MAX_SHORT
     max_cluster_size = calc_max_cluster_size(logical_block_types);
@@ -1608,7 +1597,6 @@ ClusterLegalizer::ClusterLegalizer(const AtomNetlist& atom_netlist,
     enable_pin_feasibility_filter = t_enable_pin_feasibility_filter;
     feasible_block_array_size = t_feasible_block_array_size;
     log_verbosity = t_log_verbosity;
-    force_site = t_force_site;
     // Get the target external pin utilization
     // NOTE: This is really silly, but this can potentially fail. If it does
     //       it is important that everything is allocated. If not, when it fails
@@ -1714,24 +1702,9 @@ void ClusterLegalizer::finalize() {
 }
 
 ClusterLegalizer::~ClusterLegalizer() {
-    // Protect against double freeing.
-    // TODO: This may be able to be done better if this class had some flag
-    //       to indicate if it has been initialized or not.
-    if (primitives_list == nullptr) {
-        // Ensure that all of the allocated structures are nullptr.
-        VTR_ASSERT(cluster_placement_stats == nullptr &&
-                   primitives_list == nullptr &&
-                   lb_type_rr_graphs == nullptr);
-        return;
-    }
-    VTR_ASSERT(cluster_placement_stats != nullptr &&
-               primitives_list != nullptr &&
-               lb_type_rr_graphs != nullptr);
     // Reset. This is necessary to free the data within the clusters themselves.
     reset();
     // Free the cluster_placement_stats
     free_cluster_placement_stats(cluster_placement_stats);
-    // Free the primitives_list
-    delete[] primitives_list;
 }