apply PR comments

Author: soheilshahrouz

vpr/src/base/setup_noc.cpp

@@ -133,7 +133,7 @@ void create_noc_routers(const t_noc_inf& noc_info,
                         const vtr::vector<int, t_noc_router_tile_position>& noc_router_tiles) {
     // keep track of the router assignments (store the user router id that was assigned to each physical router tile)
     // this is used in error checking, after determining the closest physical router for a user described router in the arch file,
-    // the datastructure below can be used to check if that physical router was already assigned previously
+    // the data structure below can be used to check if that physical router was already assigned previously
     std::vector<int> router_assignments;
     router_assignments.resize(noc_router_tiles.size(), PHYSICAL_ROUTER_NOT_ASSIGNED);
 

vpr/src/base/setup_noc.h

@@ -58,7 +58,7 @@ struct t_noc_router_tile_position {
  * @brief Based on the NoC information provided by the user in the architecture
  *        description file, a NoC model is created. The model defines the
  *        constraints of the NoC as well as its layout on the FPGA device. 
- *        The datastructure used to define the model is  "NocStorage" and that
+ *        The data structure used to define the model is  "NocStorage" and that
  *        is created here and stored within the noc_ctx. 
  * 
  * @param arch Contains the parsed information from the architecture

vpr/src/base/vpr_api.cpp

@@ -545,7 +545,7 @@ void vpr_setup_clock_networks(t_vpr_setup& vpr_setup, const t_arch& Arch) {
  *        constraints. Additionally, the graphics state is updated
  *        to include a NoC button to display it.
  *
- * @param vpr_setup A datastructure that stores all the user provided option
+ * @param vpr_setup A data structure that stores all the user provided option
  *                  to vpr.
  * @param arch Contains the parsed information from the architecture
  *             description file.
@@ -1318,7 +1318,7 @@ static void free_routing() {
 }
 
 /**
- * @brief handles the deletion of NoC related datastructures.
+ * @brief handles the deletion of NoC related data structures.
  */
 static void free_noc() {}
 

vpr/src/noc/bfs_routing.cpp

@@ -28,9 +28,9 @@ void BFSRouting::route_flow(NocRouterId src_router_id,
     /*
      * As the routing goes through the NoC, each router visited has a
      * corresponding link that was used to reach the router. This
-     * datastructure stores the link that was used to visit each router in 
+     * data structure stores the link that was used to visit each router in
      * the NoC.
-     * Once the destination router has been found. This datastructure can be used to
+     * Once the destination router has been found. This data structure can be used to
      * trace the path back to the source router.
      */
     std::unordered_map<NocRouterId, NocLinkId> router_parent_link;

vpr/src/noc/noc_data_types.h

@@ -3,7 +3,7 @@
 
 /** 
  * @file 
- * @brief This file contains datatype definitions which are used by the NoC datastructures.
+ * @brief This file contains datatype definitions which are used by the NoC data structures.
  *  
  */
 

vpr/src/noc/noc_storage.h

@@ -71,7 +71,7 @@ class NocStorage {
      * in the architecture file. This ID system will be different than the
      * NocRouterIds assigned to each router. The user ID system will be 
      * arbitrary but the internal ID system used here will start at 0 and
-     * are dense since it is used to index the routers. The datastructure
+     * are dense since it is used to index the routers. The data structure
      * below is a conversiont able that maps the user router IDs to the
      * corresponding internal ones.
      */
@@ -82,12 +82,12 @@ class NocStorage {
      * location. During placement, when logical routers are moved to
      * different hard routers, only the grid location of where the
      * logical router was moved is known.
-     * Using this datastructure, the grid location can be used to
+     * Using this data structure, the grid location can be used to
      * identify the corresponding hard router block positioned at that grid 
      * location. The NocROuterId uniquely identifies hard router blocks and
      * can be used to retrieve the hard router block information using
      * the router_storage data structure above. This can also be used to
-     * access the connectivity graph datastructure above.
+     * access the connectivity graph data structure above.
      * 
      * It is important to know the specific hard router block because 
      * without it we cannot determine the starting/end points of the traffic
@@ -97,7 +97,7 @@ class NocStorage {
      * 
      * The intended use is when trying to re-route a traffic flow. The current
      * location of a logical router block can be used in conjunction with this
-     * datastructure to identify the corresponding hard router block.
+     * data structure to identify the corresponding hard router block.
      * 
      */
     std::unordered_map<int, NocRouterId> grid_location_to_router_id;
@@ -468,7 +468,7 @@ class NocStorage {
     void finished_building_noc();
 
     /**
-     * @brief Resets the NoC by clearing all internal datastructures.
+     * @brief Resets the NoC by clearing all internal data structures.
      * This includes deleting all routers and links. Also all internal
      * IDs are removed (the is conversion table is cleared). It is
      * recommended to run this function before building the NoC.
@@ -493,7 +493,7 @@ class NocStorage {
     int convert_router_id(NocRouterId id) const;
 
     /**
-     * @brief The datastructure that stores the outgoing links to each
+     * @brief The data structure that stores the outgoing links to each
      * router is an 2-D Vector. When processing the links, they can be
      * outgoing from any router in the NoC. Therefore the column size
      * of the 2-D vector needs to be the size of the number of routers
@@ -531,7 +531,7 @@ class NocStorage {
      * @brief Generates a unique integer using the x and y coordinates of a 
      * hard router block that can be used to identify it. This should be
      * used to generate the keys for the 'grid_location_to_router_id'
-     * datastructure.
+     * data structure.
      * 
      * The key will be generated as follows:
      * key = y * device_grid.width() + x

vpr/src/noc/noc_traffic_flows.cpp

@@ -95,7 +95,7 @@ void NocTrafficFlows::finished_noc_traffic_flows_setup() {
 }
 
 void NocTrafficFlows::clear_traffic_flows() {
-    // delete any information from internal datastructures
+    // delete any information from internal data structures
     noc_traffic_flows.clear();
     noc_traffic_flows_ids.clear();
     router_cluster_in_netlist.clear();

vpr/src/noc/noc_traffic_flows.h

@@ -18,7 +18,7 @@
  * wants to find traffic flows based on just the source or sink logical router.
  * The routes for the traffic flows are expected to change throughout placement
  * as routers will be moved within the chip. Therefore this class provides
- * a datastructure to keep track of which flows have been updated (re-routed).
+ * a data structure to keep track of which flows have been updated (re-routed).
  * 
  * Finally, this class also stores all router blocks (logical routers) in the 
  * design.
@@ -94,7 +94,7 @@ class NocTrafficFlows {
      * router. If the source/destination routers are moved, then the traffic
      * flow needs tp be re-routed. 
      * 
-     * This datastructure stores a vector of traffic flows that are associated
+     * This data structure stores a vector of traffic flows that are associated
      * to each router cluster block. A traffic flow is associated to a router
      * cluster block if the router block is either the source or destination
      * router within the traffic flow.
@@ -127,7 +127,7 @@ class NocTrafficFlows {
      * @param traffic_flow_id A unique id that represents a traffic flow.
      * @param associated_router_id A ClusterBlockId that represents a
      *                             router block. 
-     * @param router_associated_traffic_flows A datastructure that stores
+     * @param router_associated_traffic_flows A data structure that stores
      * a vector of traffic flows for a given router block where the traffic
      * flows have the router as a source or sink within the flow.
      *                                        
@@ -209,7 +209,7 @@ class NocTrafficFlows {
      * flows in the design. 
      * 
      * Finally, the newly created traffic flow is
-     * also added to internal datastructures that can be used to quickly
+     * also added to internal data structures that can be used to quickly
      * look up which traffic flows contain a specific router cluster block.
      * 
      * @param source_router_module_name A string that represents the
@@ -262,7 +262,7 @@ class NocTrafficFlows {
 
     /**
      * @brief Resets the class by clearing internal
-     * datastructures.
+     * data structures.
      */
     void clear_traffic_flows();
 
@@ -288,7 +288,7 @@ class NocTrafficFlows {
 
     /**
      * @brief Writes out the NocTrafficFlows class information to a file.
-     * This includes printing out each internal datastructure information.
+     * This includes printing out each internal data structure information.
      * 
      * @param file_name The name of the file that contains the NoC
      * traffic flow information   

vpr/src/noc/read_xml_noc_traffic_flows_file.h

@@ -164,7 +164,7 @@ void verify_traffic_flow_properties(double traffic_flow_bandwidth, double max_tr
  * @param router_module_name The name of the router module in the design for
  *                           which the corresponding block id needs to be found.
  * @param cluster_ctx Global variable that contains clustering information.
- *                    Contains a datastructure to convert a module name to
+ *                    Contains a data structure to convert a module name to
  *                    a cluster block id.
  * @param single_flow_tag A xml tag that contains the traffic flow information. 
  *                        Passed in for error logging.
@@ -197,7 +197,7 @@ ClusterBlockId get_router_module_cluster_id(const std::string& router_module_nam
  * @param loc_data Contains location data about the current line in the xml
  *                 file. Passed in for error logging.
  * @param cluster_ctx Global variable that contains clustering information.
- *                    Contains a datastructure to get the logical type of a 
+ *                    Contains a data structure to get the logical type of a
  *                    router cluster block.
  * @param noc_router_tile_type The physical type of a Noc router tile in the
  *                             FPGA. Used to check if the router block is
@@ -208,7 +208,7 @@ void check_traffic_flow_router_module_type(const std::string& router_module_name
 /**
  * @brief Retrieves the physical type of a noc router tile.
  * 
- * @param device_ctx Contains the device information. Has a datastructure that
+ * @param device_ctx Contains the device information. Has a data structure that
  *                   can determine a tile type based on grid position on the 
  *                   FPGA. 
  * @param noc_ctx Contains the NoC information. Used to get the grid position