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

return also syndrome and v_node validity from decoder (Sourcery refactored) #27

Closed
wants to merge 1 commit into from

Conversation

sourcery-ai[bot]
Copy link

@sourcery-ai sourcery-ai bot commented Mar 10, 2022

Pull Request #26 refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

NOTE: As code is pushed to the original Pull Request, Sourcery will
re-run and update (force-push) this Pull Request with new refactorings as
necessary. If Sourcery finds no refactorings at any point, this Pull Request
will be closed automatically.

See our documentation here.

Run Sourcery locally

Reduce the feedback loop during development by using the Sourcery editor plugin:

Review changes via command line

To manually merge these changes, make sure you're on the bp_decoder branch, then run:

git fetch origin sourcery/bp_decoder
git merge --ff-only FETCH_HEAD
git reset HEAD^

Help us improve this pull request!

@sourcery-ai sourcery-ai bot requested a review from YairMZ March 10, 2022 21:01
Comment on lines -58 to +60
raise ValueError("No v-node with uid " + str(v_uid) + " in graph")
raise ValueError(f"No v-node with uid {str(v_uid)} in graph")
if c_uid not in self.c_nodes:
raise ValueError("No c-node with uid " + str(c_uid) + " in graph")
raise ValueError(f"No c-node with uid {str(c_uid)} in graph")
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Function TannerGraph.add_edges_by_uid refactored with the following changes:

Comment on lines -71 to +74
raise ValueError("No v-node with name " + v_name + " in graph")
raise ValueError(f"No v-node with name {v_name} in graph")
c_uid = [node.uid for node in self.c_nodes.values() if node.name == c_name]
if not c_uid:
raise ValueError("No c-node with name " + c_name + " in graph")
raise ValueError(f"No c-node with name {c_name} in graph")
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Function TannerGraph.add_edges_by_name refactored with the following changes:

Comment on lines -82 to +89
if not by_name:
return self.edges
return {(self.v_nodes.get(vn).name, self.c_nodes.get(cn).name) for vn, cn in self.edges} # type: ignore
return (
{
(self.v_nodes.get(vn).name, self.c_nodes.get(cn).name)
for vn, cn in self.edges
}
if by_name
else self.edges
)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Function TannerGraph.get_edges refactored with the following changes:

This removes the following comments ( why? ):

# type: ignore

@sourcery-ai
Copy link
Author

sourcery-ai bot commented Mar 10, 2022

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.27%.

Quality metrics Before After Change
Complexity 2.99 ⭐ 3.05 ⭐ 0.06 👎
Method Length 41.08 ⭐ 40.92 ⭐ -0.16 👍
Working memory 6.67 🙂 6.72 🙂 0.05 👎
Quality 80.70% 80.43% -0.27% 👎
Other metrics Before After Change
Lines 107 112 5
Changed files Quality Before Quality After Quality Change
ldpc/decoder/graph.py 80.70% ⭐ 80.43% ⭐ -0.27% 👎

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation

Legend and Explanation

The emojis denote the absolute quality of the code:

  • ⭐ excellent
  • 🙂 good
  • 😞 poor
  • ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.


Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

@sourcery-ai sourcery-ai bot closed this Mar 10, 2022
@sourcery-ai sourcery-ai bot deleted the sourcery/bp_decoder branch March 10, 2022 21:03
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

Successfully merging this pull request may close these issues.

None yet

0 participants