pub struct ZNEMitigation { /* private fields */ }Expand description
Zero-noise extrapolation (ZNE) mitigation helper.
This mirrors the Python ZNEMitigation data model and currently implements
only circuit folding.
§Example
use cqlib_core::circuit::gate::{Instruction, StandardGate};
use cqlib_core::circuit::{Circuit, Qubit};
use cqlib_core::error_mitigation::ZNEMitigation;
let q0 = Qubit::new(0);
let q1 = Qubit::new(1);
let mut circuit = Circuit::new(2);
circuit.h(q0).unwrap();
circuit.cx(q0, q1).unwrap();
// Build ZNE with fold levels [0, 1, 2], noise factors [1, 3, 5].
let zne = ZNEMitigation::new(circuit, vec![0, 1, 2]);
// Global folding for each level.
let folded_all = zne.fold_circuits(None).unwrap();
assert_eq!(folded_all.len(), 3);
// Selective folding for H only.
let folded_h_only = zne
.fold_circuits(Some(&[Instruction::Standard(StandardGate::H)]))
.unwrap();
assert_eq!(folded_h_only.len(), 3);Implementations§
Source§impl ZNEMitigation
impl ZNEMitigation
Sourcepub fn new(circuit: Circuit, fold_levels: Vec<i32>) -> Self
pub fn new(circuit: Circuit, fold_levels: Vec<i32>) -> Self
Creates a new ZNE mitigation helper.
noise_factors follow the Python implementation: 2 * level + 1.
Sourcepub fn fold_levels(&self) -> &[i32]
pub fn fold_levels(&self) -> &[i32]
Returns configured fold levels.
Sourcepub fn noise_factors(&self) -> &[i32]
pub fn noise_factors(&self) -> &[i32]
Returns noise factors corresponding to fold levels.
Each factor is 2 * level + 1 due to unitary folding.
Sourcepub fn fold_circuits(
&self,
gate_set: Option<&[Instruction]>,
) -> Result<Vec<Circuit>, CircuitError>
pub fn fold_circuits( &self, gate_set: Option<&[Instruction]>, ) -> Result<Vec<Circuit>, CircuitError>
Fold the circuit for each configured level using unitary folding.
If gate_set is None, this performs global folding:
U -> U (U^† U)^level.
If gate_set is provided, only operations whose instruction name matches
one of the instruction names in gate_set are folded.
Sourcepub fn run_em_sequence(
&self,
gate_set: Option<&[Instruction]>,
hamiltonian: &Hamiltonian,
estimator: &Estimator<'_>,
) -> Result<Vec<f64>, ErrorMitigationError>
pub fn run_em_sequence( &self, gate_set: Option<&[Instruction]>, hamiltonian: &Hamiltonian, estimator: &Estimator<'_>, ) -> Result<Vec<f64>, ErrorMitigationError>
Run the error-mitigation sequence and return expectation-value estimates.
This method folds the circuit at each configured level and computes one expectation value per folded circuit.
gate_set: optional selective gate set for folding.Nonemeans global folding.hamiltonian: aqis::Hamiltoniandescribing the observable to estimate.estimator: a shared estimator that receives the folded circuit,Some(hamiltonian), and an optional shot count.run_em_sequencecurrently passesNonefor the shot count.
Sourcepub fn run_em_sequence_with_shots(
&self,
gate_set: Option<&[Instruction]>,
hamiltonian: &Hamiltonian,
shots: Option<usize>,
estimator: &Estimator<'_>,
) -> Result<Vec<f64>, ErrorMitigationError>
pub fn run_em_sequence_with_shots( &self, gate_set: Option<&[Instruction]>, hamiltonian: &Hamiltonian, shots: Option<usize>, estimator: &Estimator<'_>, ) -> Result<Vec<f64>, ErrorMitigationError>
Run the error-mitigation sequence with an optional shot count.
Sourcepub fn extrapolate(
&self,
noisy_results: &[f64],
method: ExtrapolateMethod,
degree: usize,
) -> Result<f64, ErrorMitigationError>
pub fn extrapolate( &self, noisy_results: &[f64], method: ExtrapolateMethod, degree: usize, ) -> Result<f64, ErrorMitigationError>
Unified extrapolation API.
method = ExtrapolateMethod::Polynomial: usesdegreeand delegates toZNEMitigation::poly_extrapolate.method = ExtrapolateMethod::Exponential: ignoresdegreeand delegates toZNEMitigation::exp_extrapolate.
Sourcepub fn poly_extrapolate(
&self,
noisy_results: &[f64],
degree: usize,
) -> Result<f64, ErrorMitigationError>
pub fn poly_extrapolate( &self, noisy_results: &[f64], degree: usize, ) -> Result<f64, ErrorMitigationError>
Given the noisy results, extrapolate the expectation value using a polynomial fit.
noisy_results: the noisy results to extrapolate.degree: the degree of the polynomial to use for extrapolation.
Returns the extrapolated expectation value.
Sourcepub fn exp_extrapolate(
&self,
noisy_results: &[f64],
) -> Result<f64, ErrorMitigationError>
pub fn exp_extrapolate( &self, noisy_results: &[f64], ) -> Result<f64, ErrorMitigationError>
Given the noisy results, extrapolate the expectation value using an exponential-decay model:
y(x) = A * exp(-x / tau).
The fit is performed in log-space by linear regression on:
ln(y) = ln(A) + m * x, where m = -1 / tau.
Returns A, which is the extrapolated value at x = 0.
Trait Implementations§
Source§impl Clone for ZNEMitigation
impl Clone for ZNEMitigation
Auto Trait Implementations§
impl Freeze for ZNEMitigation
impl RefUnwindSafe for ZNEMitigation
impl Send for ZNEMitigation
impl Sync for ZNEMitigation
impl Unpin for ZNEMitigation
impl UnsafeUnpin for ZNEMitigation
impl UnwindSafe for ZNEMitigation
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.impl<T, U> Imply<T> for U
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.