itertools —効率的なループのためのイテレータを作成する関数—Pythonドキュメント
itertools —効率的なループのためのイテレータを作成する関数
このモジュールは、APL、Haskell、およびSMLの構成に触発された多数の iterator ビルディングブロックを実装します。 それぞれがPythonに適した形式に再キャストされています。
このモジュールは、単独で、または組み合わせて使用できる、高速でメモリ効率の高いツールのコアセットを標準化します。 これらが一緒になって「イテレータ代数」を形成し、純粋なPythonで特殊なツールを簡潔かつ効率的に構築できるようにします。
たとえば、SMLは、シーケンスf(0), f(1), ...
を生成する集計ツールtabulate(f)
を提供します。 map()と count()を組み合わせてmap(f, count())
を形成することにより、Pythonでも同じ効果を得ることができます。
これらのツールとそれに組み込まれているツールは、 operator モジュールの高速機能でもうまく機能します。 たとえば、乗算演算子を2つのベクトルにマッピングして、効率的な内積sum(map(operator.mul, vector1, vector2))
を形成できます。
無限イテレータ:
イテレータ | 引数 | 結果 | 例 |
---|---|---|---|
count()
|
スタート、[ステップ] | start、start + step、start + 2 * step、… | count(10) --> 10 11 12 13 14 ...
|
cycle()
|
p | p0、p1、…プラスト、p0、p1、… | cycle('ABCD') --> A B C D A B C D ...
|
repeat()
|
elem [、n] | elem、elem、elem、…無限にまたは最大n回 | repeat(10, 3) --> 10 10 10
|
最短の入力シーケンスで終了するイテレータ:
イテレータ | 引数 | 結果 | 例 |
---|---|---|---|
accumulate()
|
p [、func] | p0、p0 + p1、p0 + p1 + p2、… | accumulate([1,2,3,4,5]) --> 1 3 6 10 15
|
chain()
|
p、q、… | p0、p1、…プラスト、q0、q1、… | chain('ABC', 'DEF') --> A B C D E F
|
chain.from_iterable()
|
反復可能 | p0、p1、…プラスト、q0、q1、… | chain.from_iterable(['ABC', 'DEF']) --> A B C D E F
|
compress()
|
データ、セレクター | (s [0]の場合はd [0])、(s [1]の場合はd [1])、… | compress('ABCDEF', [1,0,1,0,1,1]) --> A C E F
|
dropwhile()
|
pred、seq | seq [n]、seq [n + 1]、predが失敗したときに開始 | dropwhile(lambda x: x<5, [1,4,6,4,1]) --> 6 4 1
|
filterfalse()
|
pred、seq | pred(elem)がfalseであるseqの要素 | filterfalse(lambda x: x%2, range(10)) --> 0 2 4 6 8
|
groupby()
|
iterable [、key] | key(v)の値でグループ化されたサブイテレータ | |
islice()
|
seq、[start、] stop [、step] | seq [start:stop:step]の要素 | islice('ABCDEFG', 2, None) --> C D E F G
|
starmap()
|
func、seq | func(* seq [0])、func(* seq [1])、… | starmap(pow, [(2,5), (3,2), (10,3)]) --> 32 9 1000
|
takewhile()
|
pred、seq | seq [0]、seq [1]、predが失敗するまで | takewhile(lambda x: x<5, [1,4,6,4,1]) --> 1 4
|
tee()
|
それ、n | it1、it2、…itnは1つのイテレータをnに分割します | |
zip_longest()
|
p、q、… | (p [0]、q [0])、(p [1]、q [1])、… | zip_longest('ABCD', 'xy', fillvalue='-') --> Ax By C- D-
|
組み合わせイテレータ:
イテレータ | 引数 | 結果 |
---|---|---|
product()
|
p、q、…[繰り返し= 1] | ネストされたforループに相当するデカルト積 |
permutations()
|
p [、r] | r-長さのタプル、すべての可能な順序、繰り返される要素なし |
combinations()
|
p、r | r-長さのタプル、ソートされた順序で、繰り返される要素なし |
combinations_with_replacement()
|
p、r | rの長さのタプル、ソートされた順序で、要素が繰り返されている |
product('ABCD', repeat=2)
|
AA AB AC AD BA BB BC BD CA CB CC CD DA DB DC DD
| |
permutations('ABCD', 2)
|
AB AC AD BA BC BD CA CB CD DA DB DC
| |
combinations('ABCD', 2)
|
AB AC AD BC BD CD
| |
combinations_with_replacement('ABCD', 2)
|
AA AB AC AD BB BC BD CC CD DD
|
Itertool関数
次のモジュール関数は、すべてのイテレータを作成して返します。 無限の長さのストリームを提供するものもあるため、ストリームを切り捨てる関数またはループからのみアクセスする必要があります。
- itertools.accumulate(iterable[, func])
累積合計、または他のバイナリ関数の累積結果(オプションの func 引数で指定)を返すイテレーターを作成します。 func が指定されている場合、それは2つの引数の関数である必要があります。 入力 iterable の要素は、 func への引数として受け入れることができる任意のタイプにすることができます。 (たとえば、デフォルトの加算操作では、要素は Decimal または Fraction を含む任意の加算可能タイプになります。)入力反復可能オブジェクトが空の場合、出力反復可能変数も空になります。
ほぼ同等:
func 引数にはいくつかの用途があります。 実行中の最小値の場合は min()、実行中の最大値の場合は max()、実行中の製品の場合は operator.mul()に設定できます。 償却表は、利息を累積して支払いを適用することで作成できます。 一次漸化式は、反復可能で初期値を指定し、 func 引数の累積合計のみを使用することでモデル化できます。
最終的な累積値のみを返す同様の関数については、 functools.reduce()を参照してください。
バージョン3.2の新機能。
バージョン3.3で変更:オプションの func パラメーターが追加されました。
- itertools.chain(*iterables)
最初のイテレータから要素がなくなるまで要素を返し、次にすべてのイテレータがなくなるまで次のイテレータに進むイテレータを作成します。 連続するシーケンスを単一のシーケンスとして扱うために使用されます。 ほぼ同等:
- classmethod chain.from_iterable(iterable)
chain()の代替コンストラクター。 遅延評価される単一の反復可能な引数から連鎖入力を取得します。 ほぼ同等:
- itertools.combinations(iterable, r)
入力 iterable から要素の r 長さのサブシーケンスを返します。
組み合わせは、辞書式順序で発行されます。 したがって、入力 iterable がソートされている場合、組み合わせタプルはソートされた順序で生成されます。
要素は、値ではなく、位置に基づいて一意として扱われます。 したがって、入力要素が一意である場合、各組み合わせに繰り返し値はありません。
ほぼ同等:
combinations()のコードは、要素が並べ替えられていないエントリをフィルタリングした後、 permutations()のサブシーケンスとして表すこともできます(入力プール内の位置に従って) :
返されるアイテムの数は、
0 <= r <= n
の場合はn! / r! / (n-r)!
、r > n
の場合はゼロです。
- itertools.combinations_with_replacement(iterable, r)
入力 iterable から要素の r 長さのサブシーケンスを返し、個々の要素を複数回繰り返すことができます。
組み合わせは、辞書式順序で発行されます。 したがって、入力 iterable がソートされている場合、組み合わせタプルはソートされた順序で生成されます。
要素は、値ではなく、位置に基づいて一意として扱われます。 したがって、入力要素が一意である場合、生成される組み合わせも一意になります。
ほぼ同等:
combinations_with_replacement()のコードは、要素が並べ替えられた順序ではないエントリをフィルタリングした後、 product()のサブシーケンスとして表すこともできます(入力プール内の位置に従って) :
n > 0
の場合、返されるアイテムの数は(n+r-1)! / r! / (n-1)!
です。バージョン3.1の新機能。
- itertools.compress(data, selectors)
データの要素をフィルタリングして、セレクターに
True
と評価される対応する要素を持つ要素のみを返すイテレーターを作成します。 データまたはセレクターイテラブルのいずれかが使い果たされると停止します。 ほぼ同等:バージョン3.1の新機能。
- itertools.count(start=0, step=1)
数値 start で始まる等間隔の値を返すイテレーターを作成します。 多くの場合、 map()の引数として使用され、連続するデータポイントを生成します。 また、 zip()とともに使用して、シーケンス番号を追加します。 ほぼ同等:
浮動小数点数でカウントする場合、
(start + step * i for i in count())
のような乗法コードに置き換えることで、より高い精度が得られる場合があります。バージョン3.1で変更: step 引数を追加し、非整数引数を許可しました。
- itertools.cycle(iterable)
イテレータから要素を返し、それぞれのコピーを保存するイテレータを作成します。 iterableが使い果たされたら、保存されたコピーから要素を返します。 無期限に繰り返します。 ほぼ同等:
ツールキットのこのメンバーは、(反復可能オブジェクトの長さに応じて)かなりの補助記憶装置を必要とする場合があることに注意してください。
- itertools.dropwhile(predicate, iterable)
述語が真である限り、イテレータから要素を削除するイテレータを作成します。 その後、すべての要素を返します。 イテレータは、述語が最初にfalseになるまで any 出力を生成しないため、起動時間が長くなる可能性があることに注意してください。 ほぼ同等:
- itertools.filterfalse(predicate, iterable)
述語が
False
である要素のみを返す、反復可能から要素をフィルター処理するイテレーターを作成します。 述語がNone
の場合、falseの項目を返します。 ほぼ同等:
- itertools.groupby(iterable, key=None)
iterable から連続するキーとグループを返すイテレーターを作成します。 key は、各要素のキー値を計算する関数です。 指定されていない場合、または
None
の場合、 key はデフォルトで恒等関数になり、要素を変更せずに返します。 一般に、イテラブルは同じキー関数ですでにソートされている必要があります。groupby()の操作は、Unixの
uniq
フィルターに似ています。 キー関数の値が変更されるたびに、ブレークまたは新しいグループが生成されます(そのため、通常、同じキー関数を使用してデータを並べ替える必要があります)。 この動作は、入力順序に関係なく共通の要素を集約するSQLのGROUPBYとは異なります。返されるグループ自体は、基になるイテレータを groupby()と共有するイテレータです。 ソースが共有されているため、 groupby()オブジェクトを進めると、前のグループは表示されなくなります。 したがって、そのデータが後で必要になった場合は、リストとして保存する必要があります。
groupby()は、おおよそ次のものと同等です。
- itertools.islice(iterable, stop)
itertools.islice(iterable, start, stop[, step]) イテレータから選択した要素を返すイテレータを作成します。 start がゼロ以外の場合、iterableの要素はstartに到達するまでスキップされます。 その後、 step が1より高く設定されてアイテムがスキップされない限り、要素は連続して返されます。 stop が
None
の場合、イテレータが使い果たされるまで反復が続行されます。 それ以外の場合は、指定された位置で停止します。 通常のスライスとは異なり、 islice()は、 start 、 stop 、または step の負の値をサポートしていません。 内部構造がフラット化されているデータから関連フィールドを抽出するために使用できます(たとえば、複数行のレポートでは、3行ごとに名前フィールドがリストされる場合があります)。 ほぼ同等:start が
None
の場合、反復はゼロから始まります。 step がNone
の場合、ステップはデフォルトで1になります。
- itertools.permutations(iterable, r=None)
iterable 内の要素の連続する r 長さの順列を返します。
r が指定されていないか、
None
の場合、 r はデフォルトで iterable の長さになり、可能なすべてのフルレングスの順列が生成されます。 。順列は辞書式順序で発行されます。 したがって、入力 iterable がソートされている場合、順列タプルはソートされた順序で生成されます。
要素は、値ではなく、位置に基づいて一意として扱われます。 したがって、入力要素が一意である場合、各順列に繰り返し値はありません。
ほぼ同等:
順列()のコードは、 product()のサブシーケンスとして表現することもでき、繰り返し要素を持つエントリ(入力プールの同じ位置からのエントリ)を除外するようにフィルタリングされます。
返されるアイテムの数は、
0 <= r <= n
の場合はn! / (n-r)!
、r > n
の場合はゼロです。
- itertools.product(*iterables, repeat=1)
入力反復可能のデカルト積。
ジェネレータ式のネストされたforループとほぼ同等です。 たとえば、
product(A, B)
は((x,y) for x in A for y in B)
と同じ値を返します。ネストされたループは走行距離計のように循環し、右端の要素が反復ごとに進みます。 このパターンは辞書式順序を作成するため、入力の反復可能オブジェクトがソートされている場合、製品タプルはソートされた順序で発行されます。
iterableとそれ自体の積を計算するには、オプションの repeat キーワード引数を使用して繰り返し回数を指定します。 たとえば、
product(A, repeat=4)
はproduct(A, A, A, A)
と同じ意味です。この関数は、実際の実装がメモリに中間結果を構築しないことを除いて、次のコードとほぼ同等です。
- itertools.repeat(object[, times])
オブジェクトを何度も返すイテレータを作成します。 times 引数が指定されていない限り、無期限に実行されます。 呼び出された関数への不変パラメーターの map()への引数として使用されます。 zip()とともに使用して、タプルレコードの不変部分を作成します。
ほぼ同等:
repeat の一般的な使用法は、定数値のストリームを map または zip に提供することです。
- itertools.starmap(function, iterable)
iterableから取得した引数を使用して関数を計算するイテレータを作成します。 map()の代わりに、引数パラメーターが単一の反復可能オブジェクトからのタプルにすでにグループ化されている場合に使用されます(データは「事前に圧縮」されています)。 map()と starmap()の違いは、
function(a,b)
とfunction(*c)
の違いと同じです。 ほぼ同等:
- itertools.takewhile(predicate, iterable)
述語が真である限り、イテレータから要素を返すイテレータを作成します。 ほぼ同等:
- itertools.tee(iterable, n=2)
単一のイテレータから n の独立したイテレータを返します。
次のPythonコードは、 tee の機能を説明するのに役立ちます(ただし、実際の実装はより複雑で、基になる FIFO キューを1つだけ使用します)。
ほぼ同等:
tee()が分割されたら、元の iterable を他の場所で使用しないでください。 そうしないと、 iterable は、ティーオブジェクトに通知されずに進む可能性があります。
tee
イテレータはスレッドセーフではありません。 元の iterable がスレッドセーフであっても、同じ tee()呼び出しによって返されるイテレータを同時に使用すると、 RuntimeError が発生する場合があります。このitertoolは、(保存する必要のある一時データの量に応じて)かなりの補助記憶装置を必要とする場合があります。 一般に、あるイテレータが別のイテレータが開始する前にほとんどまたはすべてのデータを使用する場合は、 tee()の代わりに list()を使用する方が高速です。
- itertools.zip_longest(*iterables, fillvalue=None)
各イテレータから要素を集約するイテレータを作成します。 イテラブルの長さが不均一な場合、欠落している値は fillvalue で埋められます。 反復は、最長の反復がなくなるまで続きます。 ほぼ同等:
反復可能オブジェクトの1つが潜在的に無限である場合、 zip_longest()関数は、呼び出しの数を制限するものでラップする必要があります(たとえば、 islice()または takewhile( ))。 指定しない場合、 fillvalue のデフォルトは
None
です。
Itertoolsレシピ
このセクションでは、既存のitertoolsをビルディングブロックとして使用して拡張ツールセットを作成するためのレシピを示します。
拡張ツールは、基盤となるツールセットと同じ高性能を提供します。 反復可能オブジェクト全体を一度にメモリに取り込むのではなく、要素を1つずつ処理することで、優れたメモリパフォーマンスが維持されます。 ツールを機能的なスタイルでリンクすることにより、コードの量を少なく抑え、一時変数を排除します。 インタープリターのオーバーヘッドが発生するforループやジェネレーターの使用よりも「ベクトル化された」ビルディングブロックを優先することで、高速性が維持されます。
上記のレシピの多くは、グローバルルックアップをデフォルト値として定義されたローカル変数に置き換えることで最適化できることに注意してください。 たとえば、 dotproduct レシピは次のように記述できます。