Skip to content

Add checked UnionFind methods #730

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.

Sign up for GitHub

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

Jump to bottom
Merged
ABorgna merged 1 commit into from
Feb 6, 2025
Merged

Add checked UnionFind methods #730

ABorgna merged 1 commit into from
Feb 6, 2025

Conversation

@starovoid
Copy link
Collaborator

@starovoid starovoid commented Feb 6, 2025

PR provides the following UnionFind methods, that are free from panics:

pub fn try_find(&self, mut x: K) -> Option<K>

pub fn try_find_mut(&mut self, x: K) -> Option<K>

pub fn try_equiv(&self, x: K, y: K) -> Result<bool, K>

pub fn try_union(&mut self, x: K, y: K) -> Result<bool, K>

Some of old methods were rewritten using the try twins with the addition of .unwrap or .expect, for example:

pub fn find(&self, x: K) -> K {
    self.try_find(x).expect("The index is out of bounds")
}

If you consider these changes to be critical & breaking, I will return back the old assertions.

I'm open to discussion!

@starovoid starovoid mentioned this pull request Feb 6, 2025
Closed
ABorgna
ABorgna approved these changes Feb 6, 2025
View reviewed changes
Copy link
Member

@ABorgna ABorgna left a comment

Choose a reason for hiding this comment

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

Thanks!

@ABorgna
Copy link
Member

ABorgna commented Feb 6, 2025

Error messages are not stable, changing them is not a semver break.

@ABorgna ABorgna merged commit a49bc40 into petgraph:master Feb 6, 2025
7 checks passed
@starovoid starovoid deleted the uf-checked branch February 7, 2025 09:03
This was referenced Apr 5, 2025
Merged
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ABorgna ABorgna ABorgna approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@starovoid @ABorgna