ak.from_regular — Awkward Array documentation

# ak.from_regular

Defined in awkward.operations.structure on line 813.

ak.from_regular(array, axis=1, highlevel=True, behavior=None)
  Parameters:

    - array – Array to convert.

    - 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.

    - highlevel (bool) – If True, return an `ak.Array`; otherwise, return a low-level `ak.layout.Content` subclass.

    - behavior (None or dict) – Custom `ak.behavior` for the output array, if high-level.

Converts a regular axis into an irregular one.

    >>> regular = ak.Array(np.arange(2*3*5).reshape(2, 3, 5))
    >>> ak.type(regular)
    2 * 3 * 5 * int64
    >>> ak.type(ak.from_regular(regular))
    2 * var * 5 * int64
    >>> ak.type(ak.from_regular(regular, axis=2))
    2 * 3 * var * int64
    >>> ak.type(ak.from_regular(regular, axis=-1))
    2 * 3 * var * int64

See also `ak.to_regular`.