Skip to main content

SpdeOptions

Struct SpdeOptions 

Source
pub struct SpdeOptions<S: Scalar> {
    pub dt: S,
    pub n_output: usize,
    pub method: SpdeMethod,
    pub seed: Option<u64>,
    pub adaptive: bool,
    pub rtol: S,
    pub atol: S,
    pub dt_min: S,
    pub dt_max: S,
}
Expand description

Options for SPDE solver.

Divergence from numra_ode::SolverOptions (per Foundation Spec §2.5): SPDE solvers carry both stochastic noise (like SDE — Wiener time control, seed) and an explicit method selector (SpdeMethod, EulerMaruyama | Milstein). The method selector is unusual: numra-ode solvers dispatch at the type level (DoPri5::solve(...), Tsit5::solve(...)); SPDE collapses to a single solve entry that branches on the enum because noise-discretisation logic is shared across methods. n_output discretises sampled-output count rather than SolverOptions::t_eval-style explicit time grid — appropriate for stochastic workloads where exact output times matter less than density. adaptive: bool gates between fixed-step EM (default) and adaptive variants. See docs/architecture/foundation-specification.md §2.5.

Fields§

§dt: S

Time step

§n_output: usize

Number of output time points

§method: SpdeMethod

SDE method

§seed: Option<u64>

Random seed

§adaptive: bool

Enable adaptive time stepping

§rtol: S

Relative tolerance for adaptive stepping

§atol: S

Absolute tolerance for adaptive stepping

§dt_min: S

Minimum time step for adaptive stepping

§dt_max: S

Maximum time step for adaptive stepping

Implementations§

Source§

impl<S: Scalar> SpdeOptions<S>

Source

pub fn dt(self, dt: S) -> Self

Set time step.

Source

pub fn n_output(self, n: usize) -> Self

Set number of output points.

Source

pub fn method(self, method: SpdeMethod) -> Self

Set SDE method.

Source

pub fn seed(self, seed: u64) -> Self

Set random seed.

Source

pub fn adaptive(self, enable: bool) -> Self

Enable/disable adaptive time stepping.

Source

pub fn rtol(self, tol: S) -> Self

Set relative tolerance for adaptive stepping.

Source

pub fn atol(self, tol: S) -> Self

Set absolute tolerance for adaptive stepping.

Source

pub fn dt_min(self, dt: S) -> Self

Set minimum time step for adaptive stepping.

Source

pub fn dt_max(self, dt: S) -> Self

Set maximum time step for adaptive stepping.

Trait Implementations§

Source§

impl<S: Clone + Scalar> Clone for SpdeOptions<S>

Source§

fn clone(&self) -> SpdeOptions<S>

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<S: Debug + Scalar> Debug for SpdeOptions<S>

Source§

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

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

impl<S: Scalar> Default for SpdeOptions<S>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<S> Freeze for SpdeOptions<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for SpdeOptions<S>
where S: RefUnwindSafe,

§

impl<S> Send for SpdeOptions<S>

§

impl<S> Sync for SpdeOptions<S>

§

impl<S> Unpin for SpdeOptions<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for SpdeOptions<S>
where S: UnsafeUnpin,

§

impl<S> UnwindSafe for SpdeOptions<S>
where S: UnwindSafe,

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> 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
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> 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 = 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