Skip to content

Commit a4baac7

Browse files
committed
[Lib] Add code comments
1 parent c583013 commit a4baac7

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

libs/librrgraph/src/base/rr_node_types.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@
2020
typedef enum e_rr_type : unsigned char {
2121
SOURCE = 0, ///<A dummy node that is a logical output within a block -- i.e., the gate that generates a signal.
2222
SINK, ///<A dummy node that is a logical input within a block -- i.e. the gate that needs a signal.
23-
IPIN,
24-
OPIN,
25-
CHANX,
26-
CHANY,
23+
IPIN, ///Input pin to a block
24+
OPIN, ///Output pin of a block
25+
CHANX, ///x-directed routing wire, or an x-directed segment of a channel for global routing
26+
CHANY, ///y-directed routing wire, or a y-directed segment of a channel for global routing
2727
NUM_RR_TYPES
2828
} t_rr_type;
2929

@@ -112,6 +112,7 @@ struct t_rr_rc_data {
112112
float C;
113113
};
114114

115+
// This is the data type of fast lookups of an rr-node given an (rr_type, x, y, and the side)
115116
//[0..num_rr_types-1][0..grid_width-1][0..grid_height-1][0..NUM_SIDES-1][0..max_ptc-1]
116117
typedef std::array<vtr::NdMatrix<std::vector<int>, 3>, NUM_RR_TYPES> t_rr_node_indices;
117118

0 commit comments

Comments
 (0)