ak.argcombinations — Awkward Array 2.8.2 documentation (original) (raw)

Defined in awkward.operations.ak_argcombinations on line 18.

ak.argcombinations(array, n, *, replacement=False, axis=1, fields=None, parameters=None, with_name=None, highlevel=True, behavior=None, attrs=None)#

Parameters:

• array – Array-like data (anything ak.to_layout recognizes).
• n (int) – The number of items to choose from each list: 2 chooses unique pairs, 3 chooses unique triples, etc.
• replacement (bool) – If True, combinations that include the same item more than once are allowed; otherwise each item in a combinations is strictly unique.
• axis (int) – The dimension at which this operation is applied. The outermost dimension is 0, followed by 1, etc., and negative values count backward from the innermost: -1 is the innermost dimension, -2 is the next level up, etc.
• fields (None or list of str) – If None, the pairs/triples/etc. are tuples with unnamed fields; otherwise, these fields name the fields. The number of fields must be equal to n.
• parameters (None or dict) – Parameters for the newak.contents.RecordArray node that is created by this operation.
• with_name (None or str) – Assigns a "__record__" name to the newak.contents.RecordArray node that is created by this operation (overriding parameters, if necessary).
• highlevel (bool) – If True, return an ak.Array; otherwise, return a low-level ak.contents.Content subclass.
• behavior (None or dict) – Custom ak.behavior for the output array, if high-level.
• attrs (None or dict) – Custom attributes for the output array, if high-level.

Computes a Cartesian product (i.e. cross product) of array with itself that is restricted to combinations sampled without replacement, like ak.combinations, but returning integer indexes forak.Array.__getitem__.

The motivation and uses of this function are similar to those ofak.argcartesian. See ak.combinations and ak.argcartesian for a more complete description.