Skip to content

Commit 237ed63

Browse files
committed
Add docstring
1 parent 72355a7 commit 237ed63

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

src/special.jl

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,26 @@ _diag_or_value(A::Diagonal) = A.diag
320320
_diag_or_value(A::UniformScaling) = A.λ
321321

322322
# fill[stored]! methods
323+
"""
324+
fillstored!(A::AbstractMatrix, x)
325+
326+
Fill only the stored indices of a structured matrix `A` with the value `x`.
327+
328+
# Example
329+
```jldoctest
330+
julia> A = Tridiagonal(zeros(2), zeros(3), zeros(2))
331+
3×3 Tridiagonal{Float64, Vector{Float64}}:
332+
0.0 0.0 ⋅
333+
0.0 0.0 0.0
334+
⋅ 0.0 0.0
335+
336+
julia> LinearAlgebra.fillstored!(A, 2)
337+
3×3 Tridiagonal{Float64, Vector{Float64}}:
338+
2.0 2.0 ⋅
339+
2.0 2.0 2.0
340+
⋅ 2.0 2.0
341+
```
342+
"""
323343
fillstored!(A::Diagonal, x) = (fill!(A.diag, x); A)
324344
fillstored!(A::Bidiagonal, x) = (fill!(A.dv, x); fill!(A.ev, x); A)
325345
fillstored!(A::Tridiagonal, x) = (fill!(A.dl, x); fill!(A.d, x); fill!(A.du, x); A)

0 commit comments

Comments
 (0)