Matrix and vector norms for mlx arrays — mlx_norm • Rmlx

Matrix and vector norms for mlx arrays

Usage

mlx_norm(x, ord = NULL, axes = NULL, drop = TRUE)

Arguments

x: An mlx array.
ord: Numeric or character norm order. Use NULL for the default 2-norm.
axes: Integer vector of axes (1-indexed). Supply positive integers between 1 and the array rank. Many helpers interpret NULL to mean "all axes"—see the function details for specifics.
drop: If TRUE (default), drop dimensions of length 1. If FALSE, retain all dimensions. Equivalent to keepdims = TRUE in underlying mlx functions.

Value

An mlx array containing the requested norm.

See also

mlx.linalg.norm

Examples

x <- mlx_matrix(1:4, 2, 2)
mlx_norm(x)
#> mlx array []
#>   dtype: float32
#>   device: gpu
#>   values:
#> [1] 5.477226
mlx_norm(x, ord = 2)
#> mlx array []
#>   dtype: float32
#>   device: gpu
#>   values:
#> [1] 5.464986
mlx_norm(x, axes = 2)
#> mlx array [2]
#>   dtype: float32
#>   device: gpu
#>   values:
#> [1] 3.162278 4.472136