This is the clq Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri May 15 12:08:16 2026 GMT+0.
The main system appears first, followed by any subsystem dependency.
Modules are listed depth-first from the system components tree.
Files are sorted by type and then listed depth-first from the systems components trees.
clq/src/main.lispsrc (module).
clq.
ccxgate (method).
chgate (method).
cregister (class).
cregs (reader method).
(setf cregs) (writer method).
csdggate (method).
csgate (method).
cswapgate (method).
ctdggate (method).
ctgate (method).
cu1gate (method).
cvdggate (method).
cvgate (method).
cxgate (method).
cygate (method).
czgate (method).
embed-defs (method).
embed-qasm (method).
generate-openqasm (function).
hgate (method).
igate (method).
make-cregister (function).
make-qcircuit (function).
make-qgate (function).
make-qregister (function).
mcxgate (method).
measure (method).
name (reader method).
name (reader method).
name (reader method).
(setf name) (writer method).
(setf name) (writer method).
(setf name) (writer method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
qbarrier (method).
qcircuit (class).
qgate (class).
qregister (class).
qregs (reader method).
(setf qregs) (writer method).
rxgate (method).
rygate (method).
rzgate (method).
save-openqasm-to-file (function).
sdggate (method).
sgate (method).
size (reader method).
size (reader method).
(setf size) (writer method).
(setf size) (writer method).
swapgate (method).
tdggate (method).
tgate (method).
vdggate (method).
vgate (method).
xgate (method).
ygate (method).
zgate (method).
add-defs (method).
add-gate (method).
cregister-equal (method).
defs (reader method).
(setf defs) (writer method).
fmt (reader method).
(setf fmt) (writer method).
gates (reader method).
(setf gates) (writer method).
get-cregisters (function).
get-definitions (function).
get-gate (function).
get-operators (function).
get-qregisters (function).
mcx-def (method).
numbers->letters (function).
qregister-equal (method).
validate-cregister (method).
validate-qregister (method).
Packages are listed by definition order.
clqcommon-lisp.
ccxgate (generic function).
chgate (generic function).
cregister (class).
cregs (generic reader).
(setf cregs) (generic writer).
csdggate (generic function).
csgate (generic function).
cswapgate (generic function).
ctdggate (generic function).
ctgate (generic function).
cu1gate (generic function).
cvdggate (generic function).
cvgate (generic function).
cxgate (generic function).
cygate (generic function).
czgate (generic function).
embed-defs (generic function).
embed-qasm (generic function).
generate-openqasm (function).
hgate (generic function).
igate (generic function).
make-cregister (function).
make-qcircuit (function).
make-qgate (function).
make-qregister (function).
mcxgate (generic function).
measure (generic function).
name (generic reader).
(setf name) (generic writer).
qbarrier (generic function).
qcircuit (class).
qgate (class).
qregister (class).
qregs (generic reader).
(setf qregs) (generic writer).
rxgate (generic function).
rygate (generic function).
rzgate (generic function).
save-openqasm-to-file (function).
sdggate (generic function).
sgate (generic function).
size (generic reader).
(setf size) (generic writer).
swapgate (generic function).
tdggate (generic function).
tgate (generic function).
vdggate (generic function).
vgate (generic function).
xgate (generic function).
ygate (generic function).
zgate (generic function).
add-defs (generic function).
add-gate (generic function).
cregister-equal (generic function).
defs (generic reader).
(setf defs) (generic writer).
fmt (generic reader).
(setf fmt) (generic writer).
gates (generic reader).
(setf gates) (generic writer).
get-cregisters (function).
get-definitions (function).
get-gate (function).
get-operators (function).
get-qregisters (function).
mcx-def (generic function).
numbers->letters (function).
qregister-equal (generic function).
validate-cregister (generic function).
validate-qregister (generic function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Converts the Quantum Circuit into OpenQASM v2.0 code.
Parameters:
- qc: the quantum circuit object.
- result-str: the string that will contain the OpenQASM v2.0 code. By default is empty.
Constructor for the Classical Register.
Parameters:
- size: the number of bits in the classical register.
- name: classical register’s name.
Constructor for the Quantum Circuit.
Parameters:
- qregs: list of quantum register.
- cregs: list of classical register.
Constructor for the Quantum Gate.
Parameters:
- name : quantum gate’s name.
- fmt : format of the generate OpenQASM v2.0 code
Constructor for the Quantum Register.
Parameters:
- sizes: the number of qubits in the quantum register.
- name: quantum register’s name.
Converts the Quantum Circuit into OpenQASM v2.0 code and writes it into a file.
Parameters:
- qc: the quantum circuit object.
- file-path: the file path that will be created.
clq.
qcircuit) (ctrl0 qregister) ctrlp0 (ctrl1 qregister) ctrlp1 (targ qregister) targp) ¶Create and apply a Controlled-X gate.
Parameters:
- qc : quantum circuit.
- ctrl0 : control quantum register.
- ctrlp0 : the qubit’s index in the control quantum register.
- ctrl1 : control quantum register.
- ctrlp1 : the qubit’s index in the control quantum register.
- targ : target quantum register.
- targp : the qubit’s index in the target quantum register.
clq.
qcircuit) (ctrl qregister) ctrlp (targ qregister) targp) ¶Create and apply a Controlled-H gate.
Parameters:
- qc : quantum circuit.
- ctrl : control quantum register.
- ctrlp : the qubit’s index in the control quantum register.
- targ : target quantum register.
- targp : the qubit’s index in the target quantum register.
clq.
qcircuit) (ctrl qregister) ctrlp (targ qregister) targp) ¶Create and apply a Controlled-SDG gate.
Parameters:
- qc : quantum circuit.
- ctrl : control quantum register.
- ctrlp : the qubit’s index in the control quantum register.
- targ : target quantum register.
- targp : the qubit’s index in the target quantum register.
clq.
qcircuit) (ctrl qregister) ctrlp (targ qregister) targp) ¶Create and apply a Controlled-S gate.
Parameters:
- qc : quantum circuit.
- ctrl : control quantum register.
- ctrlp : the qubit’s index in the control quantum register.
- targ : target quantum register.
- targp : the qubit’s index in the target quantum register.
clq.
qcircuit) (ctrl qregister) ctrlp (targ1 qregister) targp1 (targ2 qregister) targp2) ¶Create and apply a Controlled-Z gate.
Parameters:
- qc : quantum circuit.
- ctrl : control quantum register.
- ctrlp : the qubit’s index in the control quantum register.
- targ1 : first target quantum register.
- targp1 : the qubit’s index in the first target quantum register.
- targ2 : second target quantum register.
- targp2 : the qubit’s index in the second target quantum register.
clq.
qcircuit) (ctrl qregister) ctrlp (targ qregister) targp) ¶Create and apply a Controlled-TDG gate.
Parameters:
- qc : quantum circuit.
- ctrl : control quantum register.
- ctrlp : the qubit’s index in the control quantum register.
- targ : target quantum register.
- targp : the qubit’s index in the target quantum register.
clq.
qcircuit) (ctrl qregister) ctrlp (targ qregister) targp) ¶Create and apply a Controlled-t gate.
Parameters:
- qc : quantum circuit.
- ctrl : control quantum register.
- ctrlp : the qubit’s index in the control quantum register.
- targ : target quantum register.
- targp : the qubit’s index in the target quantum register.
clq.
qcircuit) lambda (ctrl qregister) ctrlp (targ qregister) targp) ¶Create and apply a Controlled-Phase rotation.
Parameters:
- qc : quantum circuit.
- lambda : rotation angle
- ctrl : control quantum register.
- ctrlp : the qubit’s index in the control quantum register.
- targ : target quantum register.
- targp : the qubit’s index in the target quantum register.
clq.
qcircuit) (ctrl qregister) ctrlp (targ qregister) targp) ¶Create and apply a Controlled-VDG gate.
Parameters:
- qc : quantum circuit.
- ctrl : control quantum register.
- ctrlp : the qubit’s index in the control quantum register.
- targ : target quantum register.
- targp : the qubit’s index in the target quantum register.
clq.
qcircuit) (ctrl qregister) ctrlp (targ qregister) targp) ¶Create and apply a Controlled-V gate.
Parameters:
- qc : quantum circuit.
- ctrl : control quantum register.
- ctrlp : the qubit’s index in the control quantum register.
- targ : target quantum register.
- targp : the qubit’s index in the target quantum register.
clq.
qcircuit) (ctrl qregister) ctrlp (targ qregister) targp) ¶Create and apply a Controlled-X gate.
Parameters:
- qc : quantum circuit.
- ctrl : control quantum register.
- ctrlp : the qubit’s index in the control quantum register.
- targ : target quantum register.
- targp : the qubit’s index in the target quantum register.
clq.
qcircuit) (ctrl qregister) ctrlp (targ qregister) targp) ¶Create and apply a Controlled-Y gate.
Parameters:
- qc : quantum circuit.
- ctrl : control quantum register.
- ctrlp : the qubit’s index in the control quantum register.
- targ : target quantum register.
- targp : the qubit’s index in the target quantum register.
clq.
qcircuit) (ctrl qregister) ctrlp (targ qregister) targp) ¶Create and apply a Controlled-Z gate.
Parameters:
- qc : quantum circuit.
- ctrl : control quantum register.
- ctrlp : the qubit’s index in the control quantum register.
- targ : target quantum register.
- targp : the qubit’s index in the target quantum register.
clq.
qcircuit) (ctrl qregister) ctrl-pos (targ qregister) targ-pos) ¶Create and apply a Toffoli gate.
Parameters:
- qc : quantum circuit
- ctrl : control quantum register
- ctrl-pos: list of control qubits indices
- targ : target quantum register
- targ-pos: target qubit index
clq.
qcircuit) (ctrl qregister) ctrlp (targ cregister) targp) ¶Create and apply a Measurement operator.
Parameters:
- qc : quantum circuit.
- ctrl : control quantum register.
- ctrlp : the qubit’s index in the quantum register.
- targ : classical register.
- targp : the qubit’s index in the classical register.
clq.
qcircuit) (reg1 qregister) pos1 (reg2 qregister) pos2) ¶Create and apply a SWAP gate.
Parameters:
- qc : quantum circuit.
- reg1 : first quantum register.
- pos1 : the qubit’s index in the first quantum register.
- reg2 : second quantum register.
- pos2 : the qubit’s index in the second quantum register.
clq.
add-defs.
add-gate.
ccxgate.
chgate.
(setf cregs).
cregs.
csdggate.
csgate.
cswapgate.
ctdggate.
ctgate.
cu1gate.
cvdggate.
cvgate.
cxgate.
cygate.
czgate.
(setf defs).
defs.
embed-defs.
embed-qasm.
(setf gates).
gates.
hgate.
igate.
mcx-def.
mcxgate.
measure.
print-object.
qbarrier.
(setf qregs).
qregs.
rxgate.
rygate.
rzgate.
sdggate.
sgate.
swapgate.
tdggate.
tgate.
validate-cregister.
validate-qregister.
vdggate.
vgate.
xgate.
ygate.
zgate.
Quantum Registers.
:qregs
Classical Registers.
:cregs
List of applied quantum gates.
:gates
clq.
ccxgate.
chgate.
csdggate.
csgate.
cswapgate.
ctdggate.
ctgate.
cu1gate.
cvdggate.
cvgate.
cxgate.
cygate.
czgate.
hgate.
igate.
mcxgate.
measure.
(setf name).
name.
print-object.
qregister-equal.
rxgate.
rygate.
rzgate.
sdggate.
sgate.
(setf size).
size.
swapgate.
tdggate.
tgate.
validate-qregister.
vdggate.
vgate.
xgate.
ygate.
zgate.
| Jump to: | (
A C D E F G H I M N P Q R S T V X Y Z |
|---|
| Jump to: | (
A C D E F G H I M N P Q R S T V X Y Z |
|---|
| Jump to: | C D F G N Q S |
|---|
| Jump to: | C D F G N Q S |
|---|
| Jump to: | C F M P Q S |
|---|
| Jump to: | C F M P Q S |
|---|