Skip to main content

QuantumSampler

Struct QuantumSampler 

Source
pub struct QuantumSampler { /* private fields */ }
Expand description

Shot-based quantum sampler

Implementations§

Source§

impl QuantumSampler

Source

pub fn new(config: SamplingConfig) -> Self

Create new sampler with configuration

Source

pub fn sample_state(&mut self, state: &Array1<Complex64>) -> Result<ShotResult>

Sample measurements from a quantum state

Source

pub fn sample_state_with_noise( &mut self, state: &Array1<Complex64>, noise_model: &dyn NoiseModel, ) -> Result<ShotResult>

Sample measurements from a state with noise

Source

pub fn sample_expectation( &mut self, state: &Array1<Complex64>, observable: &PauliOperatorSum, ) -> Result<ExpectationResult>

Sample expectation value of an observable

Source

pub fn sample_multinomial( &mut self, probabilities: &[f64], n_samples: usize, ) -> Result<Vec<usize>>

Multinomial sampling: draw n_samples i.i.d. samples from a discrete probability distribution.

The result is a count vector of the same length as probabilities, where counts[i] is the number of times outcome i was drawn. Total counts sum to n_samples.

The implementation uses the inverse-CDF (Alias/sequential) method which is O(k · n_samples) in the number of outcomes k, but correct and deterministic given the sampler’s current RNG state.

Source

pub fn importance_sampling( &mut self, target_probs: &[f64], proposal_probs: &[f64], f_values: &[f64], n_samples: usize, ) -> Result<ImportanceSamplingResult>

Importance sampling: estimate the expectation E_p[f] using samples drawn from a proposal distribution q.

Given a target distribution target_probs (unnormalised is fine) and a proposal distribution proposal_probs (must be strictly positive wherever target_probs is non-zero), this method:

  1. Draws n_samples indices from proposal_probs.
  2. Evaluates the function values f_values[i] at each outcome i.
  3. Computes the self-normalised importance-sampling estimator Ê = Σ w̃_i f_i where w̃_i = w_i / Σ w_j and w_i = p_i / q_i.

Returns (estimate, effective_sample_size). The effective sample size (ESS) measures how many i.i.d. samples from target_probs the weighted sample is worth: ESS = (Σ w̃_i)² / Σ w̃_i².

§Errors

Returns an error if the distributions have different lengths, if proposal_probs has a zero entry where target_probs is non-zero, or if either distribution is empty.

Source

pub fn estimate_convergence( &mut self, state: &Array1<Complex64>, observable: &PauliOperatorSum, ) -> Result<ConvergenceResult>

Estimate convergence of sampling

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V