diff --git a/spec/API_specification/linear_algebra_functions.md b/spec/API_specification/linear_algebra_functions.md index 209a2f787..d22e4fd85 100644 --- a/spec/API_specification/linear_algebra_functions.md +++ b/spec/API_specification/linear_algebra_functions.md @@ -15,10 +15,28 @@ A conforming implementation of the array API standard must provide and support t -(function-cholesky)= -### cholesky() +(function-linalg-cholesky)= +### linalg.cholesky(x, /, *, upper=False) -TODO +Returns the Cholesky decomposition of a symmetric positive-definite matrix (or a stack of symmetric positive-definite matrices) `x`. + + + +#### Parameters + +- **x**: _<array>_ + + - input array having shape `(..., M, M)` and whose innermost two dimensions form square matrices. Should have a floating-point data type. + +- **upper**: _bool_ + + - If `True`, the result must be the upper-triangular Cholesky factor. If `False`, the result must be the lower-triangular Cholesky factor. Default: `False`. + +#### Returns + +- **out**: _<array>_ + + - an array containing the Cholesky factors for each square matrix. The returned array must have a floating-point data type determined by {ref}`type-promotion` and shape as `x`. (function-cross)= ### cross(x1, x2, /, *, axis=-1)