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

QuantumRegister

QuantumRegister(size=None, name=None, bits=None)GitHub(opens in a new tab)

Bases: qiskit.circuit.register.Register

Implement a quantum register.

Create a new generic register.

Either the size or the bits argument must be provided. If size is not None, the register will be pre-populated with bits of the correct type.

Parameters

  • size (int) – Optional. The number of bits to include in the register.
  • name (str) – Optional. The name of the register. If not provided, a unique name will be auto-generated from the register type.
  • bits (list[Bit]) – Optional. A list of Bit() instances to be used to populate the register.

Raises

  • CircuitError – if both the size and bits arguments are provided, or if neither are.
  • CircuitError – if size is not valid.
  • CircuitError – if name is not a valid name according to the OpenQASM spec.
  • CircuitError – if bits contained duplicated bits.
  • CircuitError – if bits contained bits of an incorrect type.

Methods

index

QuantumRegister.index(bit)

Find the index of the provided bit within this register.

qasm

QuantumRegister.qasm()GitHub(opens in a new tab)

Return OPENQASM string for this register.


Attributes

instances_counter

= count(416)

name

Get the register name.

name_format

prefix

= 'q'

size

Get the register size.

Was this page helpful?