Qiskit / qiskit / 26656001909

88%

Build Type

push

github

Committed by web-flow

Commit Message

Make DAGCircuit rust copy like methods infallible (#16316)

* Make DAGCircuit rust copy like methods infallible

The DAGCircuit copy like methods are inherently infallible. At their
core they are copy the dag state excluding instructions. Copying an
existing field in a data structure can't cause a failure when
constructing the new copy. However these methods were all listed as
fallible. At it's core this is because internally the
`DAGCircuit::add_wire()` method is used internally to add cloned version
of all the `Wire` objects. The add_wire is user facing and is fallible
to detect duplicates and block them from being accidentally added. But in
the context of making a copy we know there are no duplicates because
it is a DAGCircuit object, so the duplicate check on addition already
held.

To fix this discrepancy this adds a new error struct to define a
concrete error condition. The inner error from add_wire was previously
using DAGError::Generic with a custom string. But since DAGError is an
enum it was not clear what the error conditions from the method actually
were. This adds the concrete DuplicateWireError to make it clear there
is only one error type that the method can emit. This makes it clear
that we can only have a duplicate wire error from this method and none
of the other DAGError variants apply. Then once that's clear we remove
the error pass through in the copy methods and switch to expect() to
make it clear that the internal assumption for dismissing the error is
that it is not possible for a valid dag to have duplicate wires so the
sole error condition is not possible.

One small detail is that this unifies the duplicate wire error.
Previously the add_wire method was using the DAGError::generic error
variant presumably to set a custom error message. However there was
already a duplicate wire error variant that was used on other methods.
This unifies the error types because the error condition is the same. It
also updates the existing DAGE... (continued)

Coverage Stats

42 of 50 new or added lines in 11 files covered. (84.0%)

34 existing lines in 3 files now uncovered.

108493 of 123932 relevant lines covered (87.54%)

964732.25 hits per line