Skip to main content

JumpKernel

Struct JumpKernel 

Source
pub struct JumpKernel<const N: usize> {
    pub dims: [Vec<JumpTransition>; N],
}
Expand description

Per-dimension jump kernel for arbitrary-amplitude jump processes.

Each dimension carries an ordered list of JumpTransition pairs. For a DiscreteJump dimension the kernel is exactly the unit up/down pair [(+1, plus), (-1, minus)]; a Jump dimension may carry any finite set of amplitudes and rates. The finite-difference operator and the BSDE forward step both sum or sample over this kernel.

Fields§

§dims: [Vec<JumpTransition>; N]

Jump transitions for each dimension.

Implementations§

Source§

impl<const N: usize> JumpKernel<N>

Source

pub fn empty() -> Self

Builds an empty jump kernel (no jumps in any dimension).

§Examples
use solver::numeric::finite_difference::discretization::JumpKernel;
let kernel = JumpKernel::<2>::empty();
assert!(kernel.is_empty(0));
assert!(kernel.is_empty(1));
Source

pub fn from_transport(transport: &Transport<N>) -> Self

Builds a jump kernel from a transport bundle, folding each dimension’s plus/minus rates into the unit +1/-1 transitions used by the DiscreteJump convention.

§Examples
use solver::numeric::finite_difference::discretization::{JumpKernel, Transport};
let t = Transport::<2>::new([1.5, 0.0], [0.0, 2.0], 0.0);
let kernel = JumpKernel::from_transport(&t);
assert_eq!(kernel.dims[0][0].amplitude, 1);
assert_eq!(kernel.dims[1][0].amplitude, -1);
Source

pub fn len(&self, dim: usize) -> usize

Number of jump transitions in dim.

§Examples
use solver::numeric::finite_difference::discretization::{JumpKernel, Transport};
let t = Transport::<2>::new([1.5, 0.0], [0.0, 2.0], 0.0);
let kernel = JumpKernel::from_transport(&t);
assert_eq!(kernel.len(0), 1);
assert_eq!(kernel.len(1), 1);
Source

pub fn is_empty(&self, dim: usize) -> bool

Whether a dimension has no jump transitions.

§Examples
use solver::numeric::finite_difference::discretization::{JumpKernel, Transport};
let t = Transport::<2>::new([0.0, 0.0], [2.0, 0.0], 0.0);
let kernel = JumpKernel::from_transport(&t);
assert!(!kernel.is_empty(0));
assert!(kernel.is_empty(1));
Source

pub fn total_rate(&self, dim: usize) -> f64

Total intensity of all transitions in dim.

§Examples
use solver::numeric::finite_difference::discretization::{JumpKernel, Transport};
let t = Transport::<2>::new([1.5, 0.0], [0.0, 2.0], 0.0);
let kernel = JumpKernel::from_transport(&t);
assert_eq!(kernel.total_rate(0), 1.5);
assert_eq!(kernel.total_rate(1), 2.0);

Trait Implementations§

Source§

impl<const N: usize> Clone for JumpKernel<N>

Source§

fn clone(&self) -> JumpKernel<N>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<const N: usize> Debug for JumpKernel<N>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<const N: usize> Default for JumpKernel<N>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<const N: usize> Freeze for JumpKernel<N>

§

impl<const N: usize> RefUnwindSafe for JumpKernel<N>

§

impl<const N: usize> Send for JumpKernel<N>
where [Vec<JumpTransition>; N]: Send,

§

impl<const N: usize> Sync for JumpKernel<N>
where [Vec<JumpTransition>; N]: Sync,

§

impl<const N: usize> Unpin for JumpKernel<N>

§

impl<const N: usize> UnsafeUnpin for JumpKernel<N>

§

impl<const N: usize> UnwindSafe for JumpKernel<N>

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
§

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

§

fn vzip(self) -> V