QuantumOperatorDefinitions.jl

Support

QuantumOperatorDefinitions.jl is supported by the Flatiron Institute, a division of the Simons Foundation.

Installation instructions

This package resides in the ITensor/ITensorRegistry local registry. In order to install, simply add that registry through your package manager. This step is only required once.

julia> using Pkg: Pkg

julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")

or:

julia> Pkg.Registry.add(url="git@github.com:ITensor/ITensorRegistry.git")

if you want to use SSH credentials, which can make it so you don't have to enter your Github ursername and password when registering packages.

Then, the package can be added as usual through the package manager:

julia> Pkg.add("QuantumOperatorDefinitions")

Examples

using QuantumOperatorDefinitions: OpName, SiteType, StateName, ⊗, controlled, op, state
using SparseArrays: SparseMatrixCSC, SparseVector
using Test: @test

@test state("0") == [1, 0]
@test state("1") == [0, 1]

@test state(Float32, "0") == [1, 0]
@test eltype(state(Float32, "1")) === Float32

@test Vector(StateName("0")) == [1, 0]
@test Vector(StateName("1")) == [0, 1]

@test Vector{Float32}(StateName("0")) == [1, 0]
@test eltype(Vector{Float32}(StateName("0"))) === Float32

@test state(SparseVector, "0") == [1, 0]
@test state(SparseVector, "0") isa SparseVector

@test state("0", 3) == [1, 0, 0]
@test state("1", 3) == [0, 1, 0]
@test state("2", 3) == [0, 0, 1]

@test Vector(StateName("0"), 3) == [1, 0, 0]
@test Vector(StateName("1"), 3) == [0, 1, 0]
@test Vector(StateName("2"), 3) == [0, 0, 1]

@test op("X") == [0 1; 1 0]
@test op("Y") == [0 -im; im 0]
@test op("Z") == [1 0; 0 -1]

@test op(Float32, "X") == [0 1; 1 0]
@test eltype(op(Float32, "X")) === Float32
@test op(SparseMatrixCSC, "X") == [0 1; 1 0]
@test op(SparseMatrixCSC, "X") isa SparseMatrixCSC

@test Matrix(OpName("X")) == [0 1; 1 0]
@test Matrix(OpName("Y")) == [0 -im; im 0]
@test Matrix(OpName("Z")) == [1 0; 0 -1]

@test Matrix(OpName("Rx"; θ=π / 3)) ≈ [sin(π / 3) -cos(π / 3)*im; -cos(π / 3)*im sin(π / 3)]

Test Passed

This page was generated using Literate.jl.