Skip to content

Commit bd217bf

Browse files
committed
Need to run make format on changes that were merged remotely 'clusterer_feasibility_changes' of https://github.com/verilog-to-routing/vtr-verilog-to-routing into clusterer_feasibility_changes
2 parents d2d6fcb + 40e9534 commit bd217bf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+3524
-1029
lines changed

doc/_doxygen/vtr.dox

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
PROJECT_NAME = "Verilog to Routing - VTR"
2+
OUTPUT_DIRECTORY = ../_build/doxygen/vtr
3+
FULL_PATH_NAMES = NO
4+
OPTIMIZE_OUTPUT_FOR_C = YES
5+
EXTRACT_ALL = YES
6+
EXTRACT_PRIVATE = YES
7+
EXTRACT_STATIC = YES
8+
WARN_IF_UNDOCUMENTED = NO
9+
INPUT = ../../libs/libvtrutil
10+
SORT_MEMBER_DOCS = NO
11+
SORT_BRIEF_DOCS = NO
12+
SORT_GROUP_NAMES = NO
13+
SORT_BY_SCOPE_NAME = NO
14+
RECURSIVE = YES
15+
GENERATE_HTML = NO
16+
GENERATE_LATEX = NO
17+
GENERATE_XML = YES
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
===============
2+
Container Utils
3+
===============
4+
5+
vtr_hash
6+
--------
7+
.. doxygenfile:: vtr_hash.h
8+
:project: vtr
9+
10+
vtr_memory
11+
----------
12+
.. doxygenfile:: vtr_memory.h
13+
:project: vtr
14+
:sections: briefdescription detaileddescription innernamespace innerclass func
15+
16+
vtr_pair_util
17+
-------------
18+
.. doxygenfile:: vtr_pair_util.h
19+
:project: vtr
20+
:sections: innernamespace innerclass briefdescription detaileddescription user-defined public-func typedef
21+
22+
vtr_map_util
23+
------------
24+
.. doxygenfile:: vtr_map_util.h
25+
:project: vtr
26+

doc/src/api/vtrutil/containers.rst

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
==========
2+
Containers
3+
==========
4+
5+
vtr_vector
6+
----------
7+
.. doxygenfile:: vtr_vector.h
8+
:project: vtr
9+
:sections: briefdescription detaileddescription innernamespace innerclass public-func typedef func
10+
11+
vtr_small_vector
12+
----------------
13+
.. doxygenclass:: vtr::small_vector
14+
:project: vtr
15+
:members:
16+
17+
vtr_vector_map
18+
--------------
19+
.. doxygenfile:: vtr_vector_map.h
20+
:project: vtr
21+
:sections: briefdescription detaileddescription innernamespace innerclass public-func typedef func
22+
23+
vtr_linear_map
24+
--------------
25+
.. doxygenfile:: vtr_linear_map.h
26+
:project: vtr
27+
:sections: briefdescription detaileddescription innernamespace func innerclass user-defined public-func typedef
28+
29+
vtr_flat_map
30+
------------
31+
.. doxygenclass:: vtr::flat_map
32+
:project: vtr
33+
:members:
34+
35+
.. doxygenclass:: vtr::flat_map2
36+
:project: vtr
37+
:members:
38+
39+
.. doxygenfile:: vtr_flat_map.h
40+
:project: vtr
41+
:sections: innernamespace func
42+
43+
vtr_bimap
44+
---------
45+
.. doxygenfile:: vtr_bimap.h
46+
:project: vtr
47+
:sections: briefdescription detaileddescription innernamespace innerclass user-defined public-func derivedcompoundref typedef
48+
49+
vtr_vec_id_set
50+
--------------
51+
.. doxygenfile:: vtr_vec_id_set.h
52+
:project: vtr
53+
:sections: briefdescription detaileddescription innernamespace innerclass public-func
54+
55+
vtr_list
56+
--------
57+
.. doxygenfile:: vtr_list.h
58+
:project: vtr
59+
:sections: briefdescription detaileddescription innernamespace struct innerclass user-defined public-func typedef
60+
61+
.. doxygenfunction:: insert_in_vptr_list
62+
:project: vtr
63+
64+
65+
.. doxygenfunction:: delete_in_vptr_list
66+
:project: vtr
67+
68+
vtr_ragged_matrix
69+
-----------------
70+
.. doxygenclass:: vtr::FlatRaggedMatrix
71+
:project: vtr
72+
:members:
73+
74+
vtr_ndmatrix
75+
------------
76+
.. doxygenfile:: vtr_ndmatrix.h
77+
:project: vtr
78+
:sections: innernamespace innerclass briefdescription detaileddescription user-defined public-func typedef
79+
80+
vtr_ndoffsetmatrix
81+
------------------
82+
.. doxygenfile:: vtr_ndoffsetmatrix.h
83+
:project: vtr
84+
:sections: innernamespace innerclass briefdescription detaileddescription user-defined public-func typedef
85+
86+
vtr_array_view
87+
--------------
88+
.. doxygenclass:: vtr::array_view_id
89+
:project: vtr
90+
:members:
91+
92+
.. doxygenclass:: vtr::array_view
93+
:project: vtr
94+
:members:
95+
96+
vtr_string_view
97+
---------------
98+
.. doxygenclass:: vtr::string_view
99+
:project: vtr
100+
:members:
101+
102+
vtr_cache
103+
---------
104+
.. doxygenclass:: vtr::Cache
105+
:project: vtr
106+
:members:
107+
108+
vtr_dynamic_bitset
109+
------------------
110+
.. doxygenclass:: vtr::dynamic_bitset
111+
:project: vtr
112+
:members:

doc/src/api/vtrutil/geometry.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
========
2+
Geometry
3+
========
4+
5+
vtr_geometry
6+
------------
7+
.. doxygenfile:: vtr_geometry.h
8+
:project: vtr
9+
:sections: briefdescription
10+
11+
.. doxygenclass:: vtr::Point
12+
:project: vtr
13+
:members:
14+
15+
.. doxygenclass:: vtr::Rect
16+
:project: vtr
17+
:members:
18+
19+
.. doxygenclass:: vtr::Line
20+
:project: vtr
21+
:members:
22+
23+
.. doxygenclass:: vtr::RectUnion
24+
:project: vtr
25+
:members:

doc/src/api/vtrutil/ids.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
============
2+
IDs - Ranges
3+
============
4+
5+
vtr_range
6+
---------
7+
.. doxygenfile:: vtr_range.h
8+
:project: vtr
9+
:sections: briefdescription detaileddescription innernamespace func innerclass public-func typedef
10+
11+
vtr_strong_id
12+
-------------
13+
.. doxygenfile:: vtr_strong_id.h
14+
:project: vtr
15+
:sections: briefdescription detaileddescription innernamespace
16+
17+
.. doxygenclass:: vtr::StrongId
18+
:project: vtr
19+
:members:
20+
21+
vtr_strong_id_range
22+
-------------------
23+
.. doxygenfile:: vtr_strong_id_range.h
24+
:project: vtr
25+
:sections: briefdescription detaileddescription innernamespace func innerclass user-defined public-func
26+

doc/src/api/vtrutil/index.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _vtrutil_api:
2+
3+
VTRUTIL API
4+
============
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
ids
10+
containers
11+
container_utils
12+
logging
13+
geometry
14+
other

doc/src/api/vtrutil/logging.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
=============================
2+
Logging - Errors - Assertions
3+
=============================
4+
5+
vtr_log
6+
-------
7+
.. doxygenfile:: vtr_log.h
8+
:project: vtr
9+
:sections: briefdescription detaileddescription innernamespace func
10+
11+
vtr_error
12+
---------
13+
.. doxygenfile:: vtr_error.h
14+
:project: vtr
15+
:sections: innernamespace innerclass briefdescription detaileddescription user-defined public-func
16+
17+
vtr_assertion
18+
-------------
19+
.. doxygenfile:: vtr_assert.h
20+
:project: vtr
21+
:sections: briefdescription detaileddescription
22+
23+
vtr_time
24+
--------
25+
.. doxygenfile:: vtr_time.h
26+
:project: vtr
27+
:sections: briefdescription detaileddescription
28+
29+
.. doxygenclass:: vtr::ScopedStartFinishTimer
30+
:project: vtr
31+
32+
.. doxygenclass:: vtr::ScopedFinishTimer
33+
:project: vtr
34+
35+
.. doxygenclass:: vtr::ScopedActionTimer
36+
:project: vtr
37+
38+
.. doxygenclass:: vtr::Timer
39+
:project: vtr

0 commit comments

Comments
 (0)