Skip to content

Document order guarantees for combinations #822

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

Merged
jswrenn merged 1 commit into from
Jan 11, 2024
Merged

Document order guarantees for combinations #822

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1591,6 +1591,11 @@ pub trait Itertools: Iterator {
/// let it: TupleCombinations<Range<u32>, (u32, u32, u32)> = (1..5).tuple_combinations();
/// itertools::assert_equal(it, vec![(1, 2, 3), (1, 2, 4), (1, 3, 4), (2, 3, 4)]);
/// ```
///
/// # Guarantees
///
/// If the adapted iterator is deterministic,
/// this iterator adapter yields items in a reliable order.
fn tuple_combinations<T>(self) -> TupleCombinations<Self, T>
where
Self: Sized + Clone,
Expand Down Expand Up @@ -1629,6 +1634,11 @@ pub trait Itertools: Iterator {
/// vec![2, 2],
/// ]);
/// ```
///
/// # Guarantees
///
/// If the adapted iterator is deterministic,
/// this iterator adapter yields items in a reliable order.
#[cfg(feature = "use_alloc")]
fn combinations(self, k: usize) -> Combinations<Self>
where
Expand Down