Skip to content

Commit 40062c4

Browse files
committed
Merge branch 'matrix_inverse' of github.com:perazz/stdlib into matrix_inverse
2 parents d0af9be + 3c0bcdb commit 40062c4

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/specs/stdlib_linalg.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1001,7 +1001,7 @@ Experimental
10011001
This operator returns the inverse of a `real` or `complex` square matrix \( A \).
10021002
The inverse \( A^{-1} \) is defined such that \( A \cdot A^{-1} = A^{-1} \cdot A = I_n \).
10031003

1004-
This interface is equivalent to the function version of [[stdlib_linalg(module):inv(interface)]].
1004+
This interface is equivalent to the function [[stdlib_linalg(module):inv(interface)]].
10051005

10061006
### Syntax
10071007

@@ -1024,7 +1024,7 @@ If an exception occurred on input errors, or singular matrix, NaNs will be retur
10241024
{!example/linalg/example_inverse_operator.f90!}
10251025
```
10261026

1027-
## `invert` - Inversion of a square matrix.
1027+
## `invert` - Inversion of a square matrix
10281028

10291029
### Status
10301030

@@ -1051,13 +1051,13 @@ If `inva` is not provided, it is an `intent(inout)` argument: on output, it is r
10511051
`inva` (optional): Shall be a rank-2, square, `real` or `complex` array with the same size, and kind as `a`.
10521052
On output, it contains the inverse of `a`.
10531053

1054-
`pivot` (optional): Shall be a rank-1 array of the same kind and matrix dimension as `a`, providing storage for the diagonal pivot indices. It is an `intent(inout)` arguments, and returns the diagonal pivot indices.
1054+
`pivot` (optional): Shall be a rank-1 array of the same kind and matrix dimension as `a`, that contains the diagonal pivot indices on return. It is an `intent(inout)` argument.
10551055

10561056
`err` (optional): Shall be a `type(linalg_state_type)` value. This is an `intent(out)` argument.
10571057

10581058
### Return value
10591059

1060-
Replaces matrix \( A \) with its inverse, \(A^{-1}\).
1060+
Computes the inverse of the matrix \( A \), \(A^{-1}\, and returns it either in \( A \) or in another matrix.
10611061

10621062
Raises `LINALG_ERROR` if the matrix is singular or has invalid size.
10631063
Raises `LINALG_VALUE_ERROR` if `inva` and `a` do not have the same size.
@@ -1094,7 +1094,7 @@ The solver is based on LAPACK's `*GETRF` and `*GETRI` backends.
10941094

10951095
`a`: Shall be a rank-2, square, `real` or `complex` array containing the coefficient matrix. It is an `intent(inout)` argument.
10961096

1097-
`err` (optional): Shall be a `type(linalg_state_type)` value. This is an `intent(out)` argument.
1097+
`err` (optional): Shall be a `type(linalg_state_type)` value. It is an `intent(out)` argument.
10981098

10991099
### Return value
11001100

0 commit comments

Comments
 (0)