add nicer show methods (#13)

Author: KristofferC

src/AMGX.jl

@@ -120,6 +120,15 @@ function warn_not_destroyed_on_finalize(x::AMGXObject)
     !(x.handle == C_NULL) && @async @warn("AMGX: likely memory leak: a `$(typeof(x))` was finalized without having been `close`d")
 end
 
+function Base.show(io::IO, ::MIME"text/plain", object::AMGXObject)
+    ptr_str = object.handle == C_NULL ? "uninitialized" : "@" * sprint(show, UInt(object.handle))
+    print(io, typeof(object), " ", ptr_str)
+    object.handle == C_NULL && return
+    if hasfield(typeof(object), :mode)
+        print(io, " ", object.mode)
+    end
+end
+
 
 ############
 # Includes #

src/Matrix.jl

@@ -11,6 +11,20 @@ Base.@kwdef mutable struct AMGXMatrix <: AMGXObject
         return m
     end
 end
+function Base.show(io::IO, mime::MIME"text/plain", m::AMGXMatrix)
+    invoke(show, Tuple{IO, MIME"text/plain", AMGXObject}, io, mime, m)
+    m.handle == C_NULL && return
+    n, block_dims = matrix_get_size(m)
+    if n !== 0
+        nz = amgx_nnz(m)
+        if block_dims == (1, 1)
+            print(io, " of size $n×$n with $nz stored entries")
+        else
+            block_dim_x, block_dim_y = block_dims
+            print(io, " of size $n⋅$block_dim_x×$n⋅$block_dim_y with $nz stored block entries")
+        end
+    end
+end
 get_api_destroy_call(::Type{AMGXMatrix}) = API.AMGX_matrix_destroy
 function dec_refcount_parents(m::AMGXMatrix)
     dec_refcount!(m.resources)
@@ -82,18 +96,18 @@ function upload!(matrix::AMGXMatrix, cu_matrix::CUDA.CUSPARSE.CuSparseMatrixCSR)
     upload!(matrix, cu_matrix.rowPtr, cu_matrix.colVal, cu_matrix.nzVal)
 end
 
-function get_size(matrix::AMGXMatrix)
+function matrix_get_size(matrix::AMGXMatrix)
     n_ptr, block_dim_x_ptr, block_dim_y_ptr = Ref{Cint}(), Ref{Cint}(), Ref{Cint}()
     @checked API.AMGX_matrix_get_size(matrix.handle, n_ptr, block_dim_x_ptr, block_dim_y_ptr)
     return Int(n_ptr[]), (Int(block_dim_x_ptr[]), Int(block_dim_y_ptr[]))
 end
 function Base.size(matrix::AMGXMatrix)
-    n, block_dims = get_size(matrix)
+    n, block_dims = matrix_get_size(matrix)
     return n * block_dims[1], n * block_dims[2]
 end
 
 function replace_coefficients!(m::AMGXMatrix, data::VectorOrCuVector{T}, diag_data::Union{VectorOrCuVector{T}, Nothing}=nothing) where {T <: Union{Float64, Float32}}
-    n, block_dims = get_size(m)
+    n, block_dims = matrix_get_size(m)
     _amgx_nnz = amgx_nnz(m)
     if length(data) != _amgx_nnz * prod(block_dims)
         throw(ArgumentError("can not change the number of nnz entries in `replace_coefficients!`"))
@@ -125,6 +139,6 @@ function amgx_nnz(matrix)
 end
 
 function SparseArrays.nnz(matrix::AMGXMatrix)
-    _, block_dims = get_size(matrix)
+    _, block_dims = matrix_get_size(matrix)
     return amgx_nnz(matrix) * prod(block_dims)
 end

src/Solver.jl

@@ -2,10 +2,11 @@ Base.@kwdef mutable struct Solver <: AMGXObject
     handle::API.AMGX_solver_handle = API.AMGX_solver_handle(C_NULL)
     resources::Union{Resources, Nothing} = nothing
     config::Union{Config, Nothing} = nothing
+    mode::Union{Mode, Nothing} = nothing
     bound_matrix::Union{AMGXMatrix, Nothing} = nothing
-    function Solver(handle::API.AMGX_solver_handle, resources::Union{Resources, Nothing},
+    function Solver(handle::API.AMGX_solver_handle, resources::Union{Resources, Nothing}, mode::Union{Mode, Nothing},
                     config::Union{Config, Nothing}, bound_matrix::Union{AMGXMatrix, Nothing})
-        solver = new(handle, resources, config, bound_matrix)
+        solver = new(handle, resources, config, mode, bound_matrix)
         finalizer(warn_not_destroyed_on_finalize, solver)
         return solver
     end
@@ -16,6 +17,7 @@ function dec_refcount_parents(solver::Solver)
     solver.resources = nothing
     solver.config = nothing
     solver.bound_matrix = nothing
+    solver.mode = nothing
     nothing
 end
 get_api_destroy_call(::Type{Solver}) = API.AMGX_solver_destroy
@@ -27,6 +29,7 @@ function create!(solver::Solver, res::Resources, mode::Mode, config::Config)
     solver.handle = solver_handle_ptr[]
     solver.resources = res
     solver.config = config
+    solver.mode = mode
     inc_refcount!(solver.resources)
     inc_refcount!(solver.config)
     return solver

src/Vector.jl

@@ -9,6 +9,18 @@ Base.@kwdef mutable struct AMGXVector <: AMGXObject
         return v
     end
 end
+function Base.show(io::IO, mime::MIME"text/plain", v::AMGXVector)
+    invoke(show, Tuple{IO, MIME"text/plain", AMGXObject}, io, mime, v)
+    v.handle == C_NULL && return
+    n, block_dim = vector_get_size(v)
+    if n !== 0
+        if block_dim == 1
+            print(io, " of length $n")
+        else
+            print(io, " of length $n⋅$block_dim")
+        end
+    end
+end
 get_api_destroy_call(::Type{AMGXVector}) = API.AMGX_vector_destroy
 function dec_refcount_parents(v::AMGXVector)
     dec_refcount!(v.resources)

test/runtests.jl

@@ -1,5 +1,7 @@
 using AMGX
 
+repl_output(x) = sprint((io, x) -> show(io, MIME("text/plain"), x), x)
+
 # Hide annoying output from the library
 AMGX.register_print_callback(x -> nothing)
 

test/test_config.jl

@@ -1,13 +1,18 @@
 module TestConfig
 
+import ..repl_output
 using AMGX, Defer, Test
 using AMGX: Config, AMGXException
 
 @testset "Config" begin
     @scope @testset "Dict" begin
         cfg = @! Config()
+        @test occursin("uninitialized", repl_output(cfg))
         d = Dict("max_levels" => 10)
         AMGX.create!(cfg, d)
+        str = sprint((io, cfg) -> show(io, MIME("text/plain"), cfg), cfg)
+        @test !occursin("uninitialized", repl_output(cfg))
+        @test occursin("@", repl_output(cfg))
 
         d = Dict("max_lovels" => 10)
         @test_throws AMGXException("Incorrect amgx configuration provided.") Config(d)

test/test_matrix.jl

@@ -2,13 +2,15 @@ module TestMatrix
 
 # TODO: Test `diag_dat` argument to `upload!` and `replace_coefficients!`
 
+import ..repl_output
 using AMGX, Defer, Test, JSON, CUDA, SparseArrays
 using AMGX: Config, Resources, AMGXMatrix, dDDI, dFFI
 
 @scope @testset "Matrix" begin
     c = @! Config("")
     r = @! Resources(c)
     m = @! AMGXMatrix(r, dDDI)
+    @test occursin("dDDI", repl_output(m))
 
     @testset "upload" begin
         AMGX.upload!(m, 
@@ -17,8 +19,9 @@ using AMGX: Config, Resources, AMGXMatrix, dDDI, dFFI
             [1.0, 2.0, 3.0]
         )
         @test nnz(m) == 3
-        @test AMGX.get_size(m) == (2, (1,1))
+        @test AMGX.matrix_get_size(m) == (2, (1,1))
         @test size(m) == (2, 2)
+        @test occursin("of size 2×2 with 3 stored entries", repl_output(m))
 
         @testset "replace coefficients" begin
             # TODO: Should test this does something
@@ -48,9 +51,11 @@ using AMGX: Config, Resources, AMGXMatrix, dDDI, dFFI
             blocks_flatten;
             block_dims = (2,2)
         )
-        @test AMGX.get_size(m) == (2, (2,2))
+        @test AMGX.matrix_get_size(m) == (2, (2,2))
         @test size(m) == (4, 4)
         @test nnz(m) == 12
+        @test occursin("of size 2⋅2×2⋅2 with 3 stored block entries", repl_output(m))
+
         @testset "replace coefficients" begin
             AMGX.replace_coefficients!(m, ones(Float64, length(blocks_flatten)))
             @test_throws ArgumentError AMGX.replace_coefficients!(m, ones(Float64, length(blocks_flatten)-1))

test/test_vector.jl

@@ -1,5 +1,6 @@
 module TestVector
 
+import ..repl_output
 using AMGX, Defer, Test, JSON, CUDA
 using AMGX: Config, Resources, AMGXVector, dDDI, dFFI
 
@@ -9,8 +10,10 @@ using AMGX: Config, Resources, AMGXVector, dDDI, dFFI
 
     @scope @testset "upload/download" begin
         v = @! AMGXVector(r, dDDI)
+        @test occursin("dDDI", repl_output(v))
         v_h = [1.0, 2.0, 3.0]
         AMGX.upload!(v, v_h)
+        @test occursin("of length 3", repl_output(v))
         @test length(v) == 3
         @test AMGX.download(v) == v_h
         @test Vector(v) == v_h
@@ -46,6 +49,7 @@ using AMGX: Config, Resources, AMGXVector, dDDI, dFFI
         v = @! AMGXVector(r, dDDI)
         v_h = [1.0, 2.0, 3.0, 4.0]
         AMGX.upload!(v, v_h; block_dim = 2)
+        @test occursin("of length 2⋅2", repl_output(v))
         @test length(v_h) == 4
         @test AMGX.vector_get_size(v) == (2, 2)
         v_h = [1.0, 2.0, 3.0]