Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

OR

OR(num_variable_qubits, flags=None, mcx_mode='noancilla') GitHub(opens in a new tab)

Bases: qiskit.circuit.quantumcircuit.QuantumCircuit

A circuit implementing the logical OR operation on a number of qubits.

For the OR operation the state 1|1\rangle is interpreted as True. The result qubit is flipped, if the state of any variable qubit is True. The OR is implemented using a multi-open-controlled X gate (i.e. flips if the state is 0|0\rangle) and applying an X gate on the result qubit. Using a list of flags, qubits can be skipped or negated.

The OR gate without special flags:

Using flags we can negate qubits or skip them. For instance, if we have 5 qubits and want to return True if the first qubit is False or one of the last two are True we use the flags [-1, 0, 0, 1, 1].

Create a new logical OR circuit.

Parameters

  • num_variable_qubits (int) – The qubits of which the OR is computed. The result will be written into an additional result qubit.
  • flags (Optional[List[int]]) – A list of +1/0/-1 marking negations or omissions of qubits.
  • mcx_mode (str) – The mode to be used to implement the multi-controlled X gate.

Attributes

ancillas

Returns a list of ancilla bits in the order that the registers were added.

Return type

List[AncillaQubit]

calibrations

Return calibration dictionary.

The custom pulse definition of a given gate is of the form

{‘gate_name’: {(qubits, params): schedule}}

Return type

dict

clbits

Returns a list of classical bits in the order that the registers were added.

Return type

List[Clbit]

data

Return the circuit data (instructions and context).

Returns

a list-like object containing the tuples for the circuit’s data.

Each tuple is in the format (instruction, qargs, cargs), where instruction is an Instruction (or subclass) object, qargs is a list of Qubit objects, and cargs is a list of Clbit objects.

Return type

QuantumCircuitData

extension_lib

= 'include "qelib1.inc";'

global_phase

Return the global phase of the circuit in radians.

Return type

Union[ParameterExpression, float]

= 'OPENQASM 2.0;'

instances

= 9

metadata

The user provided metadata associated with the circuit

The metadata for the circuit is a user provided dict of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit.

Return type

dict

num_ancillas

Return the number of ancilla qubits.

Return type

int

num_clbits

Return number of classical bits.

Return type

int

num_parameters

Convenience function to get the number of parameter objects in the circuit.

Return type

int

num_qubits

Return number of qubits.

Return type

int

parameters

Convenience function to get the parameters defined in the parameter table.

Return type

ParameterView

prefix

= 'circuit'

qubits

Returns a list of quantum bits in the order that the registers were added.

Return type

List[Qubit]

Was this page helpful?