Added Edmonds Blossom Algorithm #12043 #12044
Conversation
algorithms-keeper
bot
added
require descriptive names
![algorithms-keeper[bot]](https://avatars.githubusercontent.com/in/235834?s=60&v=4){kind=small}
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
| class EdmondsBlossomAlgorithm: | ||
|
|
||
| @staticmethod | ||
| def maximum_matching(edges, vertex_count): |
There was a problem hiding this comment.
Please provide return type hint for the function: maximum_matching. If the function does not return a value, please provide the type hint as: def function() -> None:
As there is no test file in this pull request nor any test function or class in the file graphs/edmond_blossom_algorithm.py, please provide doctest for the function maximum_matching
Please provide type hint for the parameter: edges
Please provide type hint for the parameter: vertex_count
| return matching_result | ||
|
|
||
| @staticmethod | ||
| def update_matching(match, parent, u): |
There was a problem hiding this comment.
Please provide return type hint for the function: update_matching. If the function does not return a value, please provide the type hint as: def function() -> None:
As there is no test file in this pull request nor any test function or class in the file graphs/edmond_blossom_algorithm.py, please provide doctest for the function update_matching
Please provide type hint for the parameter: match
Please provide type hint for the parameter: parent
Please provide type hint for the parameter: u
Please provide descriptive name for the parameter: u
| u = next_node | ||
|
|
||
| @staticmethod | ||
| def find_base(base, parent, u, v): |
There was a problem hiding this comment.
Please provide return type hint for the function: find_base. If the function does not return a value, please provide the type hint as: def function() -> None:
As there is no test file in this pull request nor any test function or class in the file graphs/edmond_blossom_algorithm.py, please provide doctest for the function find_base
Please provide type hint for the parameter: base
Please provide type hint for the parameter: parent
Please provide type hint for the parameter: u
Please provide descriptive name for the parameter: u
Please provide type hint for the parameter: v
Please provide descriptive name for the parameter: v
| current_v = parent[current_v] | ||
|
|
||
| @staticmethod | ||
| def contract_blossom(blossom_data): |
There was a problem hiding this comment.
Please provide return type hint for the function: contract_blossom. If the function does not return a value, please provide the type hint as: def function() -> None:
As there is no test file in this pull request nor any test function or class in the file graphs/edmond_blossom_algorithm.py, please provide doctest for the function contract_blossom
Please provide type hint for the parameter: blossom_data
| """ | ||
| A helper class to encapsulate auxiliary data used during blossom contraction. | ||
| """ | ||
| def __init__(self, queue, parent, base, in_blossom, match, in_queue): |
There was a problem hiding this comment.
Please provide return type hint for the function: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:
Please provide type hint for the parameter: queue
Please provide type hint for the parameter: parent
Please provide type hint for the parameter: base
Please provide type hint for the parameter: in_blossom
Please provide type hint for the parameter: match
Please provide type hint for the parameter: in_queue
| """ | ||
| A helper class to store parameters necessary for blossom contraction. | ||
| """ | ||
| def __init__(self, aux_data, u, v, lca): |
There was a problem hiding this comment.
Please provide return type hint for the function: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:
Please provide type hint for the parameter: aux_data
Please provide type hint for the parameter: u
Please provide descriptive name for the parameter: u
Please provide type hint for the parameter: v
Please provide descriptive name for the parameter: v
Please provide type hint for the parameter: lca
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
|
|
||
| class EdmondsBlossomAlgorithm: | ||
| @staticmethod | ||
| def maximum_matching(edges, vertex_count): |
There was a problem hiding this comment.
Please provide return type hint for the function: maximum_matching. If the function does not return a value, please provide the type hint as: def function() -> None:
As there is no test file in this pull request nor any test function or class in the file graphs/edmond_blossom_algorithm.py, please provide doctest for the function maximum_matching
Please provide type hint for the parameter: edges
Please provide type hint for the parameter: vertex_count
| return matching_result | ||
|
|
||
| @staticmethod | ||
| def update_matching(match, parent, u): |
There was a problem hiding this comment.
Please provide return type hint for the function: update_matching. If the function does not return a value, please provide the type hint as: def function() -> None:
As there is no test file in this pull request nor any test function or class in the file graphs/edmond_blossom_algorithm.py, please provide doctest for the function update_matching
Please provide type hint for the parameter: match
Please provide type hint for the parameter: parent
Please provide type hint for the parameter: u
Please provide descriptive name for the parameter: u
| u = next_node | ||
|
|
||
| @staticmethod | ||
| def find_base(base, parent, u, v): |
There was a problem hiding this comment.
Please provide return type hint for the function: find_base. If the function does not return a value, please provide the type hint as: def function() -> None:
As there is no test file in this pull request nor any test function or class in the file graphs/edmond_blossom_algorithm.py, please provide doctest for the function find_base
Please provide type hint for the parameter: base
Please provide type hint for the parameter: parent
Please provide type hint for the parameter: u
Please provide descriptive name for the parameter: u
Please provide type hint for the parameter: v
Please provide descriptive name for the parameter: v
| current_v = parent[current_v] | ||
|
|
||
| @staticmethod | ||
| def contract_blossom(blossom_data): |
There was a problem hiding this comment.
Please provide return type hint for the function: contract_blossom. If the function does not return a value, please provide the type hint as: def function() -> None:
As there is no test file in this pull request nor any test function or class in the file graphs/edmond_blossom_algorithm.py, please provide doctest for the function contract_blossom
Please provide type hint for the parameter: blossom_data
| A helper class to encapsulate auxiliary data used during blossom contraction. | ||
| """ | ||
|
|
||
| def __init__(self, queue, parent, base, in_blossom, match, in_queue): |
There was a problem hiding this comment.
Please provide return type hint for the function: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:
Please provide type hint for the parameter: queue
Please provide type hint for the parameter: parent
Please provide type hint for the parameter: base
Please provide type hint for the parameter: in_blossom
Please provide type hint for the parameter: match
Please provide type hint for the parameter: in_queue
| A helper class to store parameters necessary for blossom contraction. | ||
| """ | ||
|
|
||
| def __init__(self, aux_data, u, v, lca): |
There was a problem hiding this comment.
Please provide return type hint for the function: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:
Please provide type hint for the parameter: aux_data
Please provide type hint for the parameter: u
Please provide descriptive name for the parameter: u
Please provide type hint for the parameter: v
Please provide descriptive name for the parameter: v
Please provide type hint for the parameter: lca
for more information, see https://pre-commit.ci
Describe your change:
This PR implements the Edmonds' Blossom Algorithm in the EdmondsBlossomAlgorithm class, which efficiently finds the maximum matching in general graphs, including those with odd-length cycles. The implementation includes methods for handling augmenting paths, updating matchings, and contracting blossoms.
Maximum Matching: Introduces the maximumMatching method, which takes a list of edges and the total number of vertices as input and returns a list of matched pairs of vertices.
Augmenting Path Search: Utilizes a breadth-first search (BFS) approach to locate augmenting paths within the graph, ensuring that it can handle complex graph structures effectively.
Blossom Contraction: Implements mechanisms for contracting blossoms to manage odd-length cycles, which is a key aspect of the algorithm's efficiency.
Detailed Comments: Each method and critical section of the code are thoroughly commented to ensure clarity and understanding of the algorithm's functionality.
Checklist: