Virtual pi network #543

hibenj · 2024-10-16T11:01:05Z

Description

This PR includes the virtual_pi_network.hpp, virtual_pi_network.cpp(testing) and virtual_pi_network.rst(documentation), as well as the necessary changes in traits.hpp
The virtual PI network enhances all mockturtle network types to store duplicates of their PIs, called virtual PIs.

Checklist:

The pull request only contains commits that are related to it.
I have added appropriate tests and documentation.
I have added a changelog entry.
I have created/adjusted the Python bindings for any new or updated functionality.
I have made sure that all CI jobs on GitHub pass.
The pull request introduces no new warnings and follows the project's style guidelines.

Signed-off-by: GitHub Actions <[email protected]>

…_pi_network

Signed-off-by: GitHub Actions <[email protected]>

…_pi_network

Signed-off-by: GitHub Actions <[email protected]>

…_pi_network

Signed-off-by: GitHub Actions <[email protected]>

…_pi_network

codecov · 2024-10-16T12:24:02Z

Codecov Report

Attention: Patch coverage is 98.68049% with 14 lines in your changes missing coverage. Please review.

Project coverage is 98.13%. Comparing base (df6b61e) to head (66c412f).
Report is 5 commits behind head on main.

Files with missing lines	Patch %	Lines
include/fiction/networks/views/depth_view.hpp	93.70%	8 Missing ⚠️
...thms/network_transformation/delete_virtual_pis.hpp	93.65%	4 Missing ⚠️
...lude/fiction/networks/views/extended_rank_view.hpp	98.51%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##             main     #543     +/-   ##
=========================================
  Coverage   98.13%   98.13%             
=========================================
  Files         232      242     +10     
  Lines       35410    36476   +1066     
  Branches     1691     1743     +52     
=========================================
+ Hits        34748    35797   +1049     
- Misses        660      677     +17     
  Partials        2        2

Files with missing lines	Coverage Δ
.../fiction/algorithms/verification/virtual_miter.hpp	`100.00% <100.00%> (ø)`
include/fiction/networks/virtual_pi_network.hpp	`100.00% <100.00%> (ø)`
...thms/network_transformation/delete_virtual_pis.cpp	`100.00% <100.00%> (ø)`
test/algorithms/verification/virtual_miter.cpp	`100.00% <100.00%> (ø)`
test/networks/views/depth_view.cpp	`100.00% <100.00%> (ø)`
test/networks/views/extended_rank_view.cpp	`100.00% <100.00%> (ø)`
test/networks/virtual_pi_network.cpp	`100.00% <100.00%> (ø)`
...lude/fiction/networks/views/extended_rank_view.hpp	`98.51% <98.51%> (ø)`
...thms/network_transformation/delete_virtual_pis.hpp	`93.65% <93.65%> (ø)`
include/fiction/networks/views/depth_view.hpp	`93.70% <93.70%> (ø)`

... and 3 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 37d27c7...66c412f. Read the comment docs.

github-actions

clang-tidy made some suggestions

include/fiction/networks/virtual_pi_network.hpp

…_pi_network

github-actions

clang-tidy made some suggestions

include/fiction/networks/virtual_pi_network.hpp

test/networks/virtual_pi_network.cpp

github-actions

clang-tidy made some suggestions

test/networks/virtual_pi_network.cpp

…_pi_network

Signed-off-by: GitHub Actions <[email protected]>

github-actions

clang-tidy made some suggestions

test/algorithms/verification/virtual_miter.cpp

Drewniok

It looks great already! I hope my comments will help you.
Thank you! 🙏

include/fiction/algorithms/verification/virtual_miter.hpp

include/fiction/networks/virtual_pi_network.hpp

Signed-off-by: GitHub Actions <[email protected]>

github-actions

clang-tidy made some suggestions

include/fiction/algorithms/network_transformation/delete_virtual_pis.hpp

include/fiction/algorithms/verification/virtual_miter.hpp

include/fiction/networks/virtual_pi_network.hpp

…_pi_network

# Conflicts: # bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp

Signed-off-by: GitHub Actions <[email protected]>

Drewniok · 2024-12-16T13:45:09Z

I think it makes more sense that @marcelwa is doing a review now as he is more familiar with the topic and may suggest restructuring the code. Afterwards, I will review it again. What do you think?

…d_rank_view

Signed-off-by: GitHub Actions <[email protected]>

…d_rank_view

github-actions

clang-tidy made some suggestions

github-actions · 2025-01-02T15:46:37Z

include/fiction/networks/views/depth_view.hpp

+ * @tparam NodeCostFn A function to compute the costs associated with nodes.
+ */
+template <typename Ntk, typename NodeCostFn>
+class depth_view<Ntk, NodeCostFn, false> : public Ntk


warning: class 'depth_view' defines a default destructor, a copy constructor and a copy assignment operator but does not define a move constructor or a move assignment operator [cppcoreguidelines-special-member-functions]

class depth_view<Ntk, NodeCostFn, false> : public Ntk ^

github-actions · 2025-01-02T15:46:37Z

include/fiction/networks/views/depth_view.hpp

+    /**
+     * Depth view parameters.
+     */
+    depth_view_params _ps;


warning: invalid case style for member '_ps' [readability-identifier-naming]

include/fiction/networks/views/depth_view.hpp:96:

- _ps(ps), + ps(ps),

include/fiction/networks/views/depth_view.hpp:123:

- _ps(ps), + ps(ps),

include/fiction/networks/views/depth_view.hpp:146:

- _ps(other._ps), + ps(other.ps),

include/fiction/networks/views/depth_view.hpp:169:

- _ps = other._ps; + ps = other.ps;

include/fiction/networks/views/depth_view.hpp:257:

- return _levels[n] = _ps.pi_cost ? _cost_fn(*this, n) - 1 : 0; + return _levels[n] = ps.pi_cost ? _cost_fn(*this, n) - 1 : 0;

include/fiction/networks/views/depth_view.hpp:265:

- if (_ps.count_complements && this->is_complemented(f)) + if (ps.count_complements && this->is_complemented(f))

include/fiction/networks/views/depth_view.hpp:285:

- if (_ps.count_complements && this->is_complemented(f)) + if (ps.count_complements && this->is_complemented(f))

include/fiction/networks/views/depth_view.hpp:298:

- if (_ps.count_complements && this->is_complemented(f)) + if (ps.count_complements && this->is_complemented(f))

include/fiction/networks/views/depth_view.hpp:336:

- if (!this->is_constant(n) && !(_ps.pi_cost && this->is_pi(n))) + if (!this->is_constant(n) && !(ps.pi_cost && this->is_pi(n)))

include/fiction/networks/views/depth_view.hpp:344:

- if (_ps.count_complements && this->is_complemented(f)) + if (ps.count_complements && this->is_complemented(f))

Suggested change

depth_view_params _ps;

depth_view_params ps;

github-actions · 2025-01-02T15:46:37Z

include/fiction/networks/views/depth_view.hpp

+    /**
+     * Hashmap assigning levels to nodes.
+     */
+    phmap::flat_hash_map<node, uint32_t> _levels;


warning: invalid case style for member '_levels' [readability-identifier-naming]

include/fiction/networks/views/depth_view.hpp:108:

- _levels.rehash(this->size()); + levels.rehash(this->size());

include/fiction/networks/views/depth_view.hpp:135:

- _levels.rehash(this->size()); + levels.rehash(this->size());

include/fiction/networks/views/depth_view.hpp:147:

- _levels(other._levels), + levels(other.levels),

include/fiction/networks/views/depth_view.hpp:170:

- _levels = other._levels; + levels = other.levels;

include/fiction/networks/views/depth_view.hpp:197:

- return _levels.at(n); + return levels.at(n);

include/fiction/networks/views/depth_view.hpp:213:

- _levels[n] = level; + levels[n] = level;

include/fiction/networks/views/depth_view.hpp:229:

- _levels.clear(); - _levels.rehash(this->size()); + levels.clear(); + levels.rehash(this->size());

include/fiction/networks/views/depth_view.hpp:246:

- return _levels[n]; + return levels[n];

include/fiction/networks/views/depth_view.hpp:252:

- return _levels[n] = 0; + return levels[n] = 0;

include/fiction/networks/views/depth_view.hpp:257:

- return _levels[n] = _ps.pi_cost ? _cost_fn(*this, n) - 1 : 0; + return levels[n] = _ps.pi_cost ? _cost_fn(*this, n) - 1 : 0;

include/fiction/networks/views/depth_view.hpp:272:

- return _levels[n] = level + _cost_fn(*this, n); + return levels[n] = level + _cost_fn(*this, n);

include/fiction/networks/views/depth_view.hpp:310:

- if (_levels[n] == _depth) + if (levels[n] == _depth)

include/fiction/networks/views/depth_view.hpp:322:

- if (_levels[n] == _depth) + if (levels[n] == _depth)

include/fiction/networks/views/depth_view.hpp:338:

- const auto lvl = _levels[n]; + const auto lvl = levels[n];

include/fiction/networks/views/depth_view.hpp:348:

- if (_levels[cn] + offset == lvl && !_crit_path[cn]) + if (levels[cn] + offset == lvl && !_crit_path[cn])

Suggested change

phmap::flat_hash_map<node, uint32_t> _levels;

phmap::flat_hash_map<node, uint32_t> levels;

github-actions · 2025-01-02T15:46:38Z

include/fiction/networks/views/depth_view.hpp

+    /**
+     * Hashmap assigning nodes on the critical path.
+     */
+    phmap::flat_hash_map<node, uint32_t> _crit_path;


warning: invalid case style for member '_crit_path' [readability-identifier-naming]

include/fiction/networks/views/depth_view.hpp:148:

- _crit_path(other._crit_path), + crit_path(other.crit_path),

include/fiction/networks/views/depth_view.hpp:171:

- _crit_path = other._crit_path; + crit_path = other.crit_path;

include/fiction/networks/views/depth_view.hpp:205:

- return _crit_path.contains(n); + return crit_path.contains(n);

include/fiction/networks/views/depth_view.hpp:231:

- _crit_path.clear(); - _crit_path.rehash(this->size()); + crit_path.clear(); + crit_path.rehash(this->size());

include/fiction/networks/views/depth_view.hpp:335:

- _crit_path[n] = true; + crit_path[n] = true;

include/fiction/networks/views/depth_view.hpp:348:

- if (_levels[cn] + offset == lvl && !_crit_path[cn]) + if (_levels[cn] + offset == lvl && !crit_path[cn])

Suggested change

phmap::flat_hash_map<node, uint32_t> _crit_path;

phmap::flat_hash_map<node, uint32_t> crit_path;

github-actions · 2025-01-02T15:46:38Z

include/fiction/networks/views/depth_view.hpp

+    /**
+     * The depth of the network.
+     */
+    uint32_t _depth{};


warning: invalid case style for member '_depth' [readability-identifier-naming]

include/fiction/networks/views/depth_view.hpp:149:

- _depth(other._depth), + depth(other.depth),

include/fiction/networks/views/depth_view.hpp:172:

- _depth = other._depth; + depth = other.depth;

include/fiction/networks/views/depth_view.hpp:189:

- return _depth; + return depth;

include/fiction/networks/views/depth_view.hpp:221:

- _depth = level; + depth = level;

include/fiction/networks/views/depth_view.hpp:280:

- _depth = 0; + depth = 0;

include/fiction/networks/views/depth_view.hpp:289:

- _depth = std::max(_depth, clevel); + depth = std::max(depth, clevel);

include/fiction/networks/views/depth_view.hpp:302:

- _depth = std::max(_depth, clevel); + depth = std::max(depth, clevel);

include/fiction/networks/views/depth_view.hpp:310:

- if (_levels[n] == _depth) + if (_levels[n] == depth)

include/fiction/networks/views/depth_view.hpp:322:

- if (_levels[n] == _depth) + if (_levels[n] == depth)

Suggested change

uint32_t _depth{};

uint32_t depth{};

github-actions · 2025-01-02T15:46:38Z

include/fiction/networks/views/extended_rank_view.hpp

+    {
+        for (auto l = 0; l < ranks.size(); ++l)
+        {
+            foreach_gate_in_rank(l, std::forward<Fn>(fn));


warning: implicit conversion changes signedness: 'int' to 'uint32_t' (aka 'unsigned int') [clang-diagnostic-sign-conversion]

foreach_gate_in_rank(l, std::forward<Fn>(fn)); ^

Additional context

test/networks/views/extended_rank_view.cpp:130: in instantiation of function template specialization 'fiction::extended_rank_viewfiction::technology_network::foreach_gate<(lambda at /github/workspace/test/networks/views/extended_rank_view.cpp:131:24)>' requested here

tec_r.foreach_gate([&node_vector](const auto& n) { node_vector.push_back(n); }); ^

github-actions · 2025-01-02T15:46:39Z

test/networks/views/extended_rank_view.cpp

+
+    mockturtle::equivalence_checking_stats st;
+    const auto                             maybe_cec_m =
+        mockturtle::equivalence_checking(*fiction::virtual_miter<technology_network>(ntk, ntk_r), {}, &st);


warning: unchecked access to optional value [bugprone-unchecked-optional-access]

mockturtle::equivalence_checking(*fiction::virtual_miter<technology_network>(ntk, ntk_r), {}, &st); ^

github-actions · 2025-01-02T15:46:39Z

test/networks/views/extended_rank_view.cpp

+    const auto                             maybe_cec_m =
+        mockturtle::equivalence_checking(*fiction::virtual_miter<technology_network>(ntk, ntk_r), {}, &st);
+    REQUIRE(maybe_cec_m.has_value());
+    const bool cec_m = *maybe_cec_m;


warning: unchecked access to optional value [bugprone-unchecked-optional-access]

const bool cec_m = *maybe_cec_m; ^

github-actions · 2025-01-02T15:46:39Z

test/networks/views/extended_rank_view.cpp

+
+    mockturtle::equivalence_checking_stats st;
+    const auto                             maybe_cec_m =
+        mockturtle::equivalence_checking(*fiction::virtual_miter<technology_network>(tec, vpi), {}, &st);


warning: unchecked access to optional value [bugprone-unchecked-optional-access]

mockturtle::equivalence_checking(*fiction::virtual_miter<technology_network>(tec, vpi), {}, &st); ^

github-actions · 2025-01-02T15:46:39Z

test/networks/views/extended_rank_view.cpp

+    const auto                             maybe_cec_m =
+        mockturtle::equivalence_checking(*fiction::virtual_miter<technology_network>(tec, vpi), {}, &st);
+    REQUIRE(maybe_cec_m.has_value());
+    const bool cec_m = *maybe_cec_m;


warning: unchecked access to optional value [bugprone-unchecked-optional-access]

const bool cec_m = *maybe_cec_m; ^

…_pi_network

github-actions

clang-tidy made some suggestions

github-actions · 2025-01-03T08:42:38Z

test/networks/views/extended_rank_view.cpp

+
+    mockturtle::equivalence_checking_stats st;
+    const auto                             maybe_cec_m =
+        mockturtle::equivalence_checking(*fiction::virtual_miter<technology_network>(tec, vpi_r), {}, &st);


warning: unchecked access to optional value [bugprone-unchecked-optional-access]

mockturtle::equivalence_checking(*fiction::virtual_miter<technology_network>(tec, vpi_r), {}, &st); ^

hibenj and others added 18 commits October 15, 2024 15:51

🎨 experiments_file_cleaned

73a8d64

📝 Update pyfiction docstrings

9002bce

Signed-off-by: GitHub Actions <[email protected]>

🎨 modified traits.hpp

bb8f9c4

Merge remote-tracking branch 'origin/virtual_pi_network' into virtual…

3c0ddeb

…_pi_network

🎨 added docs

77b6867

🎨 small modifications

5aec291

📝 Update pyfiction docstrings

d06c3cc

Signed-off-by: GitHub Actions <[email protected]>

🎨 small adjustments

a3d07a2

Merge remote-tracking branch 'origin/virtual_pi_network' into virtual…

55abee5

…_pi_network

📝 Update pyfiction docstrings

fbe2eec

Signed-off-by: GitHub Actions <[email protected]>

🎨 removed deep copy constructing on top of other network types.

940c8af

📝 Update pyfiction docstrings

366e67a

Signed-off-by: GitHub Actions <[email protected]>

🎨 corrected traits and added name_conservation test case

4dce17d

Merge remote-tracking branch 'origin/virtual_pi_network' into virtual…

9530ef0

…_pi_network

📝 Update pyfiction docstrings

68b1eff

Signed-off-by: GitHub Actions <[email protected]>

🎨 docs updated

93c3baa

Merge remote-tracking branch 'origin/virtual_pi_network' into virtual…

40eb89b

…_pi_network

Merge branch 'main' into virtual_pi_network

5c462f9

hibenj requested review from marcelwa and Drewniok October 16, 2024 11:01

🎨 Incorporated pre-commit fixes

6e5cd4b

github-actions bot reviewed Oct 16, 2024

View reviewed changes

include/fiction/networks/virtual_pi_network.hpp Show resolved Hide resolved

include/fiction/networks/virtual_pi_network.hpp Show resolved Hide resolved

include/fiction/networks/virtual_pi_network.hpp Outdated Show resolved Hide resolved

Drewniok assigned hibenj Oct 16, 2024

hibenj and others added 4 commits October 17, 2024 13:23

🎨 optimized code coverage and fixed clang-tidy errors

5f83617

Merge remote-tracking branch 'origin/virtual_pi_network' into virtual…

4a130c1

…_pi_network

🎨 fixed function forwarding for foreach functions

ddecd61

🎨 Incorporated pre-commit fixes

482bb05

github-actions bot reviewed Oct 17, 2024

View reviewed changes

hibenj and others added 4 commits December 9, 2024 14:35

Merge remote-tracking branch 'origin/virtual_pi_network' into virtual…

da059df

…_pi_network

🎨 Incorporated pre-commit fixes

0e82798

➕ extended_rank_view added

db97d7f

📝 Update pyfiction docstrings

5edd332

Signed-off-by: GitHub Actions <[email protected]>

github-actions bot reviewed Dec 9, 2024

View reviewed changes

Drewniok reviewed Dec 10, 2024

View reviewed changes

hibenj and others added 3 commits December 10, 2024 15:41

🎨 better code consistency and readability

a0637a4

🎨 Incorporated pre-commit fixes

0fd7942

📝 Update pyfiction docstrings

41be15f

Signed-off-by: GitHub Actions <[email protected]>

github-actions bot reviewed Dec 10, 2024

View reviewed changes

hibenj and others added 3 commits December 10, 2024 16:07

🎨 clang tidy corrections

726a507

Merge remote-tracking branch 'origin/virtual_pi_network' into virtual…

05c322d

…_pi_network

🎨 Incorporated pre-commit fixes

0c88921

hibenj requested a review from Drewniok December 10, 2024 16:41

hibenj and others added 2 commits December 13, 2024 11:47

Merge branch 'virtual_pi_network' into extended_rank_view

e835728

# Conflicts: # bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp

📝 Update pyfiction docstrings

14653f2

Signed-off-by: GitHub Actions <[email protected]>

hibenj and others added 9 commits January 2, 2025 15:42

➕ new depth_view and rank_view implementations.

b10e337

Merge remote-tracking branch 'origin/extended_rank_view' into extende…

1b920d0

…d_rank_view

📝 Update pyfiction docstrings

26d02fc

Signed-off-by: GitHub Actions <[email protected]>

Merge branch 'main' into extended_rank_view

d1a9c04

📝 Update pyfiction docstrings

01db414

Signed-off-by: GitHub Actions <[email protected]>

Merge remote-tracking branch 'origin/extended_rank_view' into extende…

fade0b4

…d_rank_view

Merge branch 'main' into virtual_pi_network

0a4555e

Merge branch 'extended_rank_view' into virtual_pi_network

3259bfb

🎨 Incorporated pre-commit fixes

09fa50f

github-actions bot reviewed Jan 2, 2025

View reviewed changes

hibenj added 2 commits January 3, 2025 08:57

🎨 virtual miter supports update_ranks and update_levels.

1cb8605

Merge remote-tracking branch 'origin/virtual_pi_network' into virtual…

66c412f

…_pi_network

github-actions bot reviewed Jan 3, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Virtual pi network #543

Virtual pi network #543

hibenj commented Oct 16, 2024 •

edited

Loading

codecov bot commented Oct 16, 2024 •

edited

Loading

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

Drewniok left a comment •

edited

Loading

github-actions bot left a comment

Drewniok commented Dec 16, 2024 •

edited

Loading

github-actions bot left a comment

github-actions bot Jan 2, 2025

github-actions bot Jan 2, 2025

github-actions bot Jan 2, 2025

github-actions bot Jan 2, 2025

github-actions bot Jan 2, 2025

github-actions bot Jan 2, 2025

github-actions bot Jan 2, 2025

github-actions bot Jan 2, 2025

github-actions bot Jan 2, 2025

github-actions bot Jan 2, 2025

github-actions bot left a comment

github-actions bot Jan 3, 2025

	phmap::flat_hash_map<node, uint32_t> _levels;
	phmap::flat_hash_map<node, uint32_t> levels;

	phmap::flat_hash_map<node, uint32_t> _crit_path;
	phmap::flat_hash_map<node, uint32_t> crit_path;

Virtual pi network #543

Are you sure you want to change the base?

Virtual pi network #543

Conversation

hibenj commented Oct 16, 2024 • edited Loading

Description

Checklist:

codecov bot commented Oct 16, 2024 • edited Loading

Codecov Report

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

Drewniok left a comment • edited Loading

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

Drewniok commented Dec 16, 2024 • edited Loading

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Jan 2, 2025

Choose a reason for hiding this comment

github-actions bot Jan 2, 2025

Choose a reason for hiding this comment

github-actions bot Jan 2, 2025

Choose a reason for hiding this comment

github-actions bot Jan 2, 2025

Choose a reason for hiding this comment

github-actions bot Jan 2, 2025

Choose a reason for hiding this comment

github-actions bot Jan 2, 2025

Choose a reason for hiding this comment

github-actions bot Jan 2, 2025

Choose a reason for hiding this comment

github-actions bot Jan 2, 2025

Choose a reason for hiding this comment

github-actions bot Jan 2, 2025

Choose a reason for hiding this comment

github-actions bot Jan 2, 2025

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Jan 3, 2025

Choose a reason for hiding this comment

hibenj commented Oct 16, 2024 •

edited

Loading

codecov bot commented Oct 16, 2024 •

edited

Loading

Drewniok left a comment •

edited

Loading

Drewniok commented Dec 16, 2024 •

edited

Loading