[AP] Changed Block Type to Block Mobility

Feedback from Vaughn, who thinks that APBlockType was a bit ambiguous
and may cause problems later. He recommended calling it mobility
instead.

Author: AlexandreSinger

vpr/src/analytical_place/ap_netlist.cpp

@@ -21,15 +21,15 @@ const t_pack_molecule* APNetlist::block_molecule(const APBlockId id) const {
     return block_molecules_[id];
 }
 
-APBlockType APNetlist::block_type(const APBlockId id) const {
+APBlockMobility APNetlist::block_mobility(const APBlockId id) const {
     VTR_ASSERT_SAFE(valid_block_id(id));
 
-    return block_types_[id];
+    return block_mobilities_[id];
 }
 
 const APFixedBlockLoc& APNetlist::block_loc(const APBlockId id) const {
     VTR_ASSERT_SAFE(valid_block_id(id));
-    VTR_ASSERT(block_type(id) == APBlockType::FIXED);
+    VTR_ASSERT(block_mobility(id) == APBlockMobility::FIXED);
 
     return block_locs_[id];
 }
@@ -42,15 +42,15 @@ APBlockId APNetlist::create_block(const std::string& name, const t_pack_molecule
 
     // Initialize the data
     block_molecules_.insert(blk_id, mol);
-    block_types_.insert(blk_id, APBlockType::MOVEABLE);
+    block_mobilities_.insert(blk_id, APBlockMobility::MOVEABLE);
     block_locs_.insert(blk_id, APFixedBlockLoc());
 
     // Check post-conditions: size
     VTR_ASSERT(validate_block_sizes());
 
     // Check post-conditions: values
     VTR_ASSERT(block_molecule(blk_id) == mol);
-    VTR_ASSERT(block_type(blk_id) == APBlockType::MOVEABLE);
+    VTR_ASSERT(block_mobility(blk_id) == APBlockMobility::MOVEABLE);
 
     return blk_id;
 }
@@ -63,7 +63,7 @@ void APNetlist::set_block_loc(const APBlockId id, const APFixedBlockLoc& loc) {
         return;
 
     block_locs_[id] = loc;
-    block_types_[id] = APBlockType::FIXED;
+    block_mobilities_[id] = APBlockMobility::FIXED;
 }
 
 APPortId APNetlist::create_port(const APBlockId blk_id, const std::string& name, BitIndex width, PortType type) {
@@ -112,8 +112,8 @@ APNetId APNetlist::create_net(const std::string& name) {
 void APNetlist::clean_blocks_impl(const vtr::vector_map<APBlockId, APBlockId>& block_id_map) {
     // Update all the block molecules
     block_molecules_ = clean_and_reorder_values(block_molecules_, block_id_map);
-    // Update all the block types
-    block_types_ = clean_and_reorder_values(block_types_, block_id_map);
+    // Update all the block mobilities
+    block_mobilities_ = clean_and_reorder_values(block_mobilities_, block_id_map);
     // Update the fixed block locations
     block_locs_ = clean_and_reorder_values(block_locs_, block_id_map);
 }
@@ -150,7 +150,7 @@ void APNetlist::rebuild_net_refs_impl(const vtr::vector_map<APPinId, APPinId>& /
 void APNetlist::shrink_to_fit_impl() {
     // Block data
     block_molecules_.shrink_to_fit();
-    block_types_.shrink_to_fit();
+    block_mobilities_.shrink_to_fit();
     block_locs_.shrink_to_fit();
 }
 
@@ -176,7 +176,7 @@ void APNetlist::remove_net_impl(const APNetId /*net_id*/) {
 bool APNetlist::validate_block_sizes_impl(size_t num_blocks) const {
     if (block_molecules_.size() != num_blocks)
         return false;
-    if (block_types_.size() != num_blocks)
+    if (block_mobilities_.size() != num_blocks)
         return false;
     if (block_locs_.size() != num_blocks)
         return false;

vpr/src/analytical_place/ap_netlist.h

@@ -13,8 +13,9 @@
  * An example of a block is pack molecules, which are atoms which were prepacked
  * together.
  *
- * The nets in the netlist represent the logical connections between atom
- * blocks, where nets which are unused by Analytical Placement are ignored.
+ * The nets in the netlist represent the logical connections between AP
+ * blocks (inferred from the atom block connectivity), where nets which are
+ * unused by Analytical Placement are ignored.
  */
 
 #pragma once
@@ -42,11 +43,11 @@ struct APFixedBlockLoc {
 };
 
 /**
- * @brief The type of a block in the APNetlist
+ * @brief The mobility of a block in the APNetlist
  * TODO: It would be nice if the netlist contained lists of moveable and fixed
  *       block ids.
  */
-enum class APBlockType : bool {
+enum class APBlockMobility : bool {
     MOVEABLE,   // The block is not constrained in any dimension.
     FIXED       // The block is fixed.
 };
@@ -81,8 +82,8 @@ class APNetlist : public Netlist<APBlockId, APPortId, APPinId, APNetId> {
     /// @brief Returns the molecule that this block represents.
     const t_pack_molecule* block_molecule(const APBlockId id) const;
 
-    /// @brief Returns the type of this block.
-    APBlockType block_type(const APBlockId id) const;
+    /// @brief Returns the mobility of this block.
+    APBlockMobility block_mobility(const APBlockId id) const;
 
     /// @brief Returns the location of this block, if the block is fixed.
     ///        This method should not be used if the block is moveable.
@@ -180,7 +181,7 @@ class APNetlist : public Netlist<APBlockId, APPortId, APPinId, APNetId> {
     /// @brief Molecule of each block
     vtr::vector_map<APBlockId, const t_pack_molecule*> block_molecules_;
     /// @brief Type of each block
-    vtr::vector_map<APBlockId, APBlockType> block_types_;
+    vtr::vector_map<APBlockId, APBlockMobility> block_mobilities_;
     /// @brief Location of each block (if fixed).
     ///        NOTE: This vector will likely be quite sparse.
     vtr::vector_map<APBlockId, APFixedBlockLoc> block_locs_;

vpr/test/test_ap_netlist.cpp

@@ -57,11 +57,11 @@ TEST_CASE("test_ap_netlist_data_storage", "[vpr_ap_netlist]") {
     test_netlist.set_block_loc(fixed_block_id, fixed_block_loc);
 
     SECTION("Test block_type returns the correct block type") {
-        // Make sure the default block type is moveable.
-        REQUIRE(test_netlist.block_type(block_id_a) == APBlockType::MOVEABLE);
-        REQUIRE(test_netlist.block_type(block_id_c) == APBlockType::MOVEABLE);
-        // Make sure the fixed block is labelled as fixed.
-        REQUIRE(test_netlist.block_type(fixed_block_id) == APBlockType::FIXED);
+        // Make sure the default block mobility is moveable.
+        REQUIRE(test_netlist.block_mobility(block_id_a) == APBlockMobility::MOVEABLE);
+        REQUIRE(test_netlist.block_mobility(block_id_c) == APBlockMobility::MOVEABLE);
+        // Make sure the fixed block has a fixed mobility.
+        REQUIRE(test_netlist.block_mobility(fixed_block_id) == APBlockMobility::FIXED);
     }
 
     SECTION("Test block_loc returns the correct location") {