Skip to content

Commit be2688f

Browse files
committed
rewrite rrgraphview brief
1 parent c4c9ed6 commit be2688f

File tree

2 files changed

+16
-8
lines changed

2 files changed

+16
-8
lines changed

libs/librrgraph/src/base/rr_graph_builder.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ class RRGraphBuilder {
3838
t_rr_graph_storage& rr_nodes();
3939
/** @brief Return a writable object for update the fast look-up of rr_node */
4040
RRSpatialLookup& node_lookup();
41-
/** @warning The Metadata should stay as an independent data structure than rest of the internal data,
41+
/** @warning The Metadata should stay as an independent data structure from the rest of the internal data,
4242
* e.g., node_lookup! */
4343
/** @brief Return a writable object for the meta data on the nodes */
4444
MetadataStorage<int>& rr_node_metadata();
@@ -396,7 +396,7 @@ class RRGraphBuilder {
396396
/* Detailed information about the switches, which are used in the RRGraph */
397397
vtr::vector<RRSwitchId, t_rr_switch_inf> rr_switch_inf_;
398398

399-
/** @warning The Metadata should stay as an independent data structure than rest of the internal data,
399+
/** @warning The Metadata should stay as an independent data structure from the rest of the internal data,
400400
* e.g., node_lookup! */
401401
/* Metadata is an extra data on rr-nodes and edges, respectively, that is not used by vpr
402402
* but simply passed through the flow so that it can be used by downstream tools.

libs/librrgraph/src/base/rr_graph_view.h

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,28 @@
33

44
/**
55
* @file
6-
* @brief The RRGraphView encapsulates a read-only routing resource graph, providing clients with tailored frame views of the object.
6+
* @brief The RRGraphView class provides a read-only interface to access the RRGraph.
77
*
8-
* The RRGraphView represents the full frame view of the routing resource graph, offering several advantages:
9-
* - Reduces the memory footprint for each client.
10-
* - Minimizes the need for extensive API changes, as each frame view delivers ad-hoc APIs suited to the specific needs of individual clients.
8+
* The RRGraphView class offers tools like routing algorithms, graphics, and statistical analysis
9+
* a read-only interface to the underlying RRGraph, which models the programmable routing fabric
10+
* of the FPGA. The fundamental data structure of the RRGraph is a graph consisting of nodes
11+
* (representing routing resources) and outgoing edges (representing connections between routing resources).
1112
*
13+
* Each node and edge is enhanced with additional metadata, such as the location of the node within
14+
* the chip and electrical parameters, to make algorithms more efficient, aid in drawing the chip,
15+
* and estimate signal delays. RRGraphView ensures that tools can access this data safely without
16+
* modifying the underlying structure.
17+
*
18+
*
19+
* \internal
1220
* A unified object that includes pointers to:
1321
* - Node storage
14-
* \internal
1522
* - TODO: Edge storage
1623
* - TODO: Node PTC storage
1724
* - TODO: Node fan-in storage
18-
* \endinternal
1925
* - RR node indices
26+
* \endinternal
27+
2028
*
2129
* @note The RRGraphView does not own the storage. It provides a virtual
2230
* read-only protocol for:

0 commit comments

Comments
 (0)