fix format errors

Author: soheilshahrouz

libs/libarchfpga/src/physical_types.h

@@ -1808,15 +1808,23 @@ struct t_wire_switchpoints {
 
 /* Used to list information about a set of track segments that should connect through a switchblock */
 struct t_wireconn_inf {
-    std::vector<t_wire_switchpoints>
-        from_switchpoint_set; //The set of segment/wirepoints representing the 'from' set (union of all t_wire_switchpoints in vector)
-    std::vector<t_wire_switchpoints>
-        to_switchpoint_set; //The set of segment/wirepoints representing the 'to' set (union of all t_wire_switchpoints in vector)
-    SwitchPointOrder from_switchpoint_order = SwitchPointOrder::FIXED; //The desired from_switchpoint_set ordering
-    SwitchPointOrder to_switchpoint_order = SwitchPointOrder::FIXED;   //The desired to_switchpoint_set ordering
-    int switch_override_indx
-        = DEFAULT_SWITCH; // index in switch array of the switch used to override wire_switch of the 'to' set.
-        // DEFAULT_SWITCH is a sentinel value (i.e. the usual driving switch from a wire for the receiving wire will be used)
+    ///The set of segment/wirepoints representing the 'from' set (union of all t_wire_switchpoints in vector)
+    std::vector<t_wire_switchpoints> from_switchpoint_set;
+
+    ///The set of segment/wirepoints representing the 'to' set (union of all t_wire_switchpoints in vector)
+    std::vector<t_wire_switchpoints> to_switchpoint_set;
+
+    ///The desired from_switchpoint_set ordering
+    SwitchPointOrder from_switchpoint_order = SwitchPointOrder::FIXED;
+
+    ///The desired to_switchpoint_set ordering
+    SwitchPointOrder to_switchpoint_order = SwitchPointOrder::FIXED;
+
+    /** @brief index in switch array of the switch used to override wire_switch of the 'to' set.
+     * DEFAULT_SWITCH is a sentinel value (i.e. the usual driving switch from a wire for
+     * the receiving wire will be used)
+     */
+    int switch_override_indx = DEFAULT_SWITCH;
 
     std::string num_conns_formula; /* Specifies how many connections should be made for this wireconn.
                                     *

odin_ii/src/verilog/verilog_writer.cpp

@@ -53,7 +53,8 @@ inline void verilog::writer::_create_file(const char* file_name, const file_type
 
 void verilog::writer::_write(const netlist_t* netlist) {
     // to write the top module and netlist components
-    if (netlist) { /* [TODO] */ }
+    if (netlist) { /* [TODO] */
+    }
 
     // print out the rest od models, including DSPs in the target architecture
     t_model* model = Arch.models;

vpr/src/route/router_lookahead_compressed_map.h

@@ -64,20 +64,23 @@ class CompressedMapLookahead : public RouterLookahead {
     }
 };
 
-// This is a 5D array that stores estimates of the cost to reach a location at a particular distance away from the current location.
-// The router look-ahead is built under the assumption of translation-invariance, meaning the current location (in terms of x-y coordinates) is not crucial.
-// The indices of this array are as follows:
-//   from_layer: The layer number that the node under consideration is on.
-//   Chan type: The type of channel (x/y) that the node under consideration belongs to.
-//   Seg type: The type of segment (listed under "segmentlist" tag in the architecture file) that the node under consideration belongs to.
-//   to_layer: The layer number that the target node is on.
-//   compressed index: In this type of router look-ahead, we do not sample every x and y. Another data structure maps every x and y to
-//   an index. That index should be used here.
-
-typedef vtr::NdMatrix<util::Cost_Entry, 5>
-    t_compressed_wire_cost_map; //[0..num_layers][0..1][[0..num_seg_types-1][0..num_layers][compressed_idx]
-                                //[0..1] entry distinguish between CHANX/CHANY start nodes respectively
-    // The first index is the layer number that the node under consideration is on, and the forth index
-    // is the layer number that the target node is on.
+/**
+ * This is a 5D array that stores estimates of the cost to reach a location at a particular distance away from the current location.
+ *
+ * The router look-ahead is built under the assumption of translation-invariance, meaning the current location (in terms of x-y coordinates) is not crucial.
+ * The indices of this array are as follows:
+ * from_layer: The layer number that the node under consideration is on.
+ * Chan type: The type of channel (x/y) that the node under consideration belongs to.
+ * Seg type: The type of segment (listed under "segmentlist" tag in the architecture file) that the node under consideration belongs to.
+ * to_layer: The layer number that the target node is on.
+ * compressed index: In this type of router look-ahead, we do not sample every x and y. Another data structure maps every x and y to
+ * an index. That index should be used here.
+ *
+ * [0..num_layers][0..1][[0..num_seg_types-1][0..num_layers][compressed_idx]
+ * [0..1] entry distinguish between CHANX/CHANY start nodes respectively
+ * The first index is the layer number that the node under consideration is on, and the forth index
+ * is the layer number that the target node is on.
+ */
+typedef vtr::NdMatrix<util::Cost_Entry, 5> t_compressed_wire_cost_map;
 
 #endif //VTR_ROUTER_LOOKAHEAD_COMPRESSED_MAP_H

vpr/src/route/router_lookahead_cost_map.h

@@ -89,16 +89,21 @@ class CostMap {
     std::vector<std::pair<int, int>> list_empty() const;
 
   private:
-    vtr::Matrix<vtr::Matrix<util::Cost_Entry>>
-        cost_map_; ///<Cost map containing all the costs computed during the lookahead generation.
-                   ///<It is indexed as follows: cost_map_[0][segment_index][delta_x][delta_y]
-                   ///<The first index is always 0 and it is kept to allow future specializations of
-                   ///<the cost map based on other possible indices.
-
-    vtr::Matrix<std::pair<int, int>> offset_; ///<Offset to specify the bounds of a specific segment map.
-                                              ///<It is used to adjust delta values to the segment bounding box.
-                                              ///<The offset map is addressed as follows: offset_[0][segment_index]
-        ///<The values of the matrix are pairs of corresponding to X and Y offsets.
+    /**
+     * Cost map containing all the costs computed during the lookahead generation.
+     * It is indexed as follows: cost_map_[0][segment_index][delta_x][delta_y]
+     * The first index is always 0 and it is kept to allow future specializations of
+     * the cost map based on other possible indices.
+     */
+    vtr::Matrix<vtr::Matrix<util::Cost_Entry>> cost_map_;
+
+    /**
+     * Offset to specify the bounds of a specific segment map.
+     * It is used to adjust delta values to the segment bounding box.
+     * The offset map is addressed as follows: offset_[0][segment_index]
+     * The values of the matrix are pairs of corresponding to X and Y offsets.
+     */
+    vtr::Matrix<std::pair<int, int>> offset_;
 
     vtr::Matrix<float> penalty_; ///<Penalty value corresponding to each segment type and used to penalize
                                  ///<delta locations that fall outside of a segment's bounding box.

vpr/src/route/router_lookahead_map.h

@@ -26,10 +26,10 @@ class MapLookahead : public RouterLookahead {
     // Lookup table to store the minimum cost to reach to a primitive pin from the root-level IPINs
     std::unordered_map<int, std::unordered_map<int, util::Cost_Entry>>
         tile_min_cost; // [physical_tile_type][sink_physical_num] -> cost
-    // Lookup table to store the minimum cost for each dx and dy
-    vtr::NdMatrix<util::Cost_Entry, 4> chann_distance_based_min_cost; // [from_layer_num][to_layer_num][dx][dy] -> cost
-    vtr::NdMatrix<util::Cost_Entry, 5>
-        opin_distance_based_min_cost; // [physical_tile_idx][from_layer_num][to_layer_num][dx][dy] -> cost
+    /// Lookup table to store the minimum cost for each dx and dy. [from_layer_num][to_layer_num][dx][dy] -> cost
+    vtr::NdMatrix<util::Cost_Entry, 4> chann_distance_based_min_cost;
+    /// [physical_tile_idx][from_layer_num][to_layer_num][dx][dy] -> cost
+    vtr::NdMatrix<util::Cost_Entry, 5> opin_distance_based_min_cost;
 
     const t_det_routing_arch& det_routing_arch_;
     bool is_flat_;
@@ -63,11 +63,11 @@ class MapLookahead : public RouterLookahead {
 // To store this information, the first index is the layer number that the node under consideration is on, the second index is the layer number of the target node, the third index represents the type of channel (X/Y)
 // that the node under consideration belongs to, the forth is the segment type (specified in the architecture file under the "segmentlist" tag), the fourth is the
 // target "layer_num" mentioned above, the fifth is dx, and the last one is dy.
-typedef vtr::NdMatrix<util::Cost_Entry, 6>
-    t_wire_cost_map; //[0..num_layers][0..num_layers][0..1][[0..num_seg_types-1][0..device_ctx.grid.width()-1][0..device_ctx.grid.height()-1]
-    //[0..1] entry distinguish between CHANX/CHANY start nodes respectively
-    // The first index is the layer number that the node under consideration is on, and the second index
-    // is the layer number that the target node is on.
+// [0..num_layers][0..num_layers][0..1][[0..num_seg_types-1][0..device_ctx.grid.width()-1][0..device_ctx.grid.height()-1]
+typedef vtr::NdMatrix<util::Cost_Entry, 6> t_wire_cost_map;
+//[0..1] entry distinguish between CHANX/CHANY start nodes respectively
+// The first index is the layer number that the node under consideration is on, and the second index
+// is the layer number that the target node is on.
 
 void read_router_lookahead(const std::string& file);
 void write_router_lookahead(const std::string& file);