Moved rectangle intersection code to vtr_geometry file and refactored region functions accordingly

Author: sfkhalid

libs/libvtrutil/src/vtr_geometry.h

@@ -141,6 +141,10 @@ class Rect {
 template<class T>
 Rect<T> bounding_box(const Rect<T>& lhs, const Rect<T>& rhs);
 
+//Return the intersection (union) of two given rectangles
+template<class T>
+Rect<T> intersection(const Rect<T>& lhs, const Rect<T>& rhs);
+
 //Sample on a uniformly spaced grid within a rectangle
 //  sample(vtr::Rect(l, h), 0, 0, M) == l
 //  sample(vtr::Rect(l, h), M, M, M) == h

libs/libvtrutil/src/vtr_geometry.tpp

@@ -182,6 +182,13 @@ Rect<T> bounding_box(const Rect<T>& lhs, const Rect<T>& rhs) {
                    std::max(lhs.ymax(), rhs.ymax()));
 }
 
+template<class T>
+Rect<T> intersection(const Rect<T>& lhs, const Rect<T>& rhs) {
+    return Rect<T>(std::max(lhs.xmin(), rhs.xmin()),
+                   std::max(lhs.ymin(), rhs.ymin()),
+                   std::min(lhs.xmax(), rhs.xmax()),
+                   std::min(lhs.ymax(), rhs.ymax()));
+}
 //Only defined for integral types
 template<typename T, typename std::enable_if<std::is_integral<T>::value>::type...>
 Point<T> sample(const vtr::Rect<T>& r, T x, T y, T d) {

vpr/src/base/region.cpp

@@ -13,8 +13,8 @@ Region::Region() {
     region_bounds.set_ymax(-1);
 }
 
-vtr::Rect<int> Region::get_region_rect(){
-	return region_bounds;
+vtr::Rect<int> Region::get_region_rect() {
+    return region_bounds;
 }
 
 int Region::get_xmin() {
@@ -51,25 +51,16 @@ void Region::set_sub_tile(int _sub_tile) {
 bool Region::do_regions_intersect(Region region) {
     bool intersect = true;
 
-    int x_min_1 = region.get_xmin();
-    int x_min_2 = region_bounds.xmin();
-    int int_x_min = std::max(x_min_1, x_min_2);
+    vtr::Rect<int> region_rect = region.get_region_rect();
+    vtr::Rect<int> intersect_rect;
 
-    int y_min_1 = region.get_ymin();
-    int y_min_2 = region_bounds.ymin();
-    int int_y_min = std::max(y_min_1, y_min_2);
+    intersect_rect = intersection(region_bounds, region_rect);
 
-    int x_max_1 = region.get_xmax();
-    int x_max_2 = region_bounds.xmax();
-    int int_x_max = std::min(x_max_1, x_max_2);
-
-    int y_max_1 = region.get_ymax();
-    int y_max_2 = region_bounds.ymax();
-    int int_y_max = std::min(y_max_1, y_max_2);
-
-    //check if rectangles dimensions are invalid
-    if (int_x_min > int_x_max || int_y_min > int_y_max) {
-        intersect = false;
+    /**if the intersection rectangle is empty or the subtile of the two regions does not match,
+     * the regions do not intersect
+     */
+    if (intersect_rect.empty() || sub_tile != region.get_sub_tile()) {
+        return intersect = false;
     }
 
     return intersect;
@@ -78,23 +69,15 @@ bool Region::do_regions_intersect(Region region) {
 Region Region::regions_intersection(Region region) {
     Region intersect;
 
-    int x_min_1 = region.get_xmin();
-    int x_min_2 = region_bounds.xmin();
-    int int_x_min = std::max(x_min_1, x_min_2);
-
-    int y_min_1 = region.get_ymin();
-    int y_min_2 = region_bounds.ymin();
-    int int_y_min = std::max(y_min_1, y_min_2);
+    vtr::Rect<int> region_rect = region.get_region_rect();
+    vtr::Rect<int> intersect_rect;
 
-    int x_max_1 = region.get_xmax();
-    int x_max_2 = region_bounds.xmax();
-    int int_x_max = std::min(x_max_1, x_max_2);
+    intersect_rect = intersection(region_bounds, region_rect);
 
-    int y_max_1 = region.get_ymax();
-    int y_max_2 = region_bounds.ymax();
-    int int_y_max = std::min(y_max_1, y_max_2);
-
-    intersect.set_region_rect(int_x_min, int_y_min, int_x_max, int_y_max);
+    intersect.set_region_rect(intersect_rect.xmin(), intersect_rect.ymin(), intersect_rect.xmax(), intersect_rect.ymax());
+    if (sub_tile == region.get_sub_tile()) {
+        intersect.set_sub_tile(sub_tile);
+    }
 
     return intersect;
 }

vpr/test/test_vpr_constraints.cpp

@@ -125,12 +125,12 @@ TEST_CASE("VprConstraintsAccessors", "[vpr]") {
 }
 
 TEST_CASE("RegionIntersect", "[vpr]") {
-	//Test partial intersection
+    //Test partial intersection
     Region region1;
     Region region2;
 
-    region1.set_region_rect(1,2,3,5);
-    region2.set_region_rect(2,3,4,6);
+    region1.set_region_rect(1, 2, 3, 5);
+    region2.set_region_rect(2, 3, 4, 6);
 
     Region int_reg;
 
@@ -144,29 +144,29 @@ TEST_CASE("RegionIntersect", "[vpr]") {
 
     //Test full overlap
     Region region3;
-	Region region4;
+    Region region4;
 
-	region3.set_region_rect(5,1,8,6);
-	region4.set_region_rect(6,3,8,6);
+    region3.set_region_rect(5, 1, 8, 6);
+    region4.set_region_rect(6, 3, 8, 6);
 
-	Region int_reg_2;
+    Region int_reg_2;
 
-	int_reg_2 = region3.regions_intersection(region4);
-	vtr::Rect<int> rect_2 = int_reg_2.get_region_rect();
+    int_reg_2 = region3.regions_intersection(region4);
+    vtr::Rect<int> rect_2 = int_reg_2.get_region_rect();
 
-	REQUIRE(rect_2.xmin() == 6);
-	REQUIRE(rect_2.ymin() == 3);
-	REQUIRE(rect_2.xmax() == 8);
-	REQUIRE(rect_2.ymax() == 6);
+    REQUIRE(rect_2.xmin() == 6);
+    REQUIRE(rect_2.ymin() == 3);
+    REQUIRE(rect_2.xmax() == 8);
+    REQUIRE(rect_2.ymax() == 6);
 
-	//Test no intersection (rect is empty)
+    //Test no intersection (rect is empty)
 
-	Region int_reg_3;
+    Region int_reg_3;
 
-	int_reg_3 = region1.regions_intersection(region3);
-	vtr::Rect<int> rect_3 = int_reg_3.get_region_rect();
+    int_reg_3 = region1.regions_intersection(region3);
+    vtr::Rect<int> rect_3 = int_reg_3.get_region_rect();
 
-	REQUIRE(rect_3.empty() == TRUE);
+    REQUIRE(rect_3.empty() == TRUE);
 }
 
 TEST_CASE("PartRegionIntersect", "[vpr]") {
@@ -206,16 +206,16 @@ TEST_CASE("RegionLocked", "[vpr]") {
     bool is_r1_locked = false;
 
     //set the region to a specific x, y, subtile location - region is locked
-    r1.set_region_rect(2,3,2,3); //point (2,3) to point (2,3) - locking to specific x, y location
-    r1.set_sub_tile(3);          //locking down to subtile 3
+    r1.set_region_rect(2, 3, 2, 3); //point (2,3) to point (2,3) - locking to specific x, y location
+    r1.set_sub_tile(3);             //locking down to subtile 3
 
     is_r1_locked = r1.locked();
 
     REQUIRE(is_r1_locked == true);
 
     //do not set region to specific x, y location - region is not locked even if a subtile is specified
-    r1.set_region_rect(2,3,5,6); //point (2,3) to point (5,6) - not locking to specific x, y location
-    r1.set_sub_tile(3);          //locking down to subtile 3
+    r1.set_region_rect(2, 3, 5, 6); //point (2,3) to point (5,6) - not locking to specific x, y location
+    r1.set_sub_tile(3);             //locking down to subtile 3
 
     is_r1_locked = r1.locked();
 
@@ -225,12 +225,11 @@ TEST_CASE("RegionLocked", "[vpr]") {
     Region r2;
     bool is_r2_locked = true;
 
-    r2.set_region_rect(2,3,2,3);
+    r2.set_region_rect(2, 3, 2, 3);
 
     is_r2_locked = r2.locked();
 
     REQUIRE(is_r2_locked == false);
-
 }
 
 TEST_CASE("PartRegionIntersect2", "[vpr]") {