Skip to content

Commit c31e007

Browse files
authored
Update BandedLU.jl (#449)
banded lu! docstring
1 parent a2649ce commit c31e007

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/banded/BandedLU.jl

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,17 @@ Matrix(F::BandedLU) = Array(AbstractArray(F))
7979
Array(F::BandedLU) = Matrix(F)
8080

8181
##
82+
"""
83+
lu!(A::BandedMatrix, pivot = Val(true); check = true)
84+
85+
Compute the LU factorization of a banded matrix `A` inplace, overwriting the matrix.
86+
This factorization requires `A` to have extra storage, and in particular if the banded
87+
matrix of interest has bandwidths `(l, u)` then `A` should have bandwidths `(l, l+u)`
88+
and contain the desired matrix along with zeros in the additional entries.
89+
90+
When `check = true`, an error is thrown if the factorization fails. When `check = false`
91+
it is the user's responsibility for checking the validity of the factorization.
92+
"""
8293
function lu!(A::BandedMatrix{T}, pivot::Union{Val{false}, Val{true}} = Val(true);
8394
check::Bool = true) where T<:BlasFloat
8495
if pivot === Val(false)

0 commit comments

Comments
 (0)