Skip to content

Commit 507ac7a

Browse files
committed
Add usage in the README
1 parent 9203285 commit 507ac7a

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,22 @@ factorization algorithms.
1313
- Sivan Toledo's recursive left-looking LU algorithm. DOI:
1414
[10.1137/S0895479896297744](https://epubs.siam.org/doi/10.1137/S0895479896297744)
1515

16+
#### Usage:
17+
18+
`RecursiveFactorization` does not export any functions.
19+
20+
```julia
21+
julia> using RecursiveFactorization
22+
23+
julia> A = rand(5, 5);
24+
25+
julia> RecursiveFactorization.lu(A); # out-of-place
26+
27+
julia> RecursiveFactorization.lu!(copy(A)); # in-place
28+
29+
julia> RecursiveFactorization.lu!(copy(A), Vector{Int}(undef, size(A, 2))); # in-place w/ pivoting vector
30+
```
31+
1632
#### Performance:
1733

1834
For small to medium sized matrices, it is beneficial to use

0 commit comments

Comments
 (0)