Home / Rust / Data structures

Extra iterator adaptors, iterator methods, free functions, and macros.

Itertools Extra iterator adaptors, functions and macros. Please read the API documentation here How to use with cargo: [dependencies] itertools = "0.9
Information
Category: Rust / Data structures
Watchers: 22
Star: 2.4k
Fork: 276
Last update: Dec 8, 2023
Resource links
https://docs.rs/itertools/
https://github.com/rust-itertools/itertools

Itertools

Extra iterator adaptors, functions and macros.

Please read the API documentation here

build_status crates

How to use with cargo:

[dependencies]
itertools = "0.9"

How to use in your crate:

use itertools::Itertools;

How to contribute

  • Fix a bug or implement a new thing
  • Include tests for your new feature, preferably a quickcheck test
  • Make a Pull Request

For new features, please first consider filing a PR to rust-lang/rust, adding your new feature to the Iterator trait of the standard library, if you believe it is reasonable. If it isn't accepted there, proposing it for inclusion in itertools is a good idea. The reason for doing is this is so that we avoid future breakage as with .flatten(). However, if your feature involves heap allocation, such as storing elements in a Vec<T>, then it can't be accepted into libcore, and you should propose it for itertools directly instead.

License

Dual-licensed to be compatible with the Rust project.

Licensed under the Apache License, Version 2.0 http://www.apache.org/licenses/LICENSE-2.0 or the MIT license http://opensource.org/licenses/MIT, at your option. This file may not be copied, modified, or distributed except according to those terms.

162 Open More issues
Closed

Add exactly_one function

Adds a small function I found uses for personally. Can't be added to the core library because in the error case it allocates a vec and stores data in it.

opened Oct 2, 2018 by Xaeroxe 26
Closed

Preparation for next release series (0.5.x)

We will remove a lot of deprecated items, and rename some.

This is on the road towards an eventual 1.0 version of the library.

Notes

  • Numerical things will move because we don't want num-traits in itertools. linspace will move to a crate that uses num-traits
  • Use free functions to construct iterators that are sources. For example Unfold::new(x, y) → unfold(x, y). Follows libstd convention (std::iter::once).
  • Unstable/nightly parts will need to live in another crate
  • Rename and move stuff around to increase consistency. This is the best for the long run.
  • See the commits for an overview

See also #87

Fixes #86

opened Sep 19, 2016 by bluss 23
Closed

map_into method

To allow easy conversion of all elements.

fixes #280 (map_into sounded better than map_from).

opened Jun 2, 2018 by vorner 21
Closed

Add k-way merge adaptor.

Merges an arbitrary number of iterators in ascending order.

Uses std's BinaryHeap to decide which iterator to take from next. This seems quite heavyweight. Two-way merge benchmarks take roughly ten times longer than the dedicated two-way merge adaptor. Profiling identifies BinaryHeaps sift_up as the hot-spot.

Not completely sure about the interface, the double use of IntoIterator in the free-standing function in particular.

opened Feb 12, 2016 by bsteinb 20
Closed

Add `exhaust` which simply exhausts the iterator

This is useful for iterators which are simply used for their side effects.

The new function is added to make intent clearer for places where you'd previously call count or similar to exhaust the iterator.

opened Jun 20, 2016 by tbu- 18
Closed

Added `diff.rs` module with `diff` and `copy_on_diff` - for efficiently "diff"ing and caching non-`Clone` iterators.

I originally wrote this module for a couple of cases in conrod where I wanted to cache a non-Clone iterator without having to collect the iterator into a Vec for comparison in case the cache needed updating.

I've just come across another similar case in a personal project, so before copying code across I thought I'd approach the itertools team in case you deem it worthy of adding to your luscious collection.

Either way, any feedback appreciated!

opened Jan 3, 2016 by mitchmindtree 18
Open

Improve `tuple_windows()` doc (add a reference to `pairwise`)

As shown in #388, tuple_windows can be hard to find if you come from other environment (python, RxJs, …) since people may expect to find a pairwise() method instead.

opened Jun 11, 2020 by robinmoussu 0
Open

Interleave doc should explains how it is different from `std::iter::zip`

When reading the documentation of interleave I wasn't able to understand what is the difference with std::iter::zip(), and why/when should one be preferred to the other.

opened Jun 11, 2020 by robinmoussu 0
Open

Added Range iterator

I thought an iterator that iterates over a range of values would be pretty neat to have. Use if you want to!

opened Jun 5, 2020 by TrolledWoods 22
Open

Add assert_empty?

I think this would be a useful addition.

pub fn assert_empty<I>(i: impl IntoIterator<Item = I>)
where
    I: Debug + PartialEq<I>,
{
    assert_equal(i, iter::empty::<I>());
}

Except it probably needs to have it's own error message implementation since "left" and "right" wouldn't make sense.

opened May 29, 2020 by camsteffen 0
Open

Implement DedupBy in terms of Coalesce

During the discussion of https://github.com/rust-itertools/itertools/pull/423#issuecomment-629713830, we found that DedupBy/DedupByWithCount could actually be implemented in terms of Coalesce. This simplifies the implementation quite a bit and lets derived adaptors inherit specializations.

  • Implement fold on Coalesce so that all the adaptors derived from it inherit the specialization (currently, only DedupBy has this specialization).
  • Introduce CoalescePredicate (similar to DedupPredicate) to allow for different customizations of Coalesce.
  • Introduce parametrizable CoalesceBy: Base for Coalesce, DedupBy, DedupByWithCount.
  • Implement DedupBy/DedupByWithCount in terms of CoalesceBy (using particular impls).
  • At last, the indirection through CoalesceCore is not needed anymore.
opened May 18, 2020 by phimuemue 0
Open

impl debug trait for diff enum

I added a fairly simple yet informative fmt::Debug implementation to the Diff enum. The reasoning behind this is to simplify tests where you just want to say:

// Diff some expected iter with the actual outputted one
let diff = itertools::diff_with(ex, out, |a, b| a == b);

// Now, all you care about is that there is no difference
// If there is, the index of the diff will be logged by assert_eq!
// since diff now impls fmt::Debug
assert_eq!(None, diff);
opened May 10, 2020 by Zaba505 2

Contents

    charleslxh buffer iterator, to read byte one by one
    jprichardson Node.js: extra methods for the fs object like copy(), remove(), mkdirs()
    krdln fomat-macros - Alternative syntax for print/write/format-like macros with a small templating language
    danielkeep scan-rules - This crate provides some macros for quickly parsing values out of text. Roughly speaking, it does the inverse of the print!/format! macros; or, in other words, a similar job to scanf from C.
    azriel91 proc_macro_roids - Traits and functions to make writing proc macros more ergonomic
    jamiemccrindle Async Iterator Extensions for JavaScript e.g. map, reduce, filter, flatMap, etc.
    sebastiaanluca An extensive set of Laravel framework helper functions and collection macros.
    alecthomas Benchmarks of Go serialization methods
    ChenHongruixuan This repository contains some python code of some traditional change detection methods or provides their original websites, such as SFA, MAD, and some deep learning-based change detection methods, such as SiamCRNN, DSFA, and some FCN-based methods.
    mokkabonna vue-async-methods - Helper utilities for promise based methods
    evenchange4 Compile GraphQL AST at build-time with babel-plugin-macros.
    Veykril The Little Book of Rust Macros(Updated)
    dtolnay macro proc-macro-hack - Procedural macros in expression position
    vultix Quickly prototype Rust procedural macros using JavaScript or TypeScript!
    sindresorhus Async concurrent iterator (async forEach)
    mtoohey31 Package iter provides generic, lazy iterators, functions for producing them from primitive types, as well as functions and methods for transforming and consuming them.
    lzxb Let Vue methods support return Promise
    chrisgrieser Extra Markdown & HTML Syntax for Obsidian
    andylokandy comp - Pure-macro Do notation and List-comprehension for Option, Result and Iterator
    NasalDaemon Functional C++ iterator library
    romshark High performance JSON iterator for Go
    Share this repo

    Related Repos


    Data structures
    265
    A minimal `syn` syntax tree pretty-printer
    dtolnay prettyplease::unparse A minimal syn syntax tree pretty-printer. Overview This is a pretty-printer to turn a syn syntax tree into a String of well-form
     
    Data structures
    4
    A memory efficient syntax tree for language developers
    udoprog syntree A memory efficient syntax tree. This crate provides a tree structure which always is contiguously stored and manipulated in memory. It provide
     
    Data structures
    8
    Rust library providing fast language model queries in compressed space
    kampersanda tongrams-rs: Tons of N-grams in Rust This is a Rust port of tongrams to index and query large language models in compressed space, in which the data s
     
    Data structures
    5
    Traversal of tree-sitter Trees and any arbitrary tree with a TreeCursor-like interface
    skmendez tree-sitter-traversal Traversal of tree-sitter Trees and any arbitrary tree with a TreeCursor-like interface. Using cursors, iteration over the tree c
     
    Data structures
    3
    A tiny rusty Xmas tree without bells and whistles
    lmammino xmas A tiny rusty Xmas tree without bells and whistles Run Just clone this repo and run: cargo run (Requires to have Rust installed) Contributing Ever
     
    Data structures
    33
    A LED Christmas Tree controlled by Rust. Contribute your own renderers!
    AngelOnFira Rusty Christmas Tree This is code that draws on the LED Christmas Tree made by @aidancrowther. You can see his 3D design files and Pi Pico setup code
     
    Data structures
    3
    A syntax highlighter for Node powered by Tree Sitter. Written in Rust.
    devongovett tree-sitter-highlight A syntax highlighter for Node.js powered by Tree Sitter. Usage The following will output HTML: const treeSitter = require('tree-
     
    Data structures
    229
    Tree command, improved.
    dduan tre A modern alternative to the tree command that: lists directory structure in a tree-like diagram, like the classics. skips ignored files in git rep
     
    Data structures
    12
    Serialize & deserialize device tree binary using serde
    luojia65 serde_device_tree Use serde framework to deserialize Device Tree Blob binary files; no_std compatible. Use this library Run example: cargo run --examp
     
    Data structures
    10
    StdFuzzer is the reference implementation of a generic bit-level fuzzer with LibAFL
    AFLplusplus StdFuzzer StdFuzzer is the reference implementation of a generic bit-level fuzzer with LibAFL Building Build with $ cargo build --release Compiling a
     
    Data structures
    9
    Rasterization using compute shaders
    pudnax gpu_compute_rasterizer This is a basic implementation of a rasterizer using compute shaders and wgpu. Based on: https://github.com/OmarShehata/webgpu-
     
    Data structures
    3
    A "cursed" container with opaque keys, usable as a static variable
    u1f408 cursedcontainer Please, for the love of all things good in the world, do not use this crate unless you've read the code thoroughly and understand the
     
    Data structures
    3
    Voluntarily contributed solutions for the first practical exercise for the Compilerbau lec...
    Yandrik Solutions for the first practical exercise Compilerbau lecture WiSe 2021/2022 - Ulm University Contributing Want to add your solution? Great! Just add
     
    Data structures
    12
    Common data structures and algorithms for competitive programming in Rust
    utilForever algorithm-rs algorithm-rs is common data structures and algorithms for competitive programming in Rust. Contents TBA How To Contribute Contributions a
     
    Data structures
    1.4k
    Rust implementations of algorithms and data structures useful for bioinformatics.
    rust-bio This library provides implementations of many algorithms and data structures that are useful for bioinformatics. All provided implementations are rigorously tested via continuous integration.