surface_sim.layouts.Layout.get_neighbors

layouts.Layout.get_neighbors(qubits, *, as_pairs=False, **conds)

Returns the list of qubit labels, neighboring specific qubits that meet a set of conditions.

Parameters:

qubits

The qubit labels, whose neighbors are being considered.

**conds

Conditions that the neighbors and/or the connections (or edges) need to satisfy.

Returns:

end_notes

The list of qubit label, neighboring qubit, that meet the conditions.

Notes

The order that the qubits appear in is defined during the initialization of the layout and remains fixed.

The conditions conds are the keyward arguments that specify the value (object) that each parameter label (str) needs to take.