Skip to content

Commit

Permalink
Add a docstring to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Wimmerer committed Nov 26, 2021
1 parent deea631 commit fe3ef3c
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ julia> x = factor \ b
10.688731342850245
```
<!---[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://USER_NAME.github.io/PACKAGE_NAME.jl/stable) --->
<!---[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://USER_NAME.github.io/PACKAGE_NAME.jl/dev)--->

[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://wimmerer.github.io/KLU.jl/dev/)


4 changes: 4 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# KLU.jl

Documentation for KLU.jl

```@docs
klu
```
8 changes: 4 additions & 4 deletions src/KLU.jl
Original file line number Diff line number Diff line change
Expand Up @@ -483,8 +483,8 @@ klu_factor!
Compute the LU factorization of a sparse matrix `A` using KLU.
For sparse `A` with real or complex element type, the return type of `K` is
`KLUFactorization{Tv, Ti}`, with `Tv` = [`Float64`](@ref) or [`ComplexF64`](@ref)
respectively and `Ti` is an integer type ([`Int32`](@ref) or [`Int64`](@ref)).
`KLUFactorization{Tv, Ti}`, with `Tv` = `Float64` or `ComplexF64`
respectively and `Ti` is an integer type (`Int32` or `Int64`).
The individual components of the factorization `K` can be accessed by indexing:
Expand All @@ -500,11 +500,11 @@ The individual components of the factorization `K` can be accessed by indexing:
The relation between `K` and `A` is
`K.L * K.U + K.F == K.Rs [`\\`]`(@ref) A[K.p, K.q]`
`K.L * K.U + K.F == K.Rs `\\` A[K.p, K.q]`
`K` further supports the following functions:
- [`\\`](@ref)
- `LinearAlgebra.\\`
!!! note
`klu(A::SparseMatrixCSC)` uses the KLU library that is part of
Expand Down

0 comments on commit fe3ef3c

Please sign in to comment.