Struct CoxIngersollRoss 

pub struct CoxIngersollRoss {
    pub kappa: f64,
    pub theta: f64,
    pub sigma: f64,
    /* private fields */
}

Cox-Ingersoll-Ross mean-reverting square-root process.

$$dv_t = kappa * (theta - v_t) * dt + sigma * sqrt(v_t) * dW_t$$

Fields

kappa: f64

theta: f64

sigma: f64

Implementations

impl CoxIngersollRoss

pub fn new(kappa: f64, theta: f64, sigma: f64, initial_value: f64) -> Self

pub fn value(&self) -> f64

pub fn expected_value(&self, t: f64) -> f64

Closed-form expected value.

pub fn variance(&self, t: f64) -> f64

Closed-form variance.

Trait Implementations

impl Clone for CoxIngersollRoss

fn clone(&self) -> CoxIngersollRoss

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Simulatable for CoxIngersollRoss

type Output = f64

The type emitted at each step (e.g. f64 for GBM, BookSnapshot for L3).

fn dim(&self) -> usize

Dimensionality of the Brownian driver. Used by the runner to pre-generate the correct number of random normals per step. GBM is 1, Heston is 2, etc.

fn step(&mut self, dt: f64, dw: &[f64], _rng: &mut impl Rng) -> f64

Advance the model by one step of size dt.

fn current(&self) -> f64

The current state snapshot. Called once before simulation starts.

impl StochasticProcess for CoxIngersollRoss

type State = f64

type Diffusion = f64

type BrownianIncrement = f64

fn drift(&self, x: &f64, _t: f64) -> f64

fn diffusion(&self, x: &f64, _t: f64) -> f64

fn jump_size<R: Rng + ?Sized>(&self, _x: &f64, _t: f64, _rng: &mut R) -> f64

fn expected_value(&self, x0: &f64, t: f64) -> f64

fn variance(&self, x0: &f64, t: f64) -> f64

fn step<R: Rng + ?Sized>( &self, x: &f64, t: f64, dt: f64, dw: &f64, _rng: &mut R, ) -> f64

fn generate_increment<R: Rng + ?Sized>(&self, rng: &mut R, dt: f64) -> f64

fn simulate<R: Rng + ?Sized>( &self, x0: f64, t0: f64, t_end: f64, dt: f64, rng: &mut R, ) -> Vec<(f64, f64)>

fn jump_intensity(&self, _x: &Self::State, _t: f64) -> f64

fn simulate_paths( &self, x0: Self::State, t0: f64, t_end: f64, dt: f64, num_paths: usize, ) -> Vec<Vec<(f64, Self::State)>>

where Self: Sync, Self::State: Send + Sync + Clone,