qiskit.circuit.classicalfunction.BooleanExpression

class BooleanExpression(expression, name=None)

The Boolean Expression gate.

パラメータ

• expression (str) – The logical expression string.

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

例外

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

__init__(expression, name=None)

パラメータ

• expression (str) – The logical expression string.

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

例外

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

戻り値の型

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], ...]
  

パラメータ

• qargs (List) – List of quantum bit arguments.

• cargs (List) – List of classical bit arguments.

戻り値の型

Tuple[List, List]

戻り値

A tuple with single arguments.

例外

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.

パラメータ

• 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.

戻り値

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.

戻り値の型

qiskit.circuit.ControlledGate

例外

QiskitError – unrecognized mode or invalid ctrl_state

copy(name=None)

Copy of the instruction.

パラメータ

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

戻り値

a copy of the current instruction, with the name

updated if it was provided

戻り値の型

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)

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

戻り値

A gate for the input string

戻り値の型

BooleanExpression

例外

• 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.)

戻り値

a fresh instruction for the inverse

戻り値の型

qiskit.circuit.Instruction

例外

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

戻り値の型

str

mirror()

DEPRECATED: use instruction.reverse_ops().

戻り値

a new instruction with sub-instructions

reversed.

戻り値の型

qiskit.circuit.Instruction

property params

return instruction params.

power(exponent)

Creates a unitary gate as gate^exponent.

パラメータ

exponent (float) – Gate^exponent

戻り値

To which to_matrix is self.to_matrix^exponent.

戻り値の型

qiskit.extensions.UnitaryGate

例外

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.

パラメータ

n (int) – Number of times to repeat the instruction

戻り値

Containing the definition.

戻り値の型

qiskit.circuit.Instruction

例外

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.

戻り値

a new instruction with

sub-instructions reversed.

戻り値の型

qiskit.circuit.Instruction

simulate(bitstring)

Evaluate the expression on a bitstring.

This evaluation is done classically.

パラメータ

bitstring (str) – The bitstring for which to evaluate.

戻り値

result of the evaluation.

戻り値の型

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.

パラメータ

other (instruction) – other instruction.

戻り値

are self and other equal up to parameter expressions.

戻り値の型

bool

synth(registerless=True, synthesizer=None)

Synthesis the logic network into a QuantumCircuit.

パラメータ

• 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.

戻り値

A circuit implementing the logic network.

戻り値の型

QuantumCircuit

to_matrix()

Return a Numpy.array for the gate unitary matrix.

戻り値

if the Gate subclass has a matrix definition.

戻り値の型

np.ndarray

例外

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