Qiskit / qiskit
90%
main: 89%

Repo Added 21 Aug 2023 02:51PM UTC

Committed 14 Aug 2024 04:20PM UTC coverage: 89.938% (+0.009%) from 89.929%

Committed by

Commit Message

Allow immutable borrow to access `QuantumCircuit.parameters` (#12918)

* Allow immutable borrow to access `QuantumCircuit.parameters`

`QuantumCircuit.parameters` is logically a read-only operation on
`QuantumCircuit`.  For efficiency in multiple calls to
`assign_parameters`, we actually cache the sort order of the internal
`ParameterTable` on access.  This is purely a caching effect, and should
not leak out to users.

The previous implementation took a Rust-space mutable borrow out in
order to (potentially) mutate the cache.  This caused problems if
multiple Python threads attempted to call `assign_parameters`
simultaneously; it was possible for one thread to give up the GIL during
its initial call to `CircuitData::copy` (so an immutable borrow was
still live), allowing another thread to continue on to the getter
`CircuitData::get_parameters`, which required a mutable borrow, which
failed due to the paused thread in `copy`.

This moves the cache into a `RefCell`, allowing the parameter getters to
take an immutable borrow as the receiver.  We now write the cache out
only if we *can* take the mutable borrow out necessary.  This can mean
that other threads will have to repeat the work of re-sorting the
parameters, because their borrows were blocking the saving of the cache,
but this will not cause failures.

The methods on `ParameterTable` that invalidate the cache all require a
mutable borrow on the table itself.  This makes it impossible for an
immutable borrow to exist simultaneously on the cache, so these methods
should always succeed to acquire the cache lock to invalidate it.

* Use `RefCell::get_mut` where possible

In several cases, the previous code was using the runtime-checked
`RefCell::borrow_mut` in locations that can be statically proven to be
safe to take the mutable reference.  Using the correct function for this
makes the logic clearer (as well as technically removing a small amount
of runtime overhead).

* Use `OnceCell` instead of `Re... (continued)

50 of 53 new or added lines in 2 files covered. (94.34%)

2 existing lines in 1 file now uncovered.

66734 of 74200 relevant lines covered (89.94%)

229086.68 hits per line

74200 RELEVANT LINES 66734 COVERED LINES

229086.68 HITS PER LINE

Builds	Branch	Commit	Type	Ran	Committer	Via	Coverage
10391267961	mergify/bp/stable/1.2/pr-12918	Allow immutable borrow to access `QuantumCircuit.parameters` (#12918) * Allow immutable borrow to access `QuantumCircuit.parameters` `QuantumCircuit.parameters` is logically a read-only operation on `QuantumCircuit`. For efficiency in multiple ...	Pull #12958	14 Aug 2024 04:39PM UTC	mergify[bot]	github	89.94

Qiskit / qiskit
90%
main: 89%

Qiskit / qiskit 90% main: 89%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

CHANGE BRANCH x

Relevant lines Covered

Source Files on mergify/bp/stable/1.2/pr-12918

Recent builds

Qiskit / qiskit
90%
main: 89%

README BADGES
x

CHANGE BRANCH
x