You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/specs/stdlib_linalg.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1001,7 +1001,7 @@ Experimental
1001
1001
This operator returns the inverse of a `real` or `complex` square matrix \( A \).
1002
1002
The inverse \( A^{-1} \) is defined such that \( A \cdot A^{-1} = A^{-1} \cdot A = I_n \).
1003
1003
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)]].
1005
1005
1006
1006
### Syntax
1007
1007
@@ -1024,7 +1024,7 @@ If an exception occurred on input errors, or singular matrix, NaNs will be retur
1024
1024
{!example/linalg/example_inverse_operator.f90!}
1025
1025
```
1026
1026
1027
-
## `invert` - Inversion of a square matrix.
1027
+
## `invert` - Inversion of a square matrix
1028
1028
1029
1029
### Status
1030
1030
@@ -1051,13 +1051,13 @@ If `inva` is not provided, it is an `intent(inout)` argument: on output, it is r
1051
1051
`inva` (optional): Shall be a rank-2, square, `real` or `complex` array with the same size, and kind as `a`.
1052
1052
On output, it contains the inverse of `a`.
1053
1053
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.
1055
1055
1056
1056
`err` (optional): Shall be a `type(linalg_state_type)` value. This is an `intent(out)` argument.
1057
1057
1058
1058
### Return value
1059
1059
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.
1061
1061
1062
1062
Raises `LINALG_ERROR` if the matrix is singular or has invalid size.
1063
1063
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.
1094
1094
1095
1095
`a`: Shall be a rank-2, square, `real` or `complex` array containing the coefficient matrix. It is an `intent(inout)` argument.
1096
1096
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.
0 commit comments