Skip to content
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

Router Heap documentation update #2634

Merged

Conversation

nedsels
Copy link
Contributor

@nedsels nedsels commented Jun 28, 2024

Two changes to Router Heap documentation:

  1. Currently: u is protected and so doesn't appear in the documentation, but the descriptions of its accessors/mutators refer to it. Now: these functions' descriptions don't reference u and state explicitly what they do.
  2. Currently: there are duplicate descriptions for public pure virtual functions inherited from HeapInterface and/or KAryHeap. Now: only HeapInterface has descriptions for its public members (its inherited classes do not have any additional public functions).

@github-actions github-actions bot added VPR VPR FPGA Placement & Routing Tool docs Documentation lang-cpp C/C++ code labels Jun 28, 2024
@nedsels nedsels force-pushed the update_heap_documentation branch from 18bcdad to e914742 Compare June 28, 2024 14:23
…ember info; also, t_heap fn.s described better
@nedsels nedsels force-pushed the update_heap_documentation branch from e914742 to 3e9bc7d Compare June 28, 2024 14:25
@nedsels nedsels marked this pull request as ready for review June 28, 2024 18:37
@vaughnbetz
Copy link
Contributor

Thanks!
There's one spurious CI failure: a single reg test of small designs with OdinII has a QoR failure. Probably was introduced in some prior PR and needs a golden solution update. Merging this, but if it persists it would be good if you can update the checked in golden results for it.

vtr_reg_nightly_test1_odin/arithmetic_tasks/FIR_filters_frac...[Fail]
2024-06-28T17:21:45.4560546Z �[32;1m17:21:45�[0m | [Fail]
2024-06-28T17:21:45.4562104Z �[32;1m17:21:45�[0m | k6_frac_uripple_N8_22nm.xml/fir_nopipe_26.v/common setup_TNS relative value 1.5002228616457025 outside of range [0.5,1.4] and not equal to golden value: -782.997
2024-06-28T17:21:45.4564196Z �[32;1m17:21:45�[0m | vtr_reg_nightly_test1_odin/arithmetic_tasks/multless_consts...[Pass]
2024-06-28T17:21:45.4565543Z �[32;1m17:21:45�[0m | vtr_reg_nightly_test1_odin/arithmetic_tasks/open_cores...[Pass]
2024-06-28T17:21:45.4566654Z �[32;1m17:21:45�[0m | vtr_reg_nightly_test1_odin/arithmetic_tasks/open_cores_frac...[Pass]
2024-06-28T17:21:45.4567883Z �[32;1m17:21:45�[0m | regression_tests/vtr_reg_nightly_test1_odin/power_extended_arch_list...[Pass]
2024-06-28T17:21:45.4569127Z �[32;1m17:21:45�[0m | regression_tests/vtr_reg_nightly_test1_odin/power_extended_circuit_list...[Pass]
2024-06-28T17:21:45.4570176Z �[32;1m17:21:45�[0m |
2024-06-28T17:21:45.4571064Z �[32;1m17:21:45�[0m | Test 'vtr_reg_nightly_test1_odin' had 1 qor test failures

@vaughnbetz vaughnbetz merged commit f104122 into verilog-to-routing:master Jun 28, 2024
50 of 53 checks passed
@nedsels nedsels deleted the update_heap_documentation branch June 29, 2024 02:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation lang-cpp C/C++ code VPR VPR FPGA Placement & Routing Tool
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants