comments are updated

Author: umariqbal-rs

vpr/src/base/vpr_context.h

@@ -169,13 +169,6 @@ struct DeviceContext : public Context {
      * for client functions: GUI, placer, router, timing analyzer etc.
      */
     RRGraphView rr_graph{rr_nodes, rr_graph_builder.node_lookup(), rr_indexed_data, rr_graph_builder.rr_segments(), rr_graph_builder.rr_switch()};
-
-    ///@brief Autogenerated in build_rr_graph based on switch fan-in. [0..(num_rr_switches-1)]
-    //vtr::vector<RRSwitchId, t_rr_switch_inf> rr_switch_inf;
-
-    ///@brief Wire segment types in RR graph
-    //vtr::vector<RRSegmentId, t_segment_inf> rr_segments;
-
     int num_arch_switches;
     t_arch_switch_inf* arch_switch_inf; // [0..(num_arch_switches-1)]
 

vpr/src/device/rr_graph_builder.h

@@ -41,7 +41,10 @@ class RRGraphBuilder {
     /** @brief Return a writable object for update the fast look-up of rr_node */
     RRSpatialLookup& node_lookup();
 
-    /** @brief Add a rr_segment to the routing resource graph. Return an valid id if successful.*/
+    /** @brief Add a rr_segment to the routing resource graph. Return an valid id if successful.
+     *  - Each rr_segment contains the detailed information of a routing track, which is denoted by a node in CHANX or CHANY type.
+     * - It is frequently used by client functions in timing and routability prediction.
+     */
     inline RRSegmentId add_rr_segment(const t_segment_inf& segment_info) {
         //Allocate an ID
         RRSegmentId segment_id = RRSegmentId(segment_ids_.size());
@@ -51,12 +54,17 @@ class RRGraphBuilder {
 
         return segment_id;
     }
-    /** @brief Return a writable list of all the rr_segments */
+    /** TODO @brief Return a writable list of all the rr_segments
+     * .. warning:: It is not recommended to use this API unless you have to. The API may be deprecated later, and future APIs will designed to return a specific data from the rr_segments.
+     */
     inline vtr::vector<RRSegmentId, t_segment_inf>& rr_segments() {
         return rr_segments_;
     }
 
-    /** @brief Add a rr_swtich_inf to the routing resource graph. Return an valid id if successful.*/
+    /** @brief Add a rr_switch to the routing resource graph. Return an valid id if successful.
+     *  - Each rr_switch contains the detailed information of a routing switch interconnecting two routing resource nodes.
+     * - It is frequently used by client functions in timing prediction.
+     */
     inline RRSwitchId add_rr_switch(const t_rr_switch_inf& switch_info) {
         //Allocate an ID
         RRSwitchId switch_id = RRSwitchId(switch_ids_.size());
@@ -66,7 +74,9 @@ class RRGraphBuilder {
 
         return switch_id;
     }
-    /** @brief Return a writable list of all the rr_switch_inf */
+    /** TODO @brief Return a writable list of all the rr_switches
+     * .. warning:: It is not recommended to use this API unless you have to. The API may be deprecated later, and future APIs will designed to return a specific data from the rr_switches.
+     */
     inline vtr::vector<RRSwitchId, t_rr_switch_inf>& rr_switch() {
         return rr_switch_inf_;
     }
@@ -280,17 +290,16 @@ class RRGraphBuilder {
     /* Fast look-up for rr nodes */
     RRSpatialLookup node_lookup_;
 
-    /* Segment relatex data
-     * Segment info should be corrected annotated for each rr_node
-     * whose type is CHANX and CHANY
+    /**  Wire segment types in RR graph
+     * - Each rr_segment contains the detailed information of a routing track, which is denoted by a node in CHANX or CHANY type.
+     * - We use a fly-weight data structure here, in the same philosophy as the rr_indexed_data. See detailed explanation in the t_segment_inf data structure
      */
     vtr::vector<RRSegmentId, t_segment_inf> rr_segments_; /* detailed information about the segments, which are used in the RRGraph */
     vtr::vector<RRSegmentId, RRSegmentId> segment_ids_;   /* unique identifiers for routing segments which are used in the RRGraph */
-    /* Switch related data
-     * Note that so far there has been no need to remove
-     * switches, so no such facility exists
+    /* Autogenerated in build_rr_graph based on switch fan-in.
+     *  - Each rr_switch contains the detailed information of a routing switch interconnecting two routing resource nodes.
+     *  - We use a fly-weight data structure here, in the same philosophy as the rr_indexed_data. See detailed explanation in the t_rr_switch_inf data structure
      */
-    /* Unique identifiers for switches which are used in the RRGraph */
     vtr::vector<RRSwitchId, RRSwitchId> switch_ids_;
     /* Detailed information about the switches, which are used in the RRGraph */
     vtr::vector<RRSwitchId, t_rr_switch_inf> rr_switch_inf_;