qiskit.circuit.classicalfunction.BooleanExpression¶

class BooleanExpression(expression, name=None)[Quellcode]¶

The Boolean Expression gate.

Parameter

expression (str) – The logical expression string.
name (str) – Optional. Instruction gate name. Otherwise part of the expression is going to be used.

Verursacht

MissingOptionalLibraryError – If tweedledum is not installed. Tweedledum is required.

__init__(expression, name=None)[Quellcode]¶

Parameter

expression (str) – The logical expression string.
name (str) – Optional. Instruction gate name. Otherwise part of the expression is going to be used.

Verursacht

MissingOptionalLibraryError – If tweedledum is not installed. Tweedledum is required.

Methods

`__init__`(expression[, name])	type expression `str`
`add_decomposition`(decomposition)	Add a decomposition of the instruction to the SessionEquivalenceLibrary.
`assemble`()	Assemble a QasmQobjInstruction
`broadcast_arguments`(qargs, cargs)	Validation and handling of the arguments and its relationship.
`c_if`(classical, val)	Add classical condition on register classical and value val.
`control`([num_ctrl_qubits, label, ctrl_state])	Return controlled version of gate.
`copy`([name])	Copy of the instruction.
`from_dimacs_file`(filename)	Create a BooleanExpression from the string in the DIMACS format.
`inverse`()	Invert this instruction.
`is_parameterized`()	Return True .IFF.
`mirror`()	DEPRECATED: use instruction.reverse_ops().
`power`(exponent)	Creates a unitary gate as gate^exponent.
`qasm`()	Return a default OpenQASM string for the instruction.
`repeat`(n)	Creates an instruction with gate repeated n amount of times.
`reverse_ops`()	For a composite instruction, reverse the order of sub-instructions.
`simulate`(bitstring)	Evaluate the expression on a bitstring.
`soft_compare`(other)	Soft comparison between gates.
`synth`([registerless, synthesizer])	Synthesis the logic network into a `QuantumCircuit`.
`to_matrix`()	Return a Numpy.array for the gate unitary matrix.
`validate_parameter`(parameter)	Gate parameters should be int, float, or ParameterExpression

Attributes

`decompositions`	Get the decompositions of the instruction from the SessionEquivalenceLibrary.
`definition`	Return definition in terms of other basic gates.
`duration`	Get the duration.
`label`	Return gate label
`params`	return instruction params.
`unit`	Get the time unit of duration.

add_decomposition(decomposition)¶: Add a decomposition of the instruction to the SessionEquivalenceLibrary.

assemble()¶

Assemble a QasmQobjInstruction

Rückgabetyp: Instruction

broadcast_arguments(qargs, cargs)¶

Validation and handling of the arguments and its relationship.

For example, cx([q[0],q[1]], q[2]) means cx(q[0], q[2]); cx(q[1], q[2]). This method yields the arguments in the right grouping. In the given example:

in: [[q[0],q[1]], q[2]],[]
outs: [q[0], q[2]], []
      [q[1], q[2]], []

The general broadcasting rules are:

If len(qargs) == 1:
```
[q[0], q[1]] -> [q[0]],[q[1]]
```

If len(qargs) == 2:

[[q[0], q[1]], [r[0], r[1]]] -> [q[0], r[0]], [q[1], r[1]]
[[q[0]], [r[0], r[1]]]       -> [q[0], r[0]], [q[0], r[1]]
[[q[0], q[1]], [r[0]]]       -> [q[0], r[0]], [q[1], r[0]]

If len(qargs) >= 3:

[q[0], q[1]], [r[0], r[1]],  ...] -> [q[0], r[0], ...], [q[1], r[1], ...]

Parameter

qargs (List) – List of quantum bit arguments.
cargs (List) – List of classical bit arguments.

Rückgabetyp

Tuple[List, List]

Rückgabe

A tuple with single arguments.

Verursacht

CircuitError – If the input is not valid. For example, the number of arguments does not match the gate expectation.

c_if(classical, val)¶: Add classical condition on register classical and value val.

control(num_ctrl_qubits=1, label=None, ctrl_state=None)¶

Return controlled version of gate. See ControlledGate for usage.

Parameter

num_ctrl_qubits (Optional[int]) – number of controls to add to gate (default=1)
label (Optional[str]) – optional gate label
ctrl_state (Union[int, str, None]) – The control state in decimal or as a bitstring (e.g. ‚111‘). If None, use 2**num_ctrl_qubits-1.

Rückgabe

Controlled version of gate. This default algorithm uses num_ctrl_qubits-1 ancillae qubits so returns a gate of size num_qubits + 2*num_ctrl_qubits - 1.

Rückgabetyp

qiskit.circuit.ControlledGate

Verursacht

QiskitError – unrecognized mode or invalid ctrl_state

copy(name=None)¶

Copy of the instruction.

Parameter

name (str) – name to be given to the copied circuit, if None then the name stays the same.

Rückgabe

a copy of the current instruction, with the name: updated if it was provided

Rückgabetyp

qiskit.circuit.Instruction

property decompositions¶: Get the decompositions of the instruction from the SessionEquivalenceLibrary.

property definition¶: Return definition in terms of other basic gates.

property duration¶: Get the duration.

classmethod from_dimacs_file(filename)[Quellcode]¶

Create a BooleanExpression from the string in the DIMACS format. :type filename: str :param filename: A file in DIMACS format.

Rückgabe

A gate for the input string

Rückgabetyp

BooleanExpression

Verursacht

MissingOptionalLibraryError – If tweedledum is not installed. Tweedledum is required.
FileNotFoundError – If filename is not found.

inverse()¶

Invert this instruction.

If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted.

Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.)

Rückgabe: a fresh instruction for the inverse
Rückgabetyp: qiskit.circuit.Instruction
Verursacht: CircuitError – if the instruction is not composite and an inverse has not been implemented for it.

is_parameterized()¶: Return True .IFF. instruction is parameterized else False

property label¶

Return gate label

Rückgabetyp: str

mirror()¶

DEPRECATED: use instruction.reverse_ops().

Rückgabe

a new instruction with sub-instructions: reversed.

Rückgabetyp

qiskit.circuit.Instruction

property params¶: return instruction params.

power(exponent)¶

Creates a unitary gate as gate^exponent.

Parameter: exponent (float) – Gate^exponent
Rückgabe: To which to_matrix is self.to_matrix^exponent.
Rückgabetyp: qiskit.extensions.UnitaryGate
Verursacht: CircuitError – If Gate is not unitary

qasm()¶

Return a default OpenQASM string for the instruction.

Derived instructions may override this to print in a different format (e.g. measure q[0] -> c[0];).

repeat(n)¶

Creates an instruction with gate repeated n amount of times.

Parameter: n (int) – Number of times to repeat the instruction
Rückgabe: Containing the definition.
Rückgabetyp: qiskit.circuit.Instruction
Verursacht: CircuitError – If n < 1.

reverse_ops()¶

For a composite instruction, reverse the order of sub-instructions.

This is done by recursively reversing all sub-instructions. It does not invert any gate.

Rückgabe

a new instruction with: sub-instructions reversed.

Rückgabetyp

qiskit.circuit.Instruction

simulate(bitstring)[Quellcode]¶

Evaluate the expression on a bitstring.

This evaluation is done classically.

Parameter: bitstring (str) – The bitstring for which to evaluate.
Rückgabe: result of the evaluation.
Rückgabetyp: bool

soft_compare(other)¶

Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.

Parameter: other (instruction) – other instruction.
Rückgabe: are self and other equal up to parameter expressions.
Rückgabetyp: bool

synth(registerless=True, synthesizer=None)[Quellcode]¶

Synthesis the logic network into a QuantumCircuit.

Parameter

registerless (bool) – Default True. If False uses the parameter names to create registers with those names. Otherwise, creates a circuit with a flat quantum register.
synthesizer (Optional[Callable[[BooleanExpression], QuantumCircuit]]) – A callable that takes self and returns a Tweedledum circuit.

Rückgabe

A circuit implementing the logic network.

Rückgabetyp

QuantumCircuit

to_matrix()¶

Return a Numpy.array for the gate unitary matrix.

Rückgabe: if the Gate subclass has a matrix definition.
Rückgabetyp: np.ndarray
Verursacht: CircuitError – If a Gate subclass does not implement this method an exception will be raised when this base class method is called.

property unit¶: Get the time unit of duration.

validate_parameter(parameter)¶: Gate parameters should be int, float, or ParameterExpression