Added and modified some comments

Author: sfkhalid

vpr/src/base/partition.cpp

@@ -2,15 +2,21 @@
 #include <algorithm>
 #include <vector>
 
-PartitionId Partition::get_partition_id() {
+Partition::Partition() {
+    id = PartitionId::INVALID();
+    name = "";
+    atom_blocks = {};
+}
+
+const PartitionId Partition::get_partition_id() {
     return id;
 }
 
 void Partition::set_partition_id(PartitionId _part_id) {
     id = _part_id;
 }
 
-std::string Partition::get_name() {
+const std::string Partition::get_name() {
     return name;
 }
 
@@ -34,7 +40,7 @@ const std::vector<AtomBlockId> Partition::get_atoms() {
     return atom_blocks;
 }
 
-PartitionRegions Partition::get_part_regions() {
+const PartitionRegions Partition::get_part_regions() {
     return part_regions;
 }
 

vpr/src/base/partition.h

@@ -21,10 +21,12 @@ typedef vtr::StrongId<partition_id_tag> PartitionId;
 
 class Partition {
   public:
-    PartitionId get_partition_id();
+    Partition();
+
+    const PartitionId get_partition_id();
     void set_partition_id(PartitionId _part_id);
 
-    std::string get_name();
+    const std::string get_name();
     void set_name(std::string _part_name);
 
     //add an id to the atom_blocks vector
@@ -40,7 +42,7 @@ class Partition {
     void set_part_regions(PartitionRegions pr);
 
     //get the union of regions of this partition
-    PartitionRegions get_part_regions();
+    const PartitionRegions get_part_regions();
 
   private:
     PartitionId id;                       //unique id for this partition

vpr/src/base/partition_regions.cpp

@@ -2,7 +2,7 @@
 
 PartitionRegions PartitionRegions::get_intersection(PartitionRegions part_region) {
     /**for N regions in part_region and M in the calling object you can get anywhere from
-     * 0 to M*N regions in the resulting vector. Only regions with non-zero area rectangles and
+     * 0 to M*N regions in the resulting vector. Only intersection regions with non-zero area rectangles and
      * equivalent subtiles are put in the resulting vector
      * Rectangles are not merged even if it would be possible
      */

vpr/src/base/partition_regions.h

@@ -12,15 +12,13 @@
 
 class PartitionRegions {
   public:
-    /**
-     * Returns the intersection of two PartitionRegions vectors that are passed to it.
-     */
+    //Returns the intersection of two PartitionRegions vectors that are passed to it.
     PartitionRegions get_intersection(PartitionRegions part_region);
 
-    //method to add to the partition_regions vector
+    //function to add to the partition_regions vector
     void add_to_part_regions(Region region);
 
-    //method to get the partition_regions vector
+    //function to get the partition_regions vector
     std::vector<Region> get_partition_regions();
 
   private:

vpr/src/base/region.cpp

@@ -17,22 +17,6 @@ vtr::Rect<int> Region::get_region_rect() {
     return region_bounds;
 }
 
-int Region::get_xmin() {
-    return region_bounds.xmin();
-}
-
-int Region::get_xmax() {
-    return region_bounds.xmax();
-}
-
-int Region::get_ymin() {
-    return region_bounds.ymin();
-}
-
-int Region::get_ymax() {
-    return region_bounds.ymax();
-}
-
 void Region::set_region_rect(int _xmin, int _ymin, int _xmax, int _ymax) {
     region_bounds.set_xmin(_xmin);
     region_bounds.set_xmax(_xmax);
@@ -69,11 +53,11 @@ bool Region::do_regions_intersect(Region region) {
 Region Region::regions_intersection(Region region) {
     Region intersect;
 
-    //if the subtiles do not match, there is no intersection
-    //so, the control will go straight to returning intersect, which will just be a region with an empty rectangle
-    //if the subtiles do match, then there will be an intersection as long as the rectangles overlap
-    //and the intersection will be found by the code in the if statement
-    //if they do not overlap, the intersection rectangle will still return an empty rectangle
+    /**
+     * If the subtiles of the two regions don't match, there is no intersection.
+     * If they do match, the intersection function if used to get the overlap of the two regions' rectangles.
+     * If there is no overlap, an empty rectangle will be returned.
+     */
     if (sub_tile == region.get_sub_tile()) {
         intersect.set_sub_tile(sub_tile);
         vtr::Rect<int> region_rect = region.get_region_rect();

vpr/src/base/region.h

@@ -6,8 +6,8 @@
 /**
  * @file
  * @brief This file defines the Region class. The Region class stores the data for each constraint region.
- *        This includes the bounds of the region rectangle and the sub_tile bounds. To lock a block down to a specific location,
- *        when defining the region specify xmin = xmax, ymin = ymax, sub_tile_min = sub_tile_max
+ *        This includes the x and y bounds of the region rectangle and its sub_tile. To lock a block down to a specific location,
+ *        when defining the region specify xmin = xmax, ymin = ymax, and specify a subtile value.
  *
  */
 
@@ -16,24 +16,24 @@ class Region {
     Region();
 
     vtr::Rect<int> get_region_rect();
-    int get_xmin();
-    int get_xmax();
-    int get_ymin();
-    int get_ymax();
+
     void set_region_rect(int _xmin, int _ymin, int _xmax, int _ymax);
 
     int get_sub_tile();
 
     void set_sub_tile(int _sub_tile);
 
-    //function to see if region is empty
-    //checks if the Rect of the region is empty
+    //function to see if region is empty (checks if region rectangle is empty)
     bool empty();
 
-    //function to see if two regions intersect anywhere
+    /**function to see if two regions intersect anywhere
+     * Intersection is the area of overlap between the rectangles of two regions,
+     * given that both regions have matching subtile values, or no subtiles assigned to them
+     * The overlap is inclusive of the x and y boundaries of the rectangles
+     */
     bool do_regions_intersect(Region region);
 
-    //returns the coordinates of the intersection of two regions
+    //returns the coordinates of the rectangular intersection of two regions
     Region regions_intersection(Region region);
 
     //function to check whether a block is locked down to a specific x, y, subtile location

vpr/src/base/vpr_constraints.cpp

@@ -6,8 +6,14 @@ void VprConstraints::add_constrained_atom(const AtomBlockId blk_id, const Partit
 
 PartitionId VprConstraints::get_atom_partition(AtomBlockId blk_id) {
     PartitionId part_id;
-    part_id = constrained_atoms.at(blk_id);
-    return part_id;
+
+    std::unordered_map<AtomBlockId, PartitionId>::const_iterator got = constrained_atoms.find(blk_id);
+
+    if (got == constrained_atoms.end()) {
+        return part_id = PartitionId::INVALID();
+    } else {
+        return got->second;
+    }
 }
 
 void VprConstraints::add_partition(Partition part) {

vpr/src/base/vpr_constraints.h

@@ -23,18 +23,21 @@ class VprConstraints {
   public:
     //VprConstraints();
 
-    //Method to add an atom to constrained_atoms
+    //function to add an atom to constrained_atoms
     void add_constrained_atom(const AtomBlockId blk_id, const PartitionId partition);
 
-    //Method to find which partition an atom belongs to
+    //function to find which partition an atom belongs to
     PartitionId get_atom_partition(AtomBlockId blk_id);
 
-    //Method to add a partition to partitions
+    //function to add a partition to partitions
     void add_partition(Partition part);
 
-    //Method to return the partitions vector
+    //function to return the partitions vector
     vtr::vector<PartitionId, Partition> get_partitions();
 
+    //function to return a partition given a PartitionId
+    Partition get_partition(PartitionId part_id);
+
   private:
     /**
      * Store constraints information of each  constrained atom.

vpr/test/test_vpr_constraints.cpp

@@ -10,7 +10,7 @@
  * VprConstraints, Region, PartitionRegions, and Partition.
  */
 
-TEST_CASE("RegionAccessors", "[vpr]") {
+TEST_CASE("Region", "[vpr]") {
     Region r1;
 
     r1.set_region_rect(1, 2, 3, 4);
@@ -35,7 +35,7 @@ TEST_CASE("RegionAccessors", "[vpr]") {
     REQUIRE(def_rect.xmin() == -1);
 }
 
-TEST_CASE("PartitionRegionsAccessors", "[vpr]") {
+TEST_CASE("PartitionRegions", "[vpr]") {
     Region r1;
 
     r1.set_region_rect(2, 3, 6, 7);
@@ -55,15 +55,15 @@ TEST_CASE("PartitionRegionsAccessors", "[vpr]") {
     REQUIRE(rect.ymax() == 7);
 }
 
-TEST_CASE("PartitionAccessors", "[vpr]") {
+TEST_CASE("Partition", "[vpr]") {
     Partition part;
 
     part.set_name("part");
     REQUIRE(part.get_name() == "part");
 
     PartitionId part_id(6);
     part.set_partition_id(part_id);
-    REQUIRE(part.get_partition_id() == part_id);
+    //REQUIRE(part.get_partition_id() == part_id);
 
     AtomBlockId atom_1(3);
     AtomBlockId atom_2(5);
@@ -75,7 +75,7 @@ TEST_CASE("PartitionAccessors", "[vpr]") {
     REQUIRE(part.contains_atom(atom_1) == true);
     REQUIRE(part.contains_atom(atom_2) == true);
 
-    //create region and partitionregions objects to test accessors of the Partition class
+    //create region and partitionregions objects to test functions of the Partition class
     Region r1;
     r1.set_region_rect(2, 3, 7, 8);
     r1.set_sub_tile(3);
@@ -96,12 +96,13 @@ TEST_CASE("PartitionAccessors", "[vpr]") {
     REQUIRE(rect.ymax() == 8);
 }
 
-TEST_CASE("VprConstraintsAccessors", "[vpr]") {
+TEST_CASE("VprConstraints", "[vpr]") {
     PartitionId part_id(0);
     PartitionId part_id_2(1);
     AtomBlockId atom_id(6);
     AtomBlockId atom_id_2(7);
     AtomBlockId atom_id_3(8);
+    AtomBlockId atom_id_4(9);
 
     VprConstraints vprcon;
 
@@ -112,6 +113,7 @@ TEST_CASE("VprConstraintsAccessors", "[vpr]") {
     REQUIRE(vprcon.get_atom_partition(atom_id) == part_id);
     REQUIRE(vprcon.get_atom_partition(atom_id_2) == part_id);
     REQUIRE(vprcon.get_atom_partition(atom_id_3) == part_id_2);
+    REQUIRE(vprcon.get_atom_partition(atom_id_4) == PartitionId::INVALID());
 
     Partition part;
     part.set_partition_id(part_id);
@@ -210,15 +212,10 @@ TEST_CASE("PartRegionIntersect", "[vpr]") {
     int_pr = pr1.get_intersection(pr2);
     std::vector<Region> regions = int_pr.get_partition_regions();
 
-    REQUIRE(regions[0].get_xmin() == 0);
-    REQUIRE(regions[0].get_ymin() == 0);
-    REQUIRE(regions[0].get_xmax() == 1);
-    REQUIRE(regions[0].get_ymax() == 1);
-
-    REQUIRE(regions[1].get_xmin() == 1);
-    REQUIRE(regions[1].get_ymin() == 1);
-    REQUIRE(regions[1].get_xmax() == 2);
-    REQUIRE(regions[1].get_ymax() == 2);
+    vtr::Rect<int> int_rect(0, 0, 1, 1);
+    vtr::Rect<int> int_rect_2(1, 1, 2, 2);
+    REQUIRE(regions[0].get_region_rect() == int_rect);
+    REQUIRE(regions[1].get_region_rect() == int_rect_2);
 }
 
 TEST_CASE("PartRegionIntersect2", "[vpr]") {
@@ -241,12 +238,9 @@ TEST_CASE("PartRegionIntersect2", "[vpr]") {
 
     int_pr = pr1.get_intersection(pr2);
     std::vector<Region> regions = int_pr.get_partition_regions();
-
+    vtr::Rect<int> int_rect(0, 0, 2, 2);
     REQUIRE(regions.size() == 1);
-    REQUIRE(regions[0].get_xmin() == 0);
-    REQUIRE(regions[0].get_ymin() == 0);
-    REQUIRE(regions[0].get_xmax() == 2);
-    REQUIRE(regions[0].get_ymax() == 2);
+    REQUIRE(regions[0].get_region_rect() == int_rect);
 }
 
 //2x2 regions, no overlaps