Qiskit / qiskit / 11262908548

89%

main: 89%

Build Type

push

github

Committed by web-flow

Commit Message

Add .index() and new() method to Qubit and Clbit (#13284)

* Add .index() and new() method to Qubit and Clbit

The Qubit and Clbit rust newtypes are a u32 that are used to track the
Qubits or Clbits in a circuit. The u32 value represents the index of the
Qubit or Clbit in the circuit and are often used as indices in Vecs or
other structures where the index must be a usize. Accordingly there are
a lot of times we need to convert a Qubit or Clbit object into a usize
and previously the only way to do that was use `.0 as usize` on a given
qubit object. To improve the ergonomics of that pattern this commit adds
two new methods for converting from and to a usize new() and index()
respectively. These are modeled after what petgraph does with it's
NodeIndex type which is a similar pattern (although NodeIndex is generic
over the inner type, although it defaults to u32).

* Use Qubit::new() and Clbit::new() where applicable

* Panic on overflow with new() constructor

This commit changes the behavior of the Qubit::new() and Clbit::new()
constructors so that they panic if a user provides a usize that's too
large for the u32 we store internally. Previously the way it was written
it would just wrap the value to u32::MAX.

Co-authored-by: Kevin Hartman <kevin@hart.mn>

---------

Co-authored-by: Kevin Hartman <kevin@hart.mn>

Run Details

147 of 152 new or added lines in 14 files covered. (96.71%)

10 existing lines in 4 files now uncovered.

73123 of 82474 relevant lines covered (88.66%)

377880.24 hits per line