Clarify the table entries for combinatorics.

This commit is contained in:
Raymond Hettinger 2009-04-10 04:27:37 +00:00
parent bf1537cd3c
commit 175cb23bb9
1 changed files with 13 additions and 8 deletions

View File

@ -61,14 +61,19 @@ operator can be mapped across two vectors to form an efficient dot-product:
**Combinatoric generators:**
===================================== ==================== =================================================
Iterator Arguments Results
===================================== ==================== =================================================
:func:`product` p, q, ... [repeat=1] cartesian product
:func:`permutations` p[, r] r-length permutations (without repeated elements)
:func:`combinations` p[, r] r-length combinations (sorted and no repeats)
:func:`combinations_with_replacement` p[, r] r-length combinations (sorted but with repeats)
===================================== ==================== =================================================
============================================== ==================== =============================================================
Iterator Arguments Results
============================================== ==================== =============================================================
:func:`product` p, q, ... [repeat=1] cartesian product, equivalent to a nested for-loop
:func:`permutations` p[, r] r-length tuples, all possible orderings, no repeated elements
:func:`combinations` p[, r] r-length tuples, in sorted order, no repeated elements
:func:`combinations_with_replacement` p[, r] r-length tuples, in sorted order, with repeated elements
|
``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``
============================================== ==================== =============================================================
.. _itertools-functions: