iterators are confusing

オープン
#1,043 コメント 1 件 リアクション 3 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
rust

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Rust
スター
4.3k
フォーク
391
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

rust-ndarray/ndarray のほかの issue

rust-ndarray/ndarray の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。