Array

Contents

Array#

enum mlx_dtype_#

Array element type.

Values:

enumerator MLX_BOOL#
enumerator MLX_UINT8#
enumerator MLX_UINT16#
enumerator MLX_UINT32#
enumerator MLX_UINT64#
enumerator MLX_INT8#
enumerator MLX_INT16#
enumerator MLX_INT32#
enumerator MLX_INT64#
enumerator MLX_FLOAT16#
enumerator MLX_FLOAT32#
enumerator MLX_FLOAT64#
enumerator MLX_BFLOAT16#
enumerator MLX_COMPLEX64#
typedef struct mlx_array_ mlx_array#

A N-dimensional array object.

typedef enum mlx_dtype_ mlx_dtype#

Array element type.

static mlx_array mlx_array_empty#
size_t mlx_dtype_size(mlx_dtype dtype)#

Size of given mlx_dtype datatype in bytes.

int mlx_array_tostring(mlx_string *str, const mlx_array arr)#

Get array description.

mlx_array mlx_array_new()#

New empty array.

int mlx_array_free(mlx_array arr)#

Free an array.

mlx_array mlx_array_new_bool(bool val)#

New array from a bool scalar.

mlx_array mlx_array_new_int(int val)#

New array from a int scalar.

mlx_array mlx_array_new_float32(float val)#

New array from a float32 scalar.

mlx_array mlx_array_new_float(float val)#

New array from a float scalar.

Same as float32.

mlx_array mlx_array_new_float64(double val)#

New array from a float64 scalar.

mlx_array mlx_array_new_double(double val)#

New array from a double scalar.

Same as float64.

mlx_array mlx_array_new_complex(float real_val, float imag_val)#

New array from a complex scalar.

mlx_array mlx_array_new_data(const void *data, const int *shape, int dim, mlx_dtype dtype)#

New array from existing buffer.

Parameters:

  • data – A buffer which will be copied.

  • shape – Shape of the array.

  • dim – Number of dimensions (size of shape).

  • dtype – Type of array elements.

int mlx_array_set(mlx_array *arr, const mlx_array src)#

Set array to provided src array.

int mlx_array_set_bool(mlx_array *arr, bool val)#

Set array to a bool scalar.

int mlx_array_set_int(mlx_array *arr, int val)#

Set array to a int scalar.

int mlx_array_set_float32(mlx_array *arr, float val)#

Set array to a float32 scalar.

int mlx_array_set_float(mlx_array *arr, float val)#

Set array to a float scalar.

int mlx_array_set_float64(mlx_array *arr, double val)#

Set array to a float64 scalar.

int mlx_array_set_double(mlx_array *arr, double val)#

Set array to a double scalar.

int mlx_array_set_complex(mlx_array *arr, float real_val, float imag_val)#

Set array to a complex scalar.

int mlx_array_set_data(mlx_array *arr, const void *data, const int *shape, int dim, mlx_dtype dtype)#

Set array to specified data and shape.

Parameters:

  • arr – Destination array.

  • data – A buffer which will be copied.

  • shape – Shape of the array.

  • dim – Number of dimensions (size of shape).

  • dtype – Type of array elements.

size_t mlx_array_itemsize(const mlx_array arr)#

The size of the array’s datatype in bytes.

size_t mlx_array_size(const mlx_array arr)#

Number of elements in the array.

size_t mlx_array_nbytes(const mlx_array arr)#

The number of bytes in the array.

size_t mlx_array_ndim(const mlx_array arr)#

The array’s dimension.

const int *mlx_array_shape(const mlx_array arr)#

The shape of the array.

Returns: a pointer to the sizes of each dimension.

const size_t *mlx_array_strides(const mlx_array arr)#

The strides of the array.

Returns: a pointer to the sizes of each dimension.

int mlx_array_dim(const mlx_array arr, int dim)#

The shape of the array in a particular dimension.

mlx_dtype mlx_array_dtype(const mlx_array arr)#

The array element type.

int mlx_array_eval(mlx_array arr)#

Evaluate the array.

int mlx_array_item_bool(bool *res, const mlx_array arr)#

Access the value of a scalar array.

int mlx_array_item_uint8(uint8_t *res, const mlx_array arr)#

Access the value of a scalar array.

int mlx_array_item_uint16(uint16_t *res, const mlx_array arr)#

Access the value of a scalar array.

int mlx_array_item_uint32(uint32_t *res, const mlx_array arr)#

Access the value of a scalar array.

int mlx_array_item_uint64(uint64_t *res, const mlx_array arr)#

Access the value of a scalar array.

int mlx_array_item_int8(int8_t *res, const mlx_array arr)#

Access the value of a scalar array.

int mlx_array_item_int16(int16_t *res, const mlx_array arr)#

Access the value of a scalar array.

int mlx_array_item_int32(int32_t *res, const mlx_array arr)#

Access the value of a scalar array.

int mlx_array_item_int64(int64_t *res, const mlx_array arr)#

Access the value of a scalar array.

int mlx_array_item_float32(float *res, const mlx_array arr)#

Access the value of a scalar array.

int mlx_array_item_float64(double *res, const mlx_array arr)#

Access the value of a scalar array.

int mlx_array_item_complex64(float _Complex *res, const mlx_array arr)#

Access the value of a scalar array.

const bool *mlx_array_data_bool(const mlx_array arr)#

Returns a pointer to the array data, cast to bool*.

Array must be evaluated, otherwise returns NULL.

const uint8_t *mlx_array_data_uint8(const mlx_array arr)#

Returns a pointer to the array data, cast to uint8_t*.

Array must be evaluated, otherwise returns NULL.

const uint16_t *mlx_array_data_uint16(const mlx_array arr)#

Returns a pointer to the array data, cast to uint16_t*.

Array must be evaluated, otherwise returns NULL.

const uint32_t *mlx_array_data_uint32(const mlx_array arr)#

Returns a pointer to the array data, cast to uint32_t*.

Array must be evaluated, otherwise returns NULL.

const uint64_t *mlx_array_data_uint64(const mlx_array arr)#

Returns a pointer to the array data, cast to uint64_t*.

Array must be evaluated, otherwise returns NULL.

const int8_t *mlx_array_data_int8(const mlx_array arr)#

Returns a pointer to the array data, cast to int8_t*.

Array must be evaluated, otherwise returns NULL.

const int16_t *mlx_array_data_int16(const mlx_array arr)#

Returns a pointer to the array data, cast to int16_t*.

Array must be evaluated, otherwise returns NULL.

const int32_t *mlx_array_data_int32(const mlx_array arr)#

Returns a pointer to the array data, cast to int32_t*.

Array must be evaluated, otherwise returns NULL.

const int64_t *mlx_array_data_int64(const mlx_array arr)#

Returns a pointer to the array data, cast to int64_t*.

Array must be evaluated, otherwise returns NULL.

const float *mlx_array_data_float32(const mlx_array arr)#

Returns a pointer to the array data, cast to float32*.

Array must be evaluated, otherwise returns NULL.

const double *mlx_array_data_float64(const mlx_array arr)#

Returns a pointer to the array data, cast to float64*.

Array must be evaluated, otherwise returns NULL.

const float _Complex *mlx_array_data_complex64(const mlx_array arr)#

Returns a pointer to the array data, cast to _Complex*.

Array must be evaluated, otherwise returns NULL.

int _mlx_array_is_available(bool *res, const mlx_array arr)#

Check if the array is available.

Internal function: use at your own risk.

int _mlx_array_wait(const mlx_array arr)#

Wait on the array to be available.

After this _mlx_array_is_available returns true. Internal function: use at your own risk.

int _mlx_array_is_contiguous(bool *res, const mlx_array arr)#

Whether the array is contiguous in memory.

Internal function: use at your own risk.

int _mlx_array_is_row_contiguous(bool *res, const mlx_array arr)#

Whether the array’s rows are contiguous in memory.

Internal function: use at your own risk.

int _mlx_array_is_col_contiguous(bool *res, const mlx_array arr)#

Whether the array’s columns are contiguous in memory.

Internal function: use at your own risk.

struct mlx_array_#
#include <array.h>

A N-dimensional array object.

Contents