improve safe_real

QuantumBFS · May 13, 2024 · e13af47 · e13af47
1 parent 49c0342
commit e13af47
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 9 deletions.
diff --git a/lib/YaoBlocks/src/utils.jl b/lib/YaoBlocks/src/utils.jl
@@ -313,10 +313,9 @@ SparseArrays.sparse(et::EntryTable) = SparseVector(et)
 Base.vec(et::EntryTable) = Vector(et)
 
 # convert a (maybe complex) number x to real number.
-function safe_real(x)
+function safe_real(x::Complex{T}) where T
     img = imag(x)
-    if !(iszero(img) || isapprox(x - im*img, x; atol=1e-15))
-        error("Can not convert number $x to real due to its large imaginary part.")
-    end
+    @assert iszero(img) || (hasmethod(eps, Tuple{Type{T}}) && isapprox(x - im*img, x; rtol=eps(T), atol=eps(T))) "Fail to convert number $x to real due to the nonzero imaginary part: $img."
     return real(x)
-end
+end
+safe_real(x) = x
diff --git a/lib/YaoBlocks/test/blocktools.jl b/lib/YaoBlocks/test/blocktools.jl
@@ -96,8 +96,4 @@ end
     @test qc |> gatecount |> values |> sum == 6
     res = gatecount(repeat(5, X, (2, 3)))
     @test res |> values |> sum == 2
-end
-
-@testset "#issue 508" begin
-    @test YaoBlocks.safe_real(0 + 1e-323im) ≈ 0
 end
diff --git a/lib/YaoBlocks/test/utils.jl b/lib/YaoBlocks/test/utils.jl
@@ -45,4 +45,13 @@ end
     @test isclean(cet)
     @test cet[bit"000"] == 1.0+0im
     @test cet[bit"111"] == 0.0im
+end
+
+@testset "#issue 508" begin
+    @test YaoBlocks.safe_real(0 + 1e-323im) ≈ 0
+    @test YaoBlocks.safe_real(0+0im) ≈ 0
+    @test_throws AssertionError YaoBlocks.safe_real(0+1e-15im)
+    @test YaoBlocks.safe_real(0+1e-17im) == 0
+    @test YaoBlocks.safe_real(1e10+1e-10im) == 1e10
+    @test_throws AssertionError YaoBlocks.safe_real(0+1im)
 end