rust-lang / rust-lang/libs-team
[ACP] RangeBounds::overlaps
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 178
- Forks
- 28
- Avg merge
- 15m
- Merged PRs (30d)
- 1
Description
Proposal
Problem statement
RangeBounds today is a standard trait to represent ranges and provides a single method contains used to determine if a range contains a given element.
Another common operation on ranges (like intervals) is to check if 2 overlap. Today there is no method to check for that
Motivating examples or use cases
- a database implementation using btree index where a parent node would split its total key range in ranges per child. To implement an operation to find keys within a given range it would need to check if child ranges overlap with an input range
- An interval map implementation would need to be able to check for overlaps
- A memory copy/move implementation operation may check for overlaps to decide if it needs to use move or copy
- A database implementation allowing to operate on ranges (eg range deletes, range queries, etc) would need to have an ability to check for range overlaps
Solution sketch
pub trait RangeBounds<T: ?Sized> {
/// Returns `true` if there exists an element present in both ranges.
///
/// # Examples
///
/// ```
/// assert!( (3..5).overlaps(&(1..4));
/// assert!(!(3..5).overlaps(&(5..6));
/// ```
///
fn overlaps<O, E>(&self, other: &O) -> bool
where
T: PartialOrd<E>,
E: ?Sized + PartialOrd<T>,
O: RangeBounds<E>,
{
todo!()
}
}
Open questions
There is a question whether to consider (Excluded(1), Excluded(3)) as overlapping with (Excluded(2), Excluded(5)).
Since this is only a problem for cases where a discrete step between elements is known we could have a specialized implementation for anything that implements Step that handles these cases.
Alternatives
Alternative would be for developers to implement it on specific types, or an extension trait on top of RangeBounds (which could be a separate crate)
Links and related work
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the RangeBounds trait and the proposed overlaps signature in this issue. Review the motivating range, interval-map, memory, and database use cases, then resolve the open question about excluded bounds and discrete steps. Done means the API scope and overlap semantics are agreed and documented well enough for implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100