Merge pull request #13 from sotashimozono/feature

Feature

Author: sotashimozono

Project.toml

@@ -1,6 +1,6 @@
 name = "GroverAlgorithm"
 uuid = "480f6047-bde0-43c5-a5a8-f20cfea8349f"
-version = "0.2.1"
+version = "0.2.2"
 authors = ["sota <[email protected]>"]
 
 [deps]

docs/make.jl

@@ -34,7 +34,8 @@ makedocs(;
     modules=[GroverAlgorithm],
     pages=[
         "Home" => "index.md",
-        #"Getting Started" => "getting_started.md",
+        "Getting Started" => "example/getting_started.md",
+        "example" => ["toffoli" => "example/toffoli.md"],
         #"Core Concepts" => [
         #    "Quantum Gates and Circuits" => "structures.md",
         #    "Initial States" => "initialstates.md",

docs/src/assets/custom.css

@@ -6,7 +6,7 @@
     margin-bottom: 12px;     /* 下の名前との距離 */
 }
 
-article#documenter-page img[src$=".svg"][alt*="Example block"] {
+article#documenter-page img {
     display: block;
     margin-left: auto;
     margin-right: auto;

docs/src/example/getting_started.md

@@ -0,0 +1,134 @@
+# Getting Started: Your First Quantum Circuit
+
+In this page, you will learn:
+
+- How to construct quantum circuits on GroverAlgorithm.jl
+- How quantum circuits on GroverAlgorithm.jl works in ITensors and Quantikz.
+
+## Install
+
+In order to use visualize functions, `LaTeX` and `Quantikz` may be needed.
+
+```julia
+using Pkg
+Pkg.add(url="https://github.com/sotashimozono/GroverAlgorithm.jl")
+Pkg.add("ITensors")
+Pkg.add("ITensorMPS")
+```
+
+## Basics
+
+In GroverAlgorithm.jl, use quantum circuits as follows:
+
+1. Construct circuit - define circuit by adding desired gates.
+2. Simulation on ITensors.jl - calculate quantum states.
+3. Visualize circuits on Quantikz - generate circuits figure on LaTeX
+
+## Example: Hadamard gate
+
+Let's consider from easiest one.
+
+### step1: Construct gate
+
+```@example getting_started
+using GroverAlgorithm
+using ITensors, ITensorMPS
+
+# 1 site qubit
+circuit = QuantumCircuit(1, AbstractQuantumGate[])
+
+# add Hadamard gate
+add_gate!(circuit, SingleQubitGate(1, :H))
+
+println("circuit information:")
+println("  number of qubits: ", circuit.nqubits)
+println("  number of gates: ", length(circuit.gates))
+```
+
+### step2: Simulation on ITensors.jl
+
+```@example getting_started
+using ITensors, ITensorMPS
+
+# site index
+sites = siteinds("Qubit", 1)
+
+# execute circuit
+psi = execute_circuit(circuit, sites)
+
+# MPS info
+println("\nMPS (Matrix Product State):")
+println(psi)
+```
+
+structure of MPS：
+
+```@example getting_started
+println("amplitude of quantum states:")
+amp_0 = inner(psi, MPS(sites, ["0"]))
+amp_1 = inner(psi, MPS(sites, ["1"]))
+
+println("  ⟨0|ψ⟩ = ", amp_0, " (probability: ", abs2(amp_0), ")")
+println("  ⟨1|ψ⟩ = ", amp_1, " (probability: ", abs2(amp_1), ")")
+```
+
+this means the state $|\psi\rangle$ is superposition of $|0\rangle, |1\rangle$:  
+$$\begin{aligned}
+|\psi\rangle = \frac{|0\rangle+|1\rangle}{\sqrt2}
+\end{aligned}$$
+
+### step3: Visualization on Quantikz
+
+```@example getting_started
+# generate LaTeX string of quantikz
+latex_code = to_quantikz(circuit)
+println("Quantikz LaTeX code:")
+println(latex_code)
+```
+
+This LaTeX code generates following：
+
+```@example getting_started
+to_tikz_picture(circuit)
+```
+
+## Example2: Bell state（Entanglement）
+
+Next, we construct 2-site qubit.
+
+### step1: construct circuits
+
+```@example getting_started
+circuit = QuantumCircuit(2, AbstractQuantumGate[])
+
+add_gate!(circuit, SingleQubitGate(1, :H))
+add_gate!(circuit, ControlledGate(1, 2, :CNOT))
+
+println("Bell state circuit:")
+println("  gate1: H on qubit 1")
+println("  gate2: CNOT (control: 1, target: 2)")
+```
+
+### step2: Simulation on ITensors
+
+```@example getting_started
+sites = siteinds("Qubit", 2)
+psi = execute_circuit(circuit, sites)
+
+println("amplitude of Bell state:")
+for s in ["00", "01", "10", "11"]
+    basis = MPS(sites, [string(c) for c in s])
+    amp = inner(basis, psi)
+    prob = abs2(amp)
+    println("  ⟨$s|ψ⟩ = ", round(amp, digits=4), " (probability: ", round(prob, digits=4), ")")
+end
+```
+
+### step3: Visualize circuit on Quantikz
+
+```@example getting_started
+latex_code = to_quantikz(circuit)
+println(latex_code)
+
+to_tikz_picture(circuit)
+```

docs/src/example/toffoli.md

@@ -0,0 +1,91 @@
+```@meta
+EditURL = "../../../example/toffoli.jl"
+```
+
+# Toffoli Gate Example
+Here we define the Toffoli gate (CCNOT) using the GroverAlgorithm package
+This is an example of how to use the package.
+Toffoli gate is available in ITensorMPS.jl as a built-in gate.
+Let's create a Toffoli gate and check its action on the basis states.
+
+## Using the built-in Toffoli gate
+In ITensorMPS.jl, the Toffoli gate is available as a built-in three-qubit gate. We can simply add it to our quantum circuit and execute it.
+
+````@example toffoli
+using Printf
+using GroverAlgorithm
+using ITensors, ITensorMPS
+
+circuit = QuantumCircuit(3)
+add_gate!(circuit, ThreeQubitGate(1, 2, 3, :Toffoli))
+
+sites = siteinds("Qubit", 3)
+psi = execute_circuit(circuit, sites)
+counts = measure(psi, Sampling(100))
+println("結果: ", counts)
+````
+
+Toffoli gate acts as follows for the basis states:
+
+````@example toffoli
+function test_actions(circuit)
+    println("Test of Toffoli Gate")
+    println("=" ^ 50)
+    println("Input  |  Output")
+    println("-" ^ 50)
+    for a in 0:1, b in 0:1, c in 0:1
+        initial = AbstractInitialState[ProductState([string(a), string(b), string(c)])]
+        set_state!(circuit, initial)
+
+        sites = siteinds("Qubit", 3)
+        psi = execute_circuit(circuit, sites)
+
+        counts = measure(psi, Sampling(1))
+        output = collect(keys(counts))[1]
+        @printf("|%d%d%d⟩ → |%s⟩\n", a, b, c, output)
+    end
+end
+
+test_actions(circuit)
+````
+
+## Toffoli gate decomposition
+Then, Lets's construct the Toffoli gate using the standard decomposition into CNOT and single-qubit gates,
+and verify that it produces the same results as the built-in Toffoli gate.
+
+````@example toffoli
+function toffoli_decomposed(circuit)
+    add_gate!(circuit, SingleQubitGate(3, :H))
+    add_gate!(circuit, ControlledGate(2, 3, :CX))
+    add_gate!(circuit, SingleQubitGate(3, :Tdag))
+    add_gate!(circuit, ControlledGate(1, 3, :CX))
+    add_gate!(circuit, SingleQubitGate(3, :T))
+    add_gate!(circuit, ControlledGate(2, 3, :CX))
+    add_gate!(circuit, SingleQubitGate(2, :Tdag))
+    add_gate!(circuit, SingleQubitGate(3, :Tdag))
+    add_gate!(circuit, ControlledGate(1, 3, :CX))
+    add_gate!(circuit, ControlledGate(1, 2, :CX))
+    add_gate!(circuit, SingleQubitGate(1, :T))
+    add_gate!(circuit, SingleQubitGate(2, :Tdag))
+    add_gate!(circuit, SingleQubitGate(3, :T))
+    add_gate!(circuit, ControlledGate(1, 2, :CX))
+    add_gate!(circuit, SingleQubitGate(2, :S))
+    add_gate!(circuit, SingleQubitGate(3, :H))
+    return circuit
+end
+circuit_decomposed = QuantumCircuit(3)
+toffoli_decomposed(circuit_decomposed)
+
+tp = to_tikz_picture(circuit_decomposed)
+````
+
+Let's test the action of the decomposed Toffoli gate on the basis states to verify that it behaves the same as the built-in Toffoli gate.
+
+````@example toffoli
+test_actions(circuit_decomposed)
+````
+
+---
+
+*This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).*
+

example/makedocs.jl

@@ -4,7 +4,7 @@ Pkg.activate("../")
 using Literate, GroverAlgorithm, ITensors, ITensorMPS
 
 base_dir = pkgdir(GroverAlgorithm)
-output_dir = joinpath(base_dir, "docs", "src", "examples")
+output_dir = joinpath(base_dir, "docs", "src", "example")
 mkpath(output_dir)
 
 Literate.markdown("toffoli.jl", output_dir; documenter=true)

example/toffoli.jl

@@ -1,11 +1,16 @@
-using Printf
-using GroverAlgorithm
-using ITensors, ITensorMPS
-
+# # Toffoli Gate Example
 # Here we define the Toffoli gate (CCNOT) using the GroverAlgorithm package
 # This is an example of how to use the package.
 # Toffoli gate is available in ITensorMPS.jl as a built-in gate.
 # Let's create a Toffoli gate and check its action on the basis states.
+
+# ## Using the built-in Toffoli gate
+# In ITensorMPS.jl, the Toffoli gate is available as a built-in three-qubit gate. We can simply add it to our quantum circuit and execute it.
+
+using Printf
+using GroverAlgorithm
+using ITensors, ITensorMPS
+
 circuit = QuantumCircuit(3)
 add_gate!(circuit, ThreeQubitGate(1, 2, 3, :Toffoli))
 
@@ -33,10 +38,9 @@ function test_actions(circuit)
     end
 end
 
-circuit = QuantumCircuit(3)
-add_gate!(circuit, ThreeQubitGate(1, 2, 3, :Toffoli))
 test_actions(circuit)
 
+# ## Toffoli gate decomposition
 # Then, Lets's construct the Toffoli gate using the standard decomposition into CNOT and single-qubit gates,
 # and verify that it produces the same results as the built-in Toffoli gate.
 function toffoli_decomposed(circuit)
@@ -60,6 +64,8 @@ function toffoli_decomposed(circuit)
 end
 circuit_decomposed = QuantumCircuit(3)
 toffoli_decomposed(circuit_decomposed)
-test_actions(circuit_decomposed)
 
 tp = to_tikz_picture(circuit_decomposed)
+
+# Let's test the action of the decomposed Toffoli gate on the basis states to verify that it behaves the same as the built-in Toffoli gate.
+test_actions(circuit_decomposed)