Skip to main content

ImportanceSampler

Struct ImportanceSampler 

Source
pub struct ImportanceSampler {
    pub num_samples: usize,
    pub self_normalize: bool,
}
Expand description

Importance sampling for approximate inference.

Importance sampling draws samples from a proposal distribution q(x) and weights them by p(x)/q(x) to estimate expectations under p(x).

§Example

use tensorlogic_quantrs_hooks::{FactorGraph, ImportanceSampler, ProposalDistribution};

let mut graph = FactorGraph::new();
graph.add_variable_with_card("x".to_string(), "Binary".to_string(), 2);

let sampler = ImportanceSampler::new(1000);
let result = sampler.run(&graph, ProposalDistribution::Uniform);

Fields§

§num_samples: usize

Number of samples to draw

§self_normalize: bool

Whether to use self-normalized importance sampling

Implementations§

Source§

impl ImportanceSampler

Source

pub fn new(num_samples: usize) -> Self

Create a new importance sampler with specified number of samples.

Source

pub fn with_self_normalize(self, self_normalize: bool) -> Self

Set whether to use self-normalized importance sampling.

Source

pub fn run( &self, graph: &FactorGraph, proposal: ProposalDistribution, ) -> Result<HashMap<String, ArrayD<f64>>>

Run importance sampling to approximate marginals.

Source

pub fn draw_weighted_samples( &self, graph: &FactorGraph, proposal: &ProposalDistribution, ) -> Result<Vec<WeightedSample>>

Draw weighted samples from the proposal distribution.

Source

pub fn get_weighted_samples( &self, graph: &FactorGraph, proposal: &ProposalDistribution, ) -> Result<Vec<WeightedSample>>

Get all weighted samples for analysis.

Source

pub fn effective_sample_size(samples: &[WeightedSample]) -> f64

Compute the effective sample size (ESS).

ESS measures the efficiency of importance sampling. Higher ESS indicates better proposal distribution.

Source

pub fn weight_coefficient_of_variation(samples: &[WeightedSample]) -> f64

Compute the coefficient of variation of weights.

Source

pub fn resample(samples: &[WeightedSample]) -> Vec<WeightedSample>

Resample particles based on their weights (for particle filtering).

Trait Implementations§

Source§

impl Default for ImportanceSampler

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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