Skip to content

Commit 449d0a2

Browse files
committed
add pivot
1 parent e75bb2f commit 449d0a2

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

doc/specs/stdlib_linalg.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -668,9 +668,13 @@ The solver is based on LAPACK's `*GESV` backends.
668668

669669
### Syntax
670670

671-
`Pure` interface:
671+
Simple (`Pure`) interface:
672+
673+
`x = ` [[stdlib_linalg(module):solve_lu(interface)]] `(a, b, x)`
672674

673-
`x = ` [[stdlib_linalg(module):solve_lu(interface)]] `(a, b, x, pivot [, overwrite_a, err])`
675+
Expert (`Pure`) interface:
676+
677+
`x = ` [[stdlib_linalg(module):solve_lu(interface)]] `(a, b, x [, pivot, overwrite_a, err])`
674678

675679
### Arguments
676680

@@ -682,6 +686,8 @@ Two
682686

683687
`x`: Shall be a rank-1 or rank-2 array of the same kind and size as `b`, that returns the solution(s) to the system. It is an `intent(inout)` argument, and must have the `contiguous` property.
684688

689+
`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.
690+
685691
`overwrite_a` (optional): Shall be an input logical flag. if `.true.`, input matrix `a` will be used as temporary storage and overwritten. This avoids internal data allocation. This is an `intent(in)` argument.
686692

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

0 commit comments

Comments
 (0)