added warning for iterating while mutating a sparse matrix (#415)

JuliaSparse · Jul 21, 2023 · b3872c8 · b3872c8
1 parent f8f0f40
commit b3872c8
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/sparsematrix.jl b/src/sparsematrix.jl
@@ -294,6 +294,9 @@ column. In conjunction with [`nonzeros`](@ref) and
           # perform sparse wizardry...
        end
     end
+
+!!! warning
+    Adding or removing nonzero elements to the matrix may invalidate the `nzrange`, one should not mutate the matrix while iterating.
 """
 nzrange(S::AbstractSparseMatrixCSC, col::Integer) = getcolptr(S)[col]:(getcolptr(S)[col+1]-1)
 nzrange(S::SparseMatrixCSCView, col::Integer) = nzrange(S.parent, S.indices[2][col])