itermore

Crates.ioitermore
lib.rsitermore
version0.7.1
sourcesrc
created_at2021-10-06 20:43:12.003449
updated_at2023-12-15 14:13:27.141155
description🤸‍♀️ More iterator adaptors
homepage
repositoryhttps://github.com/rossmacarthur/itermore
max_upload_size
id461358
size102,312
Ross MacArthur (rossmacarthur)

documentation

README

itermore

Crates.io Version Docs.rs Latest Build Status

🤸‍♀️ More iterator adaptors.

This crate provides some useful iterator adaptors and functions. Unlike itertools this crate provides a separate extension trait for each adaptor. Additionally, each type of adaptor is feature flagged so you only have to compile the features you need.

Getting started

Add the crate to Cargo manifest.

cargo add itermore --features full

And bring the extension traits into scope.

use itermore::prelude::*;

Now you can use extension methods like array_windows on any iterator.

for [a, b, c] in iter.array_windows() {
    println!("{} {} {}", a, b, c)
}
// Outputs
//    1 2 3
//    2 3 4
//    3 4 5

It is recommended to only enable the features that you need. For example if you only want the array_combinations adaptor you would add the following to your Cargo manifest.

[dependencies]
itermore = { version = "*", features = ["array_combinations"]}

Provided functionality

Methods

  • collect_array: Collects an iterator into an array.
  • min_max and friends: Returns the minimum and maximum element of an iterator.
  • next_chunk: Returns the next N elements of the iterator as an array.
  • sorted and friends: Returns a new iterator with all elements sorted.

Adaptors

  • array_chunks returns an iterator over N elements of the iterator at a time.
  • array_windows returns an iterator over all contiguous windows of length N.
  • array_combinations returns an iterator over K length combinations of all the elements in the underlying iterator.
  • array_combinations_with_reps returns an iterator over K length combinations with repetitions/replacements of all the elements in the underlying iterator.
  • cartesian_product returns an iterator over the cartesian product of the element sets of two iterators.
  • circular_array_windows returns an iterator over all contiguous windows of length N that wraps around at the end.
  • combinations returns an iterator over k length combinations of all the elements in the underlying iterator.
  • combinations_with_reps returns an iterator over k length combinations with repetitions/replacements of all the elements in the underlying iterator.

License

This project is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.

Commit count: 74

cargo fmt