Skip to content

Commit 58010b0

Browse files
committed
: rename state argument to err in tridiagonal syntax
1 parent 81426d7 commit 58010b0

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

doc/specs/stdlib_specialmatrices.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,10 @@ Tridiagonal matrices are available with all supported data types as `tridiagonal
6868

6969
- To construct a tridiagonal matrix of size `n x n` with constant diagonal elements `dl`, `dv`, and `du`:
7070

71-
`A = ` [[stdlib_specialmatrices(module):tridiagonal(interface)]] `(dl, dv, du, n [, state])`
71+
`A = ` [[stdlib_specialmatrices(module):tridiagonal(interface)]] `(dl, dv, du, n [, err])`
72+
73+
Where `err` is an optional `intent(out)` argument of type `linalg_state_type`. When `state` is not present, the corresponding `tridiagonal` call is `pure` and signals invalid sizes or array shape mismatches via an internal `error stop`. When `state` is present, the impure overload is used instead, and any such error is reported by setting the `state` variable rather than executing an `error stop`.
7274

73-
Where `state` is an optional `intent(out)` argument of type `linalg_state_type`. When `state` is not present, the corresponding `tridiagonal` call is `pure` and signals invalid sizes or array shape mismatches via an internal `error stop`. When `state` is present, the impure overload is used instead, and any such error is reported by setting the `state` variable rather than executing an `error stop`.
7475

7576
#### Example
7677

0 commit comments

Comments
 (0)