Skip to content

Commit c1365ff

Browse files
committed
document interface
1 parent a5d1b8a commit c1365ff

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

src/stdlib_linalg.fypp

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,25 @@ module stdlib_linalg
226226

227227
! Solve linear system system Ax=b.
228228
interface solve
229+
!! version: experimental
230+
!!
231+
!! Solves the linear system \( A \cdot x = b \) for the unknown vector \( x \) from a square matrix \( A \).
232+
!! ([Specification](../page/specs/stdlib_linalg.html#solve-solves-a-linear-matrix-equation-or-a-linear-system-of-scalar-equations))
233+
!!
234+
!!### Summary
235+
!! Interface for solving a linear system arising from a general matrix.
236+
!!
237+
!!### Description
238+
!!
239+
!! This interface provides methods for computing the solution of a linear matrix system.
240+
!! Supported data types include `real` and `complex`. No assumption is made on the matrix
241+
!! structure.
242+
!! The function can solve simultaneously either one (from a 1-d right-hand-side vector `b(:)`)
243+
!! or several (from a 2-d right-hand-side vector `b(:,:)`) systems.
244+
!!
245+
!!@note The solution is based on LAPACK's generic LU decomposition based solvers `*GESV`.
246+
!!@note BLAS/LAPACK backends do not currently support extended precision (``xdp``).
247+
!!
229248
#:for nd,ndsuf,nde in ALL_RHS
230249
#:for rk,rt,ri in RC_KINDS_TYPES
231250
#:if rk!="xdp"

0 commit comments

Comments
 (0)