Pretty-print contents of PlainVector (#15)

* Add fancy `show` for `PlainVector`s

* Update README -> we are a registered package now

* Set version to v0.1.1

Author: sloede

Project.toml

@@ -1,7 +1,7 @@
 name = "SecureArithmetic"
 uuid = "38cee09b-6d7e-4d21-866e-807a7f642fe9"
 authors = ["Michael Schlottke-Lakemper <[email protected]>"]
-version = "0.1.0"
+version = "0.1.1"
 
 [deps]
 OpenFHE = "77ce9b8e-ecf5-45d1-bd8a-d31f384f2f95"

README.md

@@ -23,10 +23,10 @@ operating system](https://julialang.org/downloads/platform/).
 and later on Linux and macOS platforms, and with Julia v1.9 or later on Windows platforms.
 
 ### Installation
-Since SecureArithmetic.jl is not yet a registered Julia package, you can install it by
-executing the following commands in the Julia REPL:
+Since SecureArithmetic.jl  is a registered Julia package, you can install it by executing
+the following commands in the Julia REPL:
 ```julia
-julia> import Pkg; Pkg.add("https://github.com/sloede/SecureArithmetic.jl")
+julia> import Pkg; Pkg.add("SecureArithmetic")
 ```
 If you plan on running the examples in the
 [`examples`](https://github.com/sloede/SecureArithmetic.jl/tree/main/examples) directory,

src/openfhe.jl

@@ -53,6 +53,11 @@ function PlainVector(data::Vector{<:Real}, context::SecureContext{<:OpenFHEBacke
     plain_vector
 end
 
+function Base.show(io::IO, ::MIME"text/plain", v::PlainVector{<:OpenFHEBackend})
+    print(io, v.length, "-element PlainVector{OpenFHEBackend}:\n")
+    Base.print_matrix(io, OpenFHE.GetRealPackedValue(v.data))
+end
+
 function encrypt(data::Vector{<:Real}, public_key, context::SecureContext{<:OpenFHEBackend})
     plain_vector = PlainVector(data, context)
     secure_vector = encrypt(plain_vector, public_key)

src/types.jl

@@ -19,6 +19,7 @@ struct SecureVector{CryptoBackendT <: AbstractCryptoBackend, DataT}
 end
 
 Base.length(v::SecureVector) = v.length
+
 function Base.show(io::IO, v::SecureVector)
     print("SecureVector{", backend_name(v), "}(data=<encrypted>, length=$(v.length))")
 end
@@ -34,11 +35,10 @@ struct PlainVector{CryptoBackendT <: AbstractCryptoBackend, DataT}
 end
 
 Base.length(v::PlainVector) = v.length
-function Base.show(io::IO, v::PlainVector{CryptoBackendT}) where CryptoBackendT
-    print("PlainVector{", backend_name(v), "}(data=<plain>, length=$(v.length))")
-end
 
-Base.print(io::IO, plain_vector::PlainVector) = print(io, plain_vector.data)
+function Base.show(io::IO, v::PlainVector)
+    print(io, "PlainVector{", backend_name(v), "}(data=<encoded>, length=$(v.length))")
+end
 
 struct PrivateKey{CryptoBackendT <: AbstractCryptoBackend, KeyT}
     private_key::KeyT
@@ -49,7 +49,7 @@ struct PrivateKey{CryptoBackendT <: AbstractCryptoBackend, KeyT}
     end
 end
 
-function Base.show(io::IO, key::PrivateKey{CryptoBackendT}) where CryptoBackendT
+function Base.show(io::IO, key::PrivateKey)
     print("PrivateKey{", backend_name(key), "}()")
 end
 
@@ -62,7 +62,7 @@ struct PublicKey{CryptoBackendT <: AbstractCryptoBackend, KeyT}
     end
 end
 
-function Base.show(io::IO, key::PublicKey{CryptoBackendT}) where CryptoBackendT
+function Base.show(io::IO, key::PublicKey)
     print("PublicKey{", backend_name(key), "}()")
 end
 
@@ -72,6 +72,6 @@ end
 # Note: prefixed by `__` since it is really, really dirty black magic internals we use here!
 __parameterless_type(T) = Base.typename(T).wrapper
 
-# Convenience method for getting the human-readable backend name
+# Convenience method for getting human-readable names
 backend_name(x::Union{SecureContext{T}, SecureVector{T}, PlainVector{T}, PrivateKey{T},
                       PublicKey{T}}) where T = string(__parameterless_type(T))

src/unencrypted.jl

@@ -14,6 +14,11 @@ function PlainVector(data::Vector{<:Real}, context::SecureContext{<:Unencrypted}
     PlainVector(data, length(data), context)
 end
 
+function Base.show(io::IO, ::MIME"text/plain", v::PlainVector{<:Unencrypted})
+    print(io, v.length, "-element PlainVector{Unencrypted}:\n")
+    Base.print_matrix(io, v.data[1:v.length])
+end
+
 function encrypt(data::Vector{<:Real}, public_key::PublicKey,
                  context::SecureContext{<:Unencrypted})
     SecureVector(data, length(data), context)

test/test_unit.jl

@@ -90,19 +90,22 @@ for backend in ((; name = "OpenFHE", BackendT = OpenFHEBackend, context = contex
         end
 
         @testset verbose=true showtiming=true "show" begin
-            @test_nowarn show(context)
+            @test_nowarn show(stdout, context)
             println()
 
-            @test_nowarn show(pv1)
+            @test_nowarn show(stdout, pv1)
             println()
 
-            @test_nowarn show(sv1)
+            @test_nowarn show(stdout, MIME"text/plain"(), pv1)
             println()
 
-            @test_nowarn show(public_key)
+            @test_nowarn show(stdout, sv1)
             println()
 
-            @test_nowarn show(private_key)
+            @test_nowarn show(stdout, public_key)
+            println()
+
+            @test_nowarn show(stdout, private_key)
             println()
         end
     end