Skip to main content

MonteCarloEngine

Struct MonteCarloEngine 

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

Monte Carlo engine for stochastic simulation.

Implementations§

Source§

impl MonteCarloEngine

Source

pub const fn new( n_samples: usize, variance_reduction: VarianceReduction, ) -> Self

Create a new Monte Carlo engine.

Source

pub const fn with_samples(n_samples: usize) -> Self

Create engine with default settings.

Source

pub fn run<F>(&self, f: F, rng: &mut SimRng) -> MonteCarloResult
where F: Fn(f64) -> f64,

Run Monte Carlo simulation with a function f: [0,1] -> R.

§Example
use simular::domains::monte_carlo::{MonteCarloEngine, VarianceReduction};
use simular::engine::rng::SimRng;

let engine = MonteCarloEngine::with_samples(10000);
let mut rng = SimRng::new(42);

// Estimate integral of x^2 from 0 to 1 (true value = 1/3)
let result = engine.run(|x| x * x, &mut rng);
assert!((result.estimate - 1.0/3.0).abs() < 0.01);
Source

pub fn run_nd<F>(&self, dim: usize, f: F, rng: &mut SimRng) -> MonteCarloResult
where F: Fn(&[f64]) -> f64,

Run multi-dimensional Monte Carlo.

§Example
use simular::domains::monte_carlo::MonteCarloEngine;
use simular::engine::rng::SimRng;

let engine = MonteCarloEngine::with_samples(10000);
let mut rng = SimRng::new(42);

// Estimate volume of unit sphere in 3D (true value ≈ 4.189)
let result = engine.run_nd(3, |x| {
    let r2 = x.iter().map(|&xi| xi * xi).sum::<f64>();
    if r2 <= 1.0 { 8.0 } else { 0.0 } // 8 = 2^3 for [-1,1]^3 domain
}, &mut rng);
Source

pub const fn n_samples(&self) -> usize

Get configured sample count.

Trait Implementations§

Source§

impl Debug for MonteCarloEngine

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. 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> 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<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