[VPR] Rework comments about the resize_nodes() in RRSpatialLookup

tangxifan · tangxifan · commit 45565f79be06 · 2021-05-31T19:19:30.000-06:00
diff --git a/vpr/src/device/rr_spatial_lookup.h b/vpr/src/device/rr_spatial_lookup.h
@@ -127,9 +127,8 @@ class RRSpatialLookup {
                       e_side side);
 
     /**
-     * Resize three dimensions of the lookup under a given type of node to be memory efficient
-     * This function is called to expand the matrix when x, y or side 
-     * when one or more of them beyond current capacity 
+     * Resize the given 3 dimensions (x, y, side) of the RRSpatialLookup data structure for the given type
+     * This function will keep any existing data
      *
      * Strongly recommend to use when the sizes of dimensions are deterministic
      *

Original file line number	Diff line number	Diff line change
`@@ -127,9 +127,8 @@ class RRSpatialLookup {`
`127`	`127`	`e_side side);`
`128`	`128`
`129`	`129`	`/**`
`130`		`- * Resize three dimensions of the lookup under a given type of node to be memory efficient`
`131`		`- * This function is called to expand the matrix when x, y or side`
`132`		`- * when one or more of them beyond current capacity`
	`130`	`+ * Resize the given 3 dimensions (x, y, side) of the RRSpatialLookup data structure for the given type`
	`131`	`+ * This function will keep any existing data`
`133`	`132`	`*`
`134`	`133`	`* Strongly recommend to use when the sizes of dimensions are deterministic`
`135`	`134`	`*`