fix related issues, add tests

Author: rokke-git

docs/src/index.md

@@ -113,8 +113,11 @@ julia> I = [1, 4, 3, 5]; J = [4, 7, 18, 9]; V = [1, 2, -5, 3];
 
 julia> S = sparse(I,J,V)
 5×18 SparseMatrixCSC{Int64, Int64} with 4 stored entries:
-⎡⠀⠈⠀⠀⠀⠀⠀⠀⢀⎤
-⎣⠀⠀⠀⠂⡀⠀⠀⠀⠀⎦
+ ⋅  ⋅  ⋅  1  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅   ⋅
+ ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅   ⋅
+ ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  -5
+ ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  2  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅   ⋅
+ ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  3  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅  ⋅   ⋅
 
 julia> R = sparsevec(I,V)
 5-element SparseVector{Int64, Int64} with 4 stored entries:

src/linalg.jl

@@ -2094,19 +2094,19 @@ julia> A[4:4:8] .= 1;
 
 julia> A
 3×3 SparseMatrixCSC{Float64, Int64} with 2 stored entries:
-  ⋅   1.0   ⋅
-  ⋅    ⋅   1.0
-  ⋅    ⋅    ⋅
+ ⋅  1.0   ⋅
+ ⋅   ⋅   1.0
+ ⋅   ⋅    ⋅
 
 julia> C = spzeros(3,3);
 
 julia> C[2:4:6] .= 2;
 
 julia> C
 3×3 SparseMatrixCSC{Float64, Int64} with 2 stored entries:
-  ⋅    ⋅    ⋅
- 2.0   ⋅    ⋅
-  ⋅   2.0   ⋅
+  ⋅    ⋅   ⋅
+ 2.0   ⋅   ⋅
+  ⋅   2.0  ⋅
 
 julia> SparseArrays.mergeinds!(C, A)
 3×3 SparseMatrixCSC{Float64, Int64} with 4 stored entries:

src/solvers/spqr.jl

@@ -192,8 +192,8 @@ Q factor:
 4×4 SparseArrays.SPQR.QRSparseQ{Float64, Int64}
 R factor:
 2×2 SparseMatrixCSC{Float64, Int64} with 2 stored entries:
- -1.41421    ⋅
-   ⋅       -1.41421
+ -1.41421      ⋅
+     ⋅     -1.41421
 Row permutation:
 4-element Vector{Int64}:
  1
@@ -471,10 +471,10 @@ when the problem is underdetermined.
 ```jldoctest
 julia> A = sparse([1,2,4], [1,1,1], [1.0,1.0,1.0], 4, 2)
 4×2 SparseMatrixCSC{Float64, Int64} with 3 stored entries:
- 1.0   ⋅
- 1.0   ⋅
-  ⋅    ⋅
- 1.0   ⋅
+ 1.0  ⋅
+ 1.0  ⋅
+  ⋅   ⋅
+ 1.0  ⋅
 
 julia> qr(A)\\fill(1.0, 4)
 2-element Vector{Float64}:

src/sparsematrix.jl

@@ -352,7 +352,6 @@ function Base.show(io::IO, ::MIME"text/plain", S::AbstractSparseMatrixCSCInclAdj
 
     screen = displaysize(io)
     get(io, :limit, false) && screen[1] <= 4 && return print(io, ": …")
-    println(io, ":")
 
     show_circular(io, S) && return
     io = IOContext(io, :compact=>true, :typeinfo=>eltype(S), :SHOWN_SET=>S)
@@ -433,7 +432,7 @@ function _show_with_braille_patterns(io::IO, S::AbstractSparseMatrixCSCInclAdjoi
     # `scaleHeight` and `scaleWidth` accordingly. Note that each available
     # character can contain up to 4 braille dots in its height (⡇) and up to
     # 2 braille dots in its width (⠉).
-    if get(io, :limit, true) && (m > 4maxHeight || n > 2maxWidth)
+    if get(io, :limit, false) && (m > 4maxHeight || n > 2maxWidth)
         s = min(2maxWidth / n, 4maxHeight / m)
         scaleHeight = floor(Int, s * m)
         scaleWidth = floor(Int, s * n)
@@ -521,6 +520,8 @@ function _show_with_dotted_zeros(io::IO, S::AbstractSparseMatrixCSCInclAdjointAn
     colwidths = [max.((0, 0), align[findall(==(col), cols)]...) for col in axes(S,2)]
     displaysize(io)[2] < sum(sum.(colwidths) .+ 2) && return _show_with_braille_patterns(io, S)
 
+    println(io, ":")
+
     try
         zero(eltype(S))
     catch
@@ -535,12 +536,26 @@ function _show_with_dotted_zeros(io::IO, S::AbstractSparseMatrixCSCInclAdjointAn
             if isempty(index) # no value here, print an aligned dot
                 l, r = cld(l+r-1, 2) + 1, div(l+r-1, 2) + 1
                 print(io, " "^l * "⋅" * (col==axes(S,2)[end] ? "" : " "^r))
-            else
+            else try # print the element with 1 space of buffer on each side
                 l, r = (l+1, r+1) .- align[index[]]
                 print(io, " "^l)
                 isassigned(vals, index[]) ? show(io, vals[index[]]) : print(io, "#undef")
                 col == axes(S,2)[end] || print(io, " "^r)
-            end
+            catch # if there's 2+ entries, index[] errors. default to summing
+                  # entries, but print red to warn user that something's wrong
+                elm = any(!isassigned(vals, ind) for ind in index) ? "#undef" :
+                    try repr(sum(vals[index]); context=:compact=>true) catch e "#NaN" end
+
+                if length(elm) <= l+r # give up on alignment, center item in the column
+                    l, r = cld(l+r-length(elm), 2) + 1, div(l+r-length(elm), 2) + 1
+                else # len of new item does not fit in column
+                    elm = "▒"^(l+r)
+                    l, r = 1, 1
+                end
+
+                printstyled(io, " "^l, elm, color=:red)
+                col == axes(S,2)[end] || print(io, " "^r)
+            end end
         end
         row == axes(S,1)[end] || println(io)
     end
@@ -688,7 +703,7 @@ function _sparse_copyto!(dest::AbstractMatrix, src::AbstractSparseMatrixCSC)
     @inbounds for col in axes(src, 2), ptr in nzrange(src, col)
         row = rowvals(src)[ptr]
         val = nonzeros(src)[ptr]
-        dest[isrc[row, col]] = val
+        dest[isrc[row, col]] += val
     end
     return dest
 end
@@ -712,7 +727,7 @@ function copyto!(dest::AbstractMatrix, Rdest::CartesianIndices{2},
         if row in rows
             val = nonzeros(src′)[ptr]
             I = Rdest[lin[row, col]]
-            dest[I] = val
+            dest[I] += val
         end
     end
     return dest
@@ -737,7 +752,7 @@ function Base.copyto!(A::Array{T}, S::SparseMatrixCSC{<:Number}) where {T<:Numbe
         for i in nzrange(S, col)
             row = rowval[i]
             val = nzval[i]
-            A[linear_index_col0+row] = val
+            A[linear_index_col0+row] += val
         end
         linear_index_col0 += num_rows
     end
@@ -1962,9 +1977,9 @@ julia> A = sparse([1, 2, 3], [1, 2, 3], [1.0, 0.0, 1.0])
 
 julia> dropzeros(A)
 3×3 SparseMatrixCSC{Float64, Int64} with 2 stored entries:
- 1.0   ⋅    ⋅
-  ⋅    ⋅    ⋅
-  ⋅    ⋅   1.0
+ 1.0  ⋅   ⋅
+  ⋅   ⋅   ⋅
+  ⋅   ⋅  1.0
 ```
 """
 dropzeros(A::AbstractSparseMatrixCSC) = dropzeros!(copy(A))
@@ -2134,7 +2149,7 @@ argument specifies a random number generator, see [Random Numbers](@ref).
 ```jldoctest; setup = :(using Random; Random.seed!(0))
 julia> sprandn(2, 2, 0.75)
 2×2 SparseMatrixCSC{Float64, Int64} with 3 stored entries:
- -1.20577     ⋅
+ -1.20577       ⋅
   0.311817  -0.234641
 ```
 """
@@ -2161,9 +2176,9 @@ specified.
 ```jldoctest
 julia> spzeros(3, 3)
 3×3 SparseMatrixCSC{Float64, Int64} with 0 stored entries:
-  ⋅    ⋅    ⋅
-  ⋅    ⋅    ⋅
-  ⋅    ⋅    ⋅
+ ⋅  ⋅  ⋅
+ ⋅  ⋅  ⋅
+ ⋅  ⋅  ⋅
 
 julia> spzeros(Float32, 4)
 4-element SparseVector{Float32, Int64} with 0 stored entries

test/issues.jl

@@ -758,14 +758,14 @@ let
     B = similar(A, T12960)
     @test repr(B) == "sparse([1, 2, 3], [1, 2, 3], $T12960[#undef, #undef, #undef], 3, 3)"
     @test occursin(
-        "\n #undef             ⋅            ⋅    \n       ⋅      #undef             ⋅    \n       ⋅            ⋅      #undef",
+        " #undef     ⋅       ⋅\n    ⋅    #undef     ⋅\n    ⋅       ⋅    #undef",
         repr(MIME("text/plain"), B),
     )
 
     B[1,2] = T12960()
     @test repr(B)  == "sparse([1, 1, 2, 3], [1, 2, 2, 3], $T12960[#undef, $T12960(), #undef, #undef], 3, 3)"
     @test occursin(
-        "\n #undef          T12960()        ⋅    \n       ⋅      #undef             ⋅    \n       ⋅            ⋅      #undef",
+        "\n #undef     T12960()     ⋅\n    ⋅    #undef          ⋅\n    ⋅         ⋅       #undef",
         repr(MIME("text/plain"), B),
     )
 end
@@ -805,13 +805,37 @@ end
                        7 16 4])
 end
 
+@testset "Issue #512" begin # suppresses but does not fix the error mentioned
+    x = sparse([1, 1, 3], [1, 4, 3], [20, 0, [2]])
+    @test_warn "WARNING: could not find generic zero" repr(MIME("text/plain"), x)
+    x = sparse([1, 100, 3], [1, 4, 300], [20, 0, [2]])
+    @test_warn "WARNING: could not find generic zero" repr(MIME("text/plain"), x)
+
+    @test_broken repr(MIME("text/plain"), transpose(x'))
+end
+
 @testset "Issue #574" begin
     a = spzeros(Float32, Int16, 2, 3)
     v = spzeros(Float32, Int16, 2)
     @test eltype(rowvals(zero(a))) <: Int16
     @test eltype(rowvals(zero(v))) <: Int16
 end
 
+@testset "Issue #618" begin
+    x = SparseMatrixCSC(3, 3, [1, 3, 4, 5], [1, 1, 2, 3], [1.0, 1.0, 1.0, 1.0])
+    @test contains(repr(MIME"text/plain"(), x), "2.0")
+    x = SparseMatrixCSC(3, 3, [1, 3, 4, 5], [1, 1, 2, 3], [7.0, 7.0, 1.0, 1.0])
+    @test contains(repr(MIME"text/plain"(), x), "▒▒▒")
+    x = SparseMatrixCSC(3, 3, [1, 3, 4, 5], [1, 1, 2, 3], [7.0, 'o', 1.0, 1.0])
+    @test contains(repr(MIME"text/plain"(), x), "#NaN")
+    v = similar(Any[1, 2, 3, 4]); v[2:4] = [1.0, 1.0, 1.0]
+    x = SparseMatrixCSC(3, 3, [1, 3, 4, 5], [1, 1, 2, 3], v)
+    @test contains(repr(MIME"text/plain"(), x), "#undef")
+
+    x = SparseMatrixCSC(3, 3, [1, 3, 4, 5], [1, 1, 2, 3], [1, 1, 1, 1])
+    @test 2 == Matrix(x)[1,1]
+end
+
 end # SparseTestsBase
 
 end # module

test/sparsematrix_constructors_indexing.jl

@@ -1514,9 +1514,9 @@ end
     A = spzeros(Float32, Int64, 2, 2)
     for (transform, showstring) in zip(
         (identity, adjoint, transpose), (
-        "2×2 $SparseMatrixCSC{Float32, Int64} with 0 stored entries:\n  ⋅    ⋅ \n  ⋅    ⋅ ",
-        "2×2 $Adjoint{Float32, $SparseMatrixCSC{Float32, Int64}} with 0 stored entries:\n  ⋅    ⋅ \n  ⋅    ⋅ ",
-        "2×2 $Transpose{Float32, $SparseMatrixCSC{Float32, Int64}} with 0 stored entries:\n  ⋅    ⋅ \n  ⋅    ⋅ ",
+        "2×2 $SparseMatrixCSC{Float32, Int64} with 0 stored entries:\n ⋅  ⋅\n ⋅  ⋅",
+        "2×2 $Adjoint{Float32, $SparseMatrixCSC{Float32, Int64}} with 0 stored entries:\n ⋅  ⋅\n ⋅  ⋅",
+        "2×2 $Transpose{Float32, $SparseMatrixCSC{Float32, Int64}} with 0 stored entries:\n ⋅  ⋅\n ⋅  ⋅",
         ))
         show(io, MIME"text/plain"(), transform(A))
         @test String(take!(io)) == showstring
@@ -1538,7 +1538,7 @@ end
         show(io, MIME"text/plain"(), transform(A))
         @test String(take!(io)) == showstring
         _show_with_braille_patterns(convert(IOContext, io), transform(A))
-        @test String(take!(io)) == braille
+        @test contains(String(take!(io)), braille)
     end
 
     # every 1-dot braille pattern
@@ -1559,7 +1559,7 @@ end
     for transform in (identity, adjoint, transpose)
         expected = "⎡" * Char(10240)^2 * "⎤\n⎣" * Char(10240)^2 * "⎦"
         _show_with_braille_patterns(convert(IOContext, io), transform(A))
-        @test String(take!(io)) == expected
+        @test contains(String(take!(io)), expected)
     end
 
     A = sparse(Int64[1, 2, 4, 2, 3], Int64[1, 1, 1, 2, 2], Int64[1, 1, 1, 1, 1], 4, 2)
@@ -1578,7 +1578,7 @@ end
         show(io, MIME"text/plain"(), transform(A))
         @test String(take!(io)) == showstring
         _show_with_braille_patterns(convert(IOContext, io), transform(A))
-        @test String(take!(io)) == braille
+        @test contains(String(take!(io)), braille)
     end
 
     A = sparse(Int64[1, 3, 2, 4], Int64[1, 1, 2, 2], Int64[1, 1, 1, 1], 7, 3)
@@ -1597,7 +1597,7 @@ end
         show(io, MIME"text/plain"(), transform(A))
         @test String(take!(io)) == showstring
         _show_with_braille_patterns(convert(IOContext, io), transform(A))
-        @test String(take!(io)) == braille
+        @test contains(String(take!(io)), braille)
     end
 
     A = sparse(Int64[1:10;], Int64[1:10;], fill(Float64(1), 10))
@@ -1606,7 +1606,7 @@ end
                     "⎣⠀⠀⠀⠀⠑⎦"
     for transform in (identity, adjoint, transpose)
         _show_with_braille_patterns(convert(IOContext, io), transform(A))
-        @test String(take!(io)) == brailleString
+        @test contains(String(take!(io)), brailleString)
     end
 
     # Issue #30589
@@ -1622,22 +1622,22 @@ end
     # vertical scaling
     ioc = IOContext(io, :displaysize => (5, 80), :limit => true)
     _show_with_braille_patterns(ioc, _filled_sparse(10, 10))
-    @test String(take!(io)) == "⎡⣿⣿⎤\n" *
-                               "⎣⣿⣿⎦"
+    @test contains(String(take!(io)), "⎡⣿⣿⎤\n" *
+                                      "⎣⣿⣿⎦")
 
     _show_with_braille_patterns(ioc, _filled_sparse(20, 10))
-    @test String(take!(io)) == "⎡⣿⣿⎤\n" *
-                               "⎣⣿⣿⎦"
+    @test contains(String(take!(io)), "⎡⣿⣿⎤\n" *
+                                      "⎣⣿⣿⎦")
 
     # horizontal scaling
     ioc = IOContext(io, :displaysize => (80, 4), :limit => true)
     _show_with_braille_patterns(ioc, _filled_sparse(8, 8))
-    @test String(take!(io)) == "⎡⣿⣿⎤\n" *
-                               "⎣⣿⣿⎦"
+    @test contains(String(take!(io)), "⎡⣿⣿⎤\n" *
+                                      "⎣⣿⣿⎦")
 
     _show_with_braille_patterns(ioc, _filled_sparse(8, 16))
-    @test String(take!(io)) == "⎡⣿⣿⎤\n" *
-                               "⎣⣿⣿⎦"
+    @test contains(String(take!(io)), "⎡⣿⣿⎤\n" *
+                                      "⎣⣿⣿⎦")
 
     # respect IOContext while displaying J
     I, J, V = shuffle(1:50), shuffle(1:50), [1:50;]