Merge pull request #13 from QuantumBFS/formatting

Better handling of optional arguments

Project.toml

@@ -4,8 +4,10 @@ authors = ["Arsh Sharma <[email protected]> and contributors"]
 version = "0.1.0"
 
 [deps]
+Configurations = "5218b696-f38b-4ac9-8b61-a12ec717816d"
 IBMQClient = "02860bad-daa6-4506-8736-4a3616c18085"
-Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
+Yao = "5872b779-8223-5990-8dd0-5abbb0748c8c"
 YaoBlocks = "418bc28f-b43b-5e0b-a6e7-61bbc1a2c1df"
 
 [compat]
@@ -15,7 +17,6 @@ julia = "1.6"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
-Yao = "5872b779-8223-5990-8dd0-5abbb0748c8c"
 
 [targets]
-test = ["Test", "Yao"]
+test = ["Test"]

docs/make.jl

@@ -4,21 +4,16 @@ indigo = DocThemeIndigo.install(YaoBlocksQobj)
 
 
 makedocs(;
-    modules=[YaoBlocksQobj],
-    authors="Arsh Sharma <[email protected]> and contributors",
-    repo="https://github.com/QuantumBFS/YaoBlocksQobj.jl/blob/{commit}{path}#{line}",
-    sitename="YaoBlocksQobj.jl",
-    format=Documenter.HTML(;
-        prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://QuantumBFS.github.io/YaoBlocksQobj.jl",
-        assets=String[indigo, "assets/default.css"],
+    modules = [YaoBlocksQobj],
+    authors = "Arsh Sharma <[email protected]> and contributors",
+    repo = "https://github.com/QuantumBFS/YaoBlocksQobj.jl/blob/{commit}{path}#{line}",
+    sitename = "YaoBlocksQobj.jl",
+    format = Documenter.HTML(;
+        prettyurls = get(ENV, "CI", "false") == "true",
+        canonical = "https://QuantumBFS.github.io/YaoBlocksQobj.jl",
+        assets = String[indigo, "assets/default.css"],
     ),
-    pages=[
-        "Quickstart" => "index.md",
-        "API References" => "refs.md",
-    ],
+    pages = ["Quickstart" => "index.md", "API References" => "refs.md"],
 )
 
-deploydocs(;
-    repo="github.com/QuantumBFS/YaoBlocksQobj.jl",devbranch = "main",
-)
+deploydocs(; repo = "github.com/QuantumBFS/YaoBlocksQobj.jl", devbranch = "main")

src/YaoBlocksQobj.jl

@@ -1,10 +1,12 @@
 module YaoBlocksQobj
 
-export create_qobj
+export convert_to_qobj, convert_to_qbir
 
+using Configurations
 using IBMQClient.Schema
 using YaoBlocks
 
 include("qobj.jl")
+include("qbir.jl")
 
 end

src/qbir.jl

@@ -0,0 +1,152 @@
+using Yao
+
+mutable struct U1{T<:Number} <: PrimitiveBlock{1}
+    lambda::T
+end
+
+# 2-parameter 1-pulse single qubit gate
+mutable struct U2{T<:Number} <: PrimitiveBlock{1}
+    phi::T
+    lambda::T
+end
+
+# 3-parameter 2-pulse single qubit gate
+mutable struct U3{T<:Number} <: PrimitiveBlock{1}
+    theta::T
+    phi::T
+    lambda::T
+end
+
+Base.:(==)(u1_1::U1, u1_2::U1) = u1_1.lambda == u1_2.lambda
+Base.:(==)(u2_1::U2, u2_2::U2) = u2_1.phi == u2_2.phi && u2_1.lambda == u2_2.lambda
+Base.:(==)(u3_1::U3, u3_2::U3) =
+    u3_1.theta == u3_2.theta && u3_1.phi == u3_2.phi && u3_1.lambda == u3_2.lambda
+
+function Yao.mat(::Type{T}, u1::U1) where {T}
+    λ = u1.lambda
+
+    T[
+        1 0
+        0 exp(im * λ)
+    ]
+end
+
+function Yao.mat(::Type{T}, u2::U2) where {T}
+    ϕ, λ = u2.phi, u2.lambda
+
+    T[
+        1/√2 (-exp(im * λ))/√2
+        (exp(im * ϕ))/√2 (exp(im * (ϕ + λ)))/√2
+    ]
+end
+
+function Yao.mat(::Type{T}, u3::U3) where {T}
+    θ, ϕ, λ = u3.theta, u3.phi, u3.lambda
+
+    T[
+        cos(θ / 2) -sin(θ / 2)*exp(im * λ)
+        sin(θ / 2)*exp(im * ϕ) cos(θ / 2)*exp(im * (ϕ + λ))
+    ]
+end
+
+Yao.iparams_eltype(::U1{T}) where {T} = T
+Yao.iparams_eltype(::U2{T}) where {T} = T
+Yao.iparams_eltype(::U3{T}) where {T} = T
+
+Yao.getiparams(u1::U1{T}) where {T} = (u1.lambda)
+Yao.getiparams(u2::U2{T}) where {T} = (u2.phi, u2.lambda)
+Yao.getiparams(u3::U3{T}) where {T} = (u3.theta, u3.phi, u3.lambda)
+
+function Yao.setiparams!(u1::U1{T}, λ) where {T}
+    u1.lambda = λ
+    return u1
+end
+
+function Yao.setiparams!(u2::U2{T}, ϕ, λ) where {T}
+    u2.phi = ϕ
+    u2.lambda = λ
+    return u2
+end
+
+function Yao.setiparams!(u3::U3{T}, θ, ϕ, λ) where {T}
+    u3.theta = θ
+    u3.phi = ϕ
+    u3.lambda = λ
+    return u3
+end
+
+YaoBlocks.@dumpload_fallback U1 U1
+YaoBlocks.@dumpload_fallback U2 U2
+YaoBlocks.@dumpload_fallback U3 U3
+
+"""
+    convert_to_qbir(inst)
+
+Converts Qobj based instructions back to YaoIR.
+    
+- `inst`: The Qobj based instructions.
+
+For Example:
+```julia
+q = convert_to_qobj(chain(1, put(1 => H))) 
+ir = q.experiments[1].instructions |> convert_to_qbir
+```
+"""
+function convert_to_qbir(inst)
+    n = maximum(x -> maximum(x.qubits), inst) + 1
+    chain(
+        n,
+        map(inst) do x
+            name, locs = x.name, x.qubits .+ 1
+            nc = 0
+            while name[nc+1] == 'c' && nc < length(name)
+                nc += 1
+            end
+            if nc > 0
+                control(
+                    n,
+                    locs[1:nc],
+                    locs[nc+1:end] => name_index(name[nc+1:end], x.params),
+                )
+            elseif name == "measure"
+                put(n, locs => Yao.Measure(locs...))
+            else
+                put(n, locs => name_index(name, x.params))
+            end
+        end,
+    )
+end
+
+function name_index(name, params = nothing)
+    if name == "u1"
+        U1(params...)
+    elseif name == "u2"
+        if isapprox(params, [0, π])
+            H
+        else
+            U2(params...)
+        end
+    elseif name == "u3"
+        if isapprox(params[2], -π / 2) && isapprox(params[3], π / 2)
+            Rx(params[1])
+        elseif params[2] == 0 && params[3] == 0
+            Ry(params[1])
+        else
+            U3(params...)
+        end
+    elseif name == "id"
+        I2
+    elseif name == "x"
+        X
+    elseif name == "y"
+        Y
+    elseif name == "z"
+        Z
+    elseif name == "t"
+        T
+    elseif name == "swap"
+        SWAP
+    else
+        error("gate type `$name` not defined!")
+    end
+end