✨ Gate-level layout file reader and writer #296

simon1hofmann · 2023-09-27T10:23:59Z

Description

This PR introduces a file writer and a parser to store/read gate_level_layouts in .fgl files.

Checklist:

The pull request only contains commits that are related to it.
I have added appropriate tests and documentation.
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.

github-actions

clang-tidy made some suggestions

include/fiction/io/read_gate_level_layout.hpp

include/fiction/io/write_gate_level_layout.hpp

github-actions

clang-tidy made some suggestions

include/fiction/io/read_gate_level_layout.hpp

include/fiction/io/write_gate_level_layout.hpp

codecov · 2023-09-27T12:17:42Z

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (9d1c542) 95.83% compared to head (d4c583b) 96.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #296      +/-   ##
==========================================
+ Coverage   95.83%   96.00%   +0.16%     
==========================================
  Files          98      100       +2     
  Lines        9539     9906     +367     
==========================================
+ Hits         9142     9510     +368     
+ Misses        397      396       -1

Files	Coverage Δ
include/fiction/io/read_fgl_layout.hpp	`100.00% <100.00%> (ø)`
include/fiction/io/write_fgl_layout.hpp	`100.00% <100.00%> (ø)`

... and 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

include/fiction/io/read_gate_level_layout.hpp

include/fiction/io/write_gate_level_layout.hpp

include/fiction/io/read_gate_level_layout.hpp

github-actions

clang-tidy made some suggestions

include/fiction/io/read_gate_level_layout.hpp

github-actions

clang-tidy made some suggestions

include/fiction/io/read_gate_level_layout.hpp

github-actions

clang-tidy made some suggestions

include/fiction/io/read_gate_level_layout.hpp

github-actions

clang-tidy made some suggestions

include/fiction/io/read_gate_level_layout.hpp

include/fiction/io/write_gate_level_layout.hpp

include/fiction/io/read_gate_level_layout.hpp

include/fiction/io/write_gate_level_layout.hpp

Co-authored-by: Marcel Walter <[email protected]>

github-actions

clang-tidy made some suggestions

include/fiction/io/read_gate_level_layout.hpp

github-actions

clang-tidy made some suggestions

include/fiction/io/read_fgl_layout.hpp

include/fiction/io/write_fgl_layout.hpp

github-actions

clang-tidy made some suggestions

include/fiction/io/read_fgl_layout.hpp

github-actions

clang-tidy made some suggestions

cli/cmd/io/read.hpp

marcelwa

Many thanks for the edits. Almost there. Just a handful of minor comments really.

cli/cmd/io/read.hpp

include/fiction/io/read_fgl_layout.hpp

include/fiction/io/write_fgl_layout.hpp

test/io/read_fgl_layout.cpp

test/io/write_fgl_layout.cpp

Co-authored-by: Marcel Walter <[email protected]>

github-actions

clang-tidy made some suggestions

cli/cmd/io/read.hpp

Co-authored-by: Marcel Walter <[email protected]>

marcelwa

LGTM! Many thanks for this great addition 🙏

simon1hofmann and others added 10 commits September 25, 2023 17:54

basic parser for gate level layouts

8546100

implement gate_level_layout reader for simple layouts

c429ae6

add missing gate types

5306758

write layout metadata

4973ad2

small fix

680cc01

extend write capabilities

7805678

fix layout name error

9393d68

remove debug output

5d9c2d2

Merge branch 'cda-tum:main' into gate_level_layout_io

20ffd2d

Extend writing capabilities

25d2534

simon1hofmann added the enhancement New feature or request label Sep 27, 2023

simon1hofmann requested a review from marcelwa September 27, 2023 10:23

simon1hofmann self-assigned this Sep 27, 2023

add node functions

15ae876

github-actions bot reviewed Sep 27, 2023

View reviewed changes

github-advanced-security bot found potential problems Sep 27, 2023

View reviewed changes

include/fiction/io/read_gate_level_layout.hpp Fixed Show fixed Hide fixed

include/fiction/io/write_gate_level_layout.hpp Fixed Show fixed Hide fixed

include/fiction/io/read_gate_level_layout.hpp Fixed Show fixed Hide fixed

Simon added 2 commits September 27, 2023 19:32

clang-tidy ánd 100% test coverage

6a502cd

more tests

5a9484c

github-actions bot reviewed Sep 27, 2023

View reviewed changes

include/fiction/io/read_gate_level_layout.hpp Outdated Show resolved Hide resolved

include/fiction/io/read_gate_level_layout.hpp Outdated Show resolved Hide resolved

include/fiction/io/read_gate_level_layout.hpp Outdated Show resolved Hide resolved

clang-tidy

9ead80a

github-actions bot reviewed Sep 27, 2023

View reviewed changes

include/fiction/io/read_gate_level_layout.hpp Outdated Show resolved Hide resolved

include/fiction/io/read_gate_level_layout.hpp Outdated Show resolved Hide resolved

clang-tidy

1585cdc

github-actions bot reviewed Sep 27, 2023

View reviewed changes

include/fiction/io/read_gate_level_layout.hpp Outdated Show resolved Hide resolved

include/fiction/io/read_gate_level_layout.hpp Outdated Show resolved Hide resolved

include/fiction/io/read_gate_level_layout.hpp Outdated Show resolved Hide resolved

Simon added 2 commits September 27, 2023 19:49

clang format

7784e8f

100% coverage

fd716cf

github-actions bot reviewed Sep 27, 2023

View reviewed changes

include/fiction/io/read_gate_level_layout.hpp Outdated Show resolved Hide resolved

marcelwa requested changes Sep 28, 2023

View reviewed changes

Apply suggestions from code review

7c6db20

Co-authored-by: Marcel Walter <[email protected]>

github-actions bot reviewed Oct 4, 2023

View reviewed changes

include/fiction/io/read_gate_level_layout.hpp Outdated Show resolved Hide resolved

include/fiction/io/read_gate_level_layout.hpp Outdated Show resolved Hide resolved

simon1hofmann and others added 6 commits October 5, 2023 09:49

second batch of todos

22f44b8

Merge branch 'main' into gate_level_layout_io

d0e8238

Merge branch 'main' into gate_level_layout_io

271f333

Merge branch 'main' into gate_level_layout_io

cb16e3f

use .fgl file extension

cbed85c

small fix

2118b1c

github-actions bot reviewed Oct 5, 2023

View reviewed changes

github-advanced-security bot found potential problems Oct 5, 2023

View reviewed changes

include/fiction/io/write_fgl_layout.hpp Fixed Show fixed Hide fixed

simon1hofmann requested a review from marcelwa October 5, 2023 15:26

Simon added 2 commits October 5, 2023 19:17

fix warnings

8800c2f

ignore warning

2729bff

github-actions bot reviewed Oct 5, 2023

View reviewed changes

include/fiction/io/read_fgl_layout.hpp Show resolved Hide resolved

include/fiction/io/read_fgl_layout.hpp Show resolved Hide resolved

include/fiction/io/read_fgl_layout.hpp Show resolved Hide resolved

simon1hofmann and others added 4 commits October 5, 2023 19:41

Merge branch 'main' into gate_level_layout_io

5484320

update docs

34166e8

Merge branch 'main' into gate_level_layout_io

7f294c3

add cli commands for reading and writing

5fcdd7b

simon1hofmann added the cli Concerning the command-line interface (CLI) label Oct 6, 2023

github-actions bot reviewed Oct 6, 2023

View reviewed changes

cli/cmd/io/read.hpp Show resolved Hide resolved

cli/cmd/io/read.hpp Outdated Show resolved Hide resolved

marcelwa requested changes Oct 6, 2023

View reviewed changes

simon1hofmann and others added 2 commits October 6, 2023 14:00

Apply suggestions from code review

4960cc4

Co-authored-by: Marcel Walter <[email protected]>

fix todos from code review

ddefb5f

github-actions bot reviewed Oct 6, 2023

View reviewed changes

cli/cmd/io/read.hpp Show resolved Hide resolved

cli/cmd/io/read.hpp Show resolved Hide resolved

simon1hofmann requested a review from marcelwa October 6, 2023 14:22

marcelwa reviewed Oct 6, 2023

View reviewed changes

cli/cmd/io/read.hpp Outdated Show resolved Hide resolved

Update read.hpp

d4c583b

Co-authored-by: Marcel Walter <[email protected]>

marcelwa changed the title ~~✨ Gate level layout reader and writer~~ ✨ Gate-level layout file reader and writer Oct 6, 2023

marcelwa approved these changes Oct 6, 2023

View reviewed changes

simon1hofmann merged commit 0b7e2fb into cda-tum:main Oct 6, 2023
58 checks passed

simon1hofmann deleted the gate_level_layout_io branch October 18, 2023 13:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Gate-level layout file reader and writer #296

✨ Gate-level layout file reader and writer #296

simon1hofmann commented Sep 27, 2023 •

edited by marcelwa

Loading

github-actions bot left a comment

github-actions bot left a comment

codecov bot commented Sep 27, 2023 •

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

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

marcelwa left a comment

github-actions bot left a comment

marcelwa left a comment

✨ Gate-level layout file reader and writer #296

✨ Gate-level layout file reader and writer #296

Conversation

simon1hofmann commented Sep 27, 2023 • edited by marcelwa Loading

Description

Checklist:

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

codecov bot commented Sep 27, 2023 • 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

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

marcelwa left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

marcelwa left a comment

Choose a reason for hiding this comment

simon1hofmann commented Sep 27, 2023 •

edited by marcelwa

Loading

codecov bot commented Sep 27, 2023 •

edited

Loading