pydims.flatten

pydims.flatten(array, /, *, dims=None, dim=None)

Flatten a set of dimensions into a single dimension.

Parameters:

• array (TypeVar(DimArr, bound= DimensionedArray)) – Array to flatten.

• dims (tuple[Hashable, ...] | None, default: None) – Dimensions to flatten.

• dim (Hashable | None, default: None) – Name of the new dimension.

Returns:

TypeVar(DimArr, bound= DimensionedArray) – Flattened array.