iterators are confusing

Aperta
#1,043 1 commento 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
rust

Direzione di ricerca

Start with the ArrayBase documentation and the axis_iter(), par_iter(), indexed_iter(), IndexedIter, and Zip entry points named in the issue. Review how into_par_iter() and enumerate() are currently exposed, then seek maintainer guidance on which iterator APIs or documentation changes are wanted. Done means an agreed scope is implemented and the relevant iterator behavior and documentation are covered.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

The current framework for iteration over arrays is confusing. Issue edited because it's even more confusing than at first glance!

Common scenarios for iteration include:

  • Iterating over the elements of an array
  • Iterating over subviews along an axis of an array
  • Iterating mutably
  • Indexed iteration
  • Iterating over multiple arrays in lockstep
  • Parallel iteration with Rayon

Users may expect some consistent idioms with regard to how these different iterators are accessed. The ArrayBase documentation is the starting point for many users. It is currently non-obvious (at least to me) that:

  • We can iterate over subviews along an axis in parallel.
    Because there is ArrayBase::par_iter() but not ArrayBase::par_axis_iter().
  • We can have indexed iterators over subview along an axis.
    Because there is ArrayBase::indexed_iter() but not ArrayBase::indexed_axis_iter().

I may be missing it, but it appears there is no currently no way to:

  • Get a parallel version of IndexedIter without the overhead of Zip::indexed().
  • Get a (non-parallel) Iterator from Zip.

There are good reasons for some of these idiosyncrasies (e.g. expeditious blanket impls), but they still steepen ndarray's learning curve. Ways to address this would include:

  • Adding hints about into_par_iter() and enumerate() to the documentation for ArrayBase::axis_iter().
    Or adding corresponding convenience methods ArrayBase::indexed_axis_iter().
  • Implementing IntoParallelIterator for IndexedIter.
    Assuming it can be more efficient than Zip::indexed().
  • Implementing IntoIterator for Zip.

What are the maintainers' views on these ideas? I would be happy to contribute pull requests with some guidance.

Lingua principale
Rust
Stelle
4.3k
Fork
391
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di rust-ndarray/ndarray

Tutte le issue di rust-ndarray/ndarray

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.