Shapes

Shape is a term to describe the number and size of the dimensions of an N dimension (ND) array.

MLXArray is an N dimensional array. The number of dimensions is described by MLXArray/ndim and the size of each dimension can be examined with MLXArray/dim(_:)-(Int) or MLXArray/shape.

Some of these functions can manipulate the shape without changing the contents while others will moves rows and columns as they modify the shape.

Topics

Reading Shapes

• MLXArray/shape
• MLXArray/shape2
• MLXArray/shape3
• MLXArray/shape4
• MLXArray/dim(_:)

MLXArray Shape Methods (Same Size)

Some methods allow you to manipulate the shape of the array. These methods change the size and MLXArray/shape of the dimensions without changing the number of elements or contents of the array:

• MLXArray/expandedDimensions(axis:stream:)

• MLXArray/expandedDimensions(axes:stream:)

• MLXArray/flattened(start:end:stream:)

• MLXArray/reshaped(_:stream:)-(Collection<Int>,StreamOrDevice)

• MLXArray/reshaped(_:stream:)-(Int...,StreamOrDevice)

• MLXArray/squeezed(stream:)

• MLXArray/squeezed(axis:stream:)

• MLXArray/squeezed(axes:stream:)

• expandedDimensions(_:axis:stream:)

• expandedDimensions(_:axes:stream:)

• asStrided(_:_:strides:offset:stream:)

• atLeast1D(_:stream:)

• atLeast2D(_:stream:)

• atLeast3D(_:stream:)

• flattened(_:start:end:stream:)

• reshaped(_:_:stream:)-(MLXArray,Collection<Int>,StreamOrDevice)

• squeezed(_:axes:stream:)

• roll(_:shift:axis:stream:)

• roll(_:shift:axes:stream:)

MLXArray Shape Methods (Change Size)

These methods manipulate the shape and contents of the array:

• MLXArray/movedAxis(source:destination:stream:)
• MLXArray/split(parts:axis:stream:)
• MLXArray/split(indices:axis:stream:)
• MLXArray/split(axis:stream:)
• MLXArray/swappedAxes(_:_:stream:)
• MLXArray/transposed(stream:)
• MLXArray/transposed(axis:stream:)
• MLXArray/transposed(axes:stream:)
• MLXArray/transposed(_:stream:)
• MLXArray/T

Free Functions To Manipulate Shapes

• asStrided(_:_:strides:offset:stream:)
• broadcast(_:to:stream:)
• concatenated(_:axis:stream:)
• expandedDimensions(_:axes:stream:)
• movedAxis(_:source:destination:stream:)
• padded(_:width:mode:value:stream:)
• padded(_:widths:mode:value:stream:)
• split(_:indices:axis:stream:)
• split(_:parts:axis:stream:)
• split(_:axis:stream:)
• stacked(_:axis:stream:)
• swappedAxes(_:_:_:stream:)
• tiled(_:repetitions:stream:)-(MLXArray,Int,StreamOrDevice)
• tiled(_:repetitions:stream:)-(MLXArray,Collection<Int>,StreamOrDevice)
• transposed(_:axes:stream:)