Language.Quil.Types

Types for the Quil language for quantum computing, <https://arxiv.org/abs/1608.03355/>, and generally conforming to <https://github.com/rigetticomputing/pyquil/blob/master/pyquil/_parser/Quil.g4>.

Machines

data Machine

A quantum abstract machine.

Constructors

Machine

Fields

• qstate :: Wavefunction

  The qubits.

• cstate :: BV

  The classical bits

• definitions :: Definitions

  Definitions of gates and circuits.

• counter :: Int

  The program counter.

• halted :: Bool

  Whether the machine has halted.

Instances

Show Machine

Methods

showsPrec :: Int -> Machine -> ShowS

show :: Machine -> String

showList :: [Machine] -> ShowS

Default Machine

Methods

def :: Machine

machine

Arguments

:: Int

The number of qubits.

-> [BitData]

The classical bits.

-> Machine

The machine.

Initialize a machine.

data Definitions

Definitions of gates and circuits.

Constructors

Definitions

Fields

• gates :: [(Name, Gate)]
• circuits :: [(Name, Circuit)]

Instances

Default Definitions

Methods

def :: Definitions

type Gate = [QBit] -> Arguments -> Operator

A gate.

type Circuit = Definitions -> [QBit] -> Arguments -> Operator

A circuit

Instructions

data Instruction

The Quil instruction set.

Constructors

COMMENT String

Does nothing.

RESET

I QBit

X QBit

Y QBit

Z QBit

H QBit

PHASE Parameter QBit

S QBit

T QBit

CPHASE00 Parameter QBit QBit

CPHASE01 Parameter QBit QBit

CPHASE10 Parameter QBit QBit

CPHASE Parameter QBit QBit

RX Parameter QBit

RY Parameter QBit

RZ Parameter QBit

CNOT QBit QBit

CCNOT QBit QBit QBit

PSWAP Parameter QBit QBit

SWAP QBit QBit

ISWAP QBit QBit

CSWAP QBit QBit QBit

CZ QBit QBit

DEFGATE Name [Variable] [Expression]

Not yet implemented.

USEGATE Name [Parameter] [QBit]

Not yet implemented.

DEFCIRCUIT Name [Variable] [QVariable] [CircuitInstruction]

Not yet implemented.

USECIRCUIT Name [Parameter] [QBit]

Not yet implemented.

MEASURE QBit (Maybe Address)

HALT

WAIT

Does nothing.

LABEL Label

Not yet implemented.

JUMP Label

Not yet implemented.

JUMP_WHEN Label Address

Not yet implemented.

JUMP_UNLESS Label Address

Not yet implemented.

FALSE Address

TRUE Address

NOT Address

AND Address Address

OR Address Address

MOVE Address Address

EXCHANGE Address Address

NOP

INCLUDE FilePath

Not yet implemented.

PRAGMA String

Does nothing.

Instances

Eq Instruction

Methods

(==) :: Instruction -> Instruction -> Bool

(/=) :: Instruction -> Instruction -> Bool

Read Instruction

Methods

readsPrec :: Int -> ReadS Instruction

readList :: ReadS [Instruction]

readPrec :: ReadPrec Instruction

readListPrec :: ReadPrec [Instruction]

Show Instruction

Methods

showsPrec :: Int -> Instruction -> ShowS

show :: Instruction -> String

showList :: [Instruction] -> ShowS

data CircuitInstruction

Instructions within circuit definitions.

Constructors

CircuitInstruction Instruction

CircuitGate Name [Parameter] [CircuitQBit]

Instances

Eq CircuitInstruction

Methods

(==) :: CircuitInstruction -> CircuitInstruction -> Bool

(/=) :: CircuitInstruction -> CircuitInstruction -> Bool

Read CircuitInstruction

Methods

readsPrec :: Int -> ReadS CircuitInstruction

readList :: ReadS [CircuitInstruction]

readPrec :: ReadPrec CircuitInstruction

readListPrec :: ReadPrec [CircuitInstruction]

Show CircuitInstruction

Methods

showsPrec :: Int -> CircuitInstruction -> ShowS

show :: CircuitInstruction -> String

showList :: [CircuitInstruction] -> ShowS

data CircuitQBit

References to qubits within circuit definitions.

Constructors

CircuitQBit QBit

CircuitQVariable QVariable

Instances

Eq CircuitQBit

Methods

(==) :: CircuitQBit -> CircuitQBit -> Bool

(/=) :: CircuitQBit -> CircuitQBit -> Bool

Read CircuitQBit

Methods

readsPrec :: Int -> ReadS CircuitQBit

readList :: ReadS [CircuitQBit]

readPrec :: ReadPrec CircuitQBit

readListPrec :: ReadPrec [CircuitQBit]

Show CircuitQBit

Methods

showsPrec :: Int -> CircuitQBit -> ShowS

show :: CircuitQBit -> String

showList :: [CircuitQBit] -> ShowS

data Parameter

Classical parameter.

Constructors

DynamicParameter Int (Maybe Int)

Expression Expression

Instances

Eq Parameter

Methods

(==) :: Parameter -> Parameter -> Bool

(/=) :: Parameter -> Parameter -> Bool

Read Parameter

Methods

readsPrec :: Int -> ReadS Parameter

readList :: ReadS [Parameter]

readPrec :: ReadPrec Parameter

readListPrec :: ReadPrec [Parameter]

Show Parameter

Methods

showsPrec :: Int -> Parameter -> ShowS

show :: Parameter -> String

showList :: [Parameter] -> ShowS

type Name = String

Name of a gate or circuit.

type QBit = Int

Index of a qubit.

type QVariable = String

Qubit variable name.

type Address = Int

Address of a classical bit.

type Variable = String

Classical variable name.

type Label = String

Label for a jump target.

Expressions

data Expression

Classical expression.

Constructors

Power Expression Expression

Times Expression Expression

Divide Expression Expression

Plus Expression Expression

Minus Expression Expression

Negate Expression

Sin Expression

Cos Expression

Sqrt Expression

Exp Expression

Cis Expression

Number Number

Variable Variable

Instances

Eq Expression

Methods

(==) :: Expression -> Expression -> Bool

(/=) :: Expression -> Expression -> Bool

Read Expression

Methods

readsPrec :: Int -> ReadS Expression

readList :: ReadS [Expression]

readPrec :: ReadPrec Expression

readListPrec :: ReadPrec [Expression]

Show Expression

Methods

showsPrec :: Int -> Expression -> ShowS

show :: Expression -> String

showList :: [Expression] -> ShowS

type Number = Complex Double

Complex number.

type Parameters = Vector Variable

Formal parameters.

type Arguments = Vector Number

Argument list.

Classical Bits

data BitData

Data types for encoding as bit vectors.

Constructors

BoolBit Bool

IntegerBits Int Integer

DoubleBits Double

ComplexBits Number

Instances

Eq BitData

Methods

(==) :: BitData -> BitData -> Bool

(/=) :: BitData -> BitData -> Bool

Read BitData

Methods

readsPrec :: Int -> ReadS BitData

readList :: ReadS [BitData]

readPrec :: ReadPrec BitData

readListPrec :: ReadPrec [BitData]

Show BitData

Methods

showsPrec :: Int -> BitData -> ShowS

show :: BitData -> String

showList :: [BitData] -> ShowS

toBitVector :: BitData -> BV

Encode data as a bit vector.

boolFromBitVector

Arguments

:: Int

Which bit to start from, counting from zero.

-> BV

The bit vector.

-> Bool

The boolean.

Extract a boolean from a bit vector.

integerFromBitVector

Arguments

:: Int

Which bit to start from, counting from zero.

-> Int

How many bits to encode.

-> BV

The bit vector

-> Integer

The integer.

Extract an integer from a bit vector.

doubleFromBitVector

Arguments

:: Int

Which bit to start from, counting from zero.

-> BV

THe bit vector.

-> Double

The double.

Extract a double from a bit vector.

complexFromBitVector

Arguments

:: Int

Which bit to start from, counting from zero.

-> BV

THe bit vector.

-> Number

The complex number.

Extract a complex number from a bit vector.