References

backends

summary
public	C CommandPrinter CommandPrinter is a compiler engine which prints commands to stdout prior to sending them on to the next compiler engine.
public	C ResourceCounter ResourceCounter is a compiler engine which counts the number of gates and max.

backends/circuits

summary
public	C CircuitDrawer CircuitDrawer is a compiler engine which generates TikZ code for drawing quantum circuits.
public	C CircuitItem
private	C _Circ2Tikz The Circ2Tikz class takes a circuit (list of lists of CircuitItem objects) and turns them into Latex/TikZ code.

backends/ibm

summary
public	C IBMBackend The IBM Backend class, which stores the circuit, transforms it to JSON QASM, and sends the circuit through the IBM API.
public	C IBMHTTPClient

backends/simulators

summary
public	C ClassicalSimulator A simple introspective simulator that only permits classical operations.
public	C Simulator NodeJS implementation of a quantum computer simulator.
public	C Simulator Simulator is a compiler engine which simulates a quantum computer using C++-based kernels.

cengines

summary
public	C BasicMapperEngine Defines the parent class from which all mappers should be derived.
public abstract	C BasicEngine Basic compiler engine: All compiler engines are derived from this class.
public	C ForwarderEngine A ForwarderEngine is a trivial engine which forwards all commands to the next engine.
public	C CommandModifier CommandModifier is a compiler engine which applies a function to all incoming commands, sending on the resulting command instead of the original one.
public	C IBM5QubitMapper Mapper for the 5-qubit IBM backend.
public	C LinearMapper Maps a quantum circuit to a linear chain of nearest neighbour interactions.
public	C MainEngine The MainEngine class provides all functionality of the main compiler engine.
public	C ManualMapper Manual Mapper which adds QubitPlacementTags to Allocate gate commands according to a user-specified mapping.
public	C LocalOptimizer is a compiler engine which optimizes locally (merging rotations, cancelling gates with their inverse) in a local window of user- defined size.
public	C SwapAndCNOTFlipper Flips CNOTs and translates Swaps to CNOTs where necessary.
public	C TagRemover is a compiler engine which removes temporary command tags (see the tag classes such as LoopTag in `loop`).
public	C CompareEngine CompareEngine is an engine which saves all commands.
public	C DummyEngine DummyEngine used for testing.
public	C GridMapper Mapper to a 2-D grid graph.
public	C Position
public	V ibmqx4_connections: Set<string>

cengines/replacer

summary
public	C DecompositionRule A rule for breaking down specific gates into sequences of simpler gates.
public	C DecompositionRuleSet
public	C AutoReplacer The AutoReplacer is a compiler engine which uses engine.isAvailable in order to determine which commands need to be replaced/decomposed/compiled further.
public	C InstructionFilter The InstructionFilter is a compiler engine which changes the behavior of isAvailable according to a filter function.

libs

summary
public	F len(v: any): number return `length` of v, act like python
public	F classHierachy(cls: function): function[] return class hierachy of `cls`
public	F instanceOf(inst: any, cls: function): boolean check if `inst` is instance of `cls`, specialized for some class
public	F isKindclassOf(cls: function, superClass: function): boolean check if `cls` is kind of `superClass`, will return true if cls is superClass
public	F isSubclassOf(cls: function, superClass: function): boolean check if `cls` is subclass of `superClass`, will return false if cls is superClass
public	F tuple(args: *): Array create `tuple` from arguments

libs/math

summary
public	C AddConstant Add a constant to a quantum number represented by a quantum register, stored from low- to high-bit.
public	C AddConstantModN Add a constant to a quantum number represented by a quantum register modulo N.
public	C MultiplyByConstantModN Multiply a quantum number represented by a quantum register by a constant modulo N.
public	F SubConstant(a: number): * Subtract a constant from a quantum number represented by a quantum register, stored from low- to high-bit.
public	F SubConstantModN(a: number, N: number): * Subtract a constant from a quantum number represented by a quantum register modulo N.

summary
public	C ComputeEngine Adds Compute-tags to all commands and stores them (to later uncompute them automatically)
public	C UncomputeEngine
public	C ControlEngine
public	C DaggerEngine Stores all commands and, when done, inverts the circuit & runs it.
public	C LastEngineError
public	C NoGateDecompositionError
public	C NotMergeable
public	C NotYetMeasuredError
public	C QubitManagementError
public	C LoopEngine Stores all commands and, when done, executes them num times if no loop tag handler engine is available.
public	C LoopTag
public	C ComputeTag
public	C DirtyQubitTag
public	C LogicalQubitIDTag
public	C UncomputeTag
public	F Compute(engine: , func: ) Start a compute-section.
public	F CustomUncompute(engine: , func: ) Start a custom uncompute-section.
public	F Uncompute(engine: *) Uncompute automatically.
public	F Control(engine: BasicEngine, qubits: Array<BasicQubit>, func: function) Condition an entire code block on the value of qubits being 1.
public	F Dagger(engine: BasicEngine, func: function) Invert an entire code block.
public	F Loop(engine: BasicEngine, num: number, func: function)
public	F dropEngineAfter(engine: BasicEngine): BasicEngine Removes an engine from the singly-linked list of engines.
public	F insertEngine(prevEngine: BasicEngine, engineToInsert: BasicEngine) Inserts an engine into the singly-linked list of engines.

ops

summary
public abstract	C BasicGate Base class of all gates.
public	C BasicMathGate Base class for all math gates.
public	C BasicPhaseGate Defines a base class of a phase gate.
public	C BasicRotationGate Defines a base class of a rotation gate.
public	C ClassicalInstructionGate Classical instruction gates never have control qubits.
public	C FastForwardingGate Base class for classical instruction gates which require a fast-forward through compiler engines that cache / buffer gates.
public	C SelfInverseGate Self-inverse basic gate class.
public	C Command Class used as a container to store commands.
public	C AllocateDirtyQubitGate
public	C AllocateQubitGate
public	C BarrierGate
public	C DeallocateQubitGate
public	C EntangleGate gate (Hadamard on first qubit, followed by CNOTs applied to all other qubits).
public	C FlushGate Flush gate (denotes the end of the circuit).
public	C HGate
public	C MeasureGate Measurement gate class (for single qubits).
public	C Ph Phase gate (global phase)
public	C R Phase-shift gate (equivalent to Rz up to a global phase)
public	C Rx
public	C Ry
public	C Rz RotationZ gate class
public	C SGate
public	C SqrtSwapGate Square-root Swap gate class
public	C SqrtXGate
public	C SwapGate Swap gate class (swaps 2 qubits) also self inverse gate
public	C TGate
public	C XGate
public	C YGate
public	C ZGate
public	C ControlledGate Controlled version of a gate.
public	C DaggeredGate Wrapper class allowing to execute the inverse of a gate, even when it does not define one.
public	C Tensor Wrapper class allowing to apply a (single-qubit) gate to every qubit in a quantum register.
public	C QFTGate Quantum Fourier Transform gate
public	C QubitOperator A sum of terms acting on qubits, e.g., 0.5 'X0 X5' + 0.3 'Z1 Z2'.
public	C TimeEvolution Gate for time evolution under a Hamiltonian (QubitOperator object).
public	F getInverse(gate: BasicGate): * Return the inverse of a gate.
public	F C(gate: BasicGate, n: number): * Return n-controlled version of the provided gate.
public	F stringToArray(key: ):
public	F CRz(angle: ):
public	V Allocate: AllocateQubitGate
public	V AllocateDirty: AllocateDirtyQubitGate
public	V Entangle: EntangleGate
public	V H: HGate
public	V Measure: MeasureGate
public	V NOT: *
public	V S: SGate
public	V SqrtSwap: SqrtSwapGate
public	V SqrtX: SqrtXGate
public	V Swap: SwapGate
public	V T: TGate
public	V X: XGate
public	V Y: YGate
public	V Z: ZGate
public	V All: *
public	V QFT: QFTGate
public	V CNOT: *
public	V CX: *
public	V CZ: *
public	V Toffoli: *

setups

summary
public	F getEngineList(num_rows: number, num_columns: number, one_qubit_gates: string \| Array<BasicGate>, two_qubit_gates: string \| Array<BasicGate>): Array<BasicEngine> Returns an engine list to compile to a 2-D grid of qubits.
public	F getEngineList(): BasicEngine[]
public	F getEngineList(): undefined[]
public	F getEngineList(): BasicEngine[]
public	F getEngineList(num_qubits: number, cyclic: boolean, one_qubit_gates: string \| Array<BasicGate>, two_qubit_gates: string \| Array<BasicGate>): Array<BasicEngine> Returns an engine list to compile to a linear chain of qubits.
public	F getEngineList(one_qubit_gates: string \| Array<BasicGate>, two_qubit_gates: string \| Array<BasicGate>, other_gates: string \| Array<BasicGate>): Array<BasicEngine> Returns an engine list to compile to a restricted gate set.
public	V ibmqx5_connections: *

types

summary
public	C BasicQubit objects represent qubits.
public	C Qubit Represents a (logical-level) qubit with a unique index provided by the MainEngine.
public	C Qureg Quantum register class.

Directories

References

backends

backends/circuits

backends/ibm

backends/simulators

cengines

cengines/replacer

libs

libs/math

meta

ops

setups

types