Skip to content

Commit 1ee7745

Browse files
committed
[VPR] Add comment about the multi-side query API of RRGraph
1 parent f89faad commit 1ee7745

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

vpr/src/route/rr_graph_storage.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,12 @@ class t_rr_graph_storage {
218218
* // See if the node appears ONLY on 1 side
219219
* if (1 == node_sides(id).count()) {
220220
* }
221+
*
222+
* TODO: This function may be deprecated, depending its utilization
223+
* in client functions, router, GUI etc. It offers a shortcut
224+
* for developers who can check what sides a node appear on.
225+
* However, such query can be done outside RRGraph by iterating
226+
* over all the sides and using API is_node_on_specific_side()
221227
*/
222228
std::bitset<NUM_SIDES> node_sides(RRNodeId id) const {
223229
return get_node_sides(

0 commit comments

Comments
 (0)