Skip to content

Add some overview to the RRGraphView doxygen documentation #2361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vaughnbetz opened this issue Aug 3, 2023 · 3 comments
Open

Add some overview to the RRGraphView doxygen documentation #2361

vaughnbetz opened this issue Aug 3, 2023 · 3 comments
Assignees

Comments

@vaughnbetz
Copy link
Contributor

Proposed Behaviour

We should give a high level overview of the RRGraphView data structure / API in our doxygen documentation.

Current Behaviour

Currently we dive right into methods.

Possible Solution

Explain the RRGraph describes the programmable routing fabric of the FPGA (all wires and switches). RRGraphView provides a read-only interface, which tools like the router, graphics, and statistics need.
Should also explain that the fundamental data structures is a graph (nodes and out-going edges) with extra information like the location within the chip and electrical parameters added to help make algorithms more efficient, draw the chip, and estimate delays.

@amin1377 amin1377 self-assigned this Oct 7, 2023
@vaughnbetz vaughnbetz assigned tangxifan and unassigned amin1377 Jun 13, 2024
@vaughnbetz
Copy link
Contributor Author

Re assigning to @tangxifan . This might be a duplicate though!

@vaughnbetz
Copy link
Contributor Author

Is a duplicate of the remaining work in #1834 . We can close both together.

@tangxifan
Copy link
Contributor

@vaughnbetz Indeed. We may close this one and keep #1834 open. My team will follow up. A PR will happen this summer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants