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

Add Zachary's Karate Club #1280

Merged
merged 30 commits into from
Nov 15, 2024
Merged

Add Zachary's Karate Club #1280

merged 30 commits into from
Nov 15, 2024

Conversation

IvanIsCoding
Copy link
Collaborator

@IvanIsCoding IvanIsCoding commented Sep 9, 2024

Adds the famous Zachary's karate club, a network that is used in many examples.

Makes #1277 easier and I assume it will be used in lots of example for community detection algorithms

@IvanIsCoding IvanIsCoding changed the title Add Zachary's karate club Add Zachary's Karate Club Sep 9, 2024
@coveralls
Copy link

coveralls commented Sep 9, 2024

Pull Request Test Coverage Report for Build 11859929189

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 109 of 109 (100.0%) changed or added relevant lines in 2 files are covered.
  • 67 unchanged lines in 1 file lost coverage.
  • Overall coverage increased (+0.009%) to 95.834%

Files with Coverage Reduction New Missed Lines %
src/iterators.rs 67 74.78%
Totals Coverage Status
Change from base Build 11709175986: 0.009%
Covered Lines: 18125
Relevant Lines: 18913

💛 - Coveralls

Copy link
Member

@mtreinish mtreinish left a comment

Choose a reason for hiding this comment

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

Overall this LGTM thanks for adding this generator. I just have a few inline comments that will slightly improve the performance and/or simplify the code.

rustworkx-core/src/generators/karate_club.rs Outdated Show resolved Hide resolved
rustworkx-core/src/generators/karate_club.rs Outdated Show resolved Hide resolved
rustworkx-core/src/generators/karate_club.rs Outdated Show resolved Hide resolved
rustworkx-core/src/generators/karate_club.rs Outdated Show resolved Hide resolved
rustworkx-core/src/generators/karate_club.rs Outdated Show resolved Hide resolved
rustworkx-core/src/generators/karate_club.rs Outdated Show resolved Hide resolved
rustworkx-core/src/generators/karate_club.rs Show resolved Hide resolved
rustworkx-core/src/generators/karate_club.rs Outdated Show resolved Hide resolved
tests/graph/test_karate.py Show resolved Hide resolved
src/generators.rs Show resolved Hide resolved
@IvanIsCoding IvanIsCoding requested a review from mtreinish October 8, 2024 03:56
Copy link
Member

@mtreinish mtreinish left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for making the updates.

tests/graph/test_karate.py Outdated Show resolved Hide resolved
@mtreinish mtreinish enabled auto-merge November 15, 2024 16:32
@mtreinish mtreinish added this pull request to the merge queue Nov 15, 2024
Merged via the queue into Qiskit:main with commit d9fbe83 Nov 15, 2024
26 checks passed
Gohlub pushed a commit to Gohlub/rustworkx that referenced this pull request Nov 17, 2024
* Karate club draft

* Add Zachary's data

* Consider weight for Karate Club

* Add tests

* Add karate_club_graph signature

* Fix clippy

* Update rustworkx-core/src/generators/karate_club.rs

Co-authored-by: Alexander Ivrii <[email protected]>

* Add labels and documentation

* Test node labels

* Add simple Rust docstring

* Add release notes

* Black changes

* Update test to be independent

* Apply suggestions from code review

Co-authored-by: Matthew Treinish <[email protected]>

* Format and u8

* Ignore ruff for that file

* Use adjacency list

* Add some documentation

* Update tests/graph/test_karate.py

---------

Co-authored-by: Alexander Ivrii <[email protected]>
Co-authored-by: Matthew Treinish <[email protected]>
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.

4 participants