Skip to content

Commit

Permalink
Update BandedLU.jl (#449)
Browse files Browse the repository at this point in the history
banded lu! docstring
  • Loading branch information
lxvm authored Aug 6, 2024
1 parent a2649ce commit c31e007
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/banded/BandedLU.jl
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,17 @@ Matrix(F::BandedLU) = Array(AbstractArray(F))
Array(F::BandedLU) = Matrix(F)

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

0 comments on commit c31e007

Please sign in to comment.