Circuit.is_cycle_unoccupied

Circuit.is_cycle_unoccupied(cycle_index, location)[source]

Check if a cycle is unoccupied for all qudits in location.

Parameters:

cycle_index (int) – The cycle to check.
location (CircuitLocationLike) – The set of qudits to check.

Returns:

True if the cycle_index at location is unoccupied.

Return type:

bool

Raises:

IndexError – If cycle_index is out of range.

Examples

>>> from bqskit.ir.gates import HGate, XGate, ZGate
>>> circuit = Circuit(2)
>>> circuit.append_gate(HGate(), [0])
>>> circuit.append_gate(XGate(), [0])
>>> circuit.append_gate(ZGate(), [1])
>>> circuit.is_cycle_unoccupied(0, [0])
False
>>> circuit.is_cycle_unoccupied(1, [1])
True