Skip to main content

SdeOptions

Struct SdeOptions 

Source
pub struct SdeOptions<S: Scalar> {
    pub dt: S,
    pub rtol: S,
    pub atol: S,
    pub dt_max: S,
    pub dt_min: S,
    pub max_steps: usize,
    pub save_trajectory: bool,
    pub seed: Option<u64>,
}
Expand description

Options for SDE solvers.

Divergence from numra_ode::SolverOptions (per Foundation Spec §2.5): SDE solvers carry stochastic noise, so step size also controls the Wiener increment δW ~ N(0, h) — not just truncation accuracy. The fixed dt field is distinguished from rtol / atol (used by adaptive SRA-family methods) rather than collapsed onto a shared h0 / h_max, because the noise-discretisation interpretation matters at every step. seed: Option<u64> is required for reproducibility — deterministic ODE configuration has no analog. save_trajectory: bool toggles trajectory-vs-final-only collection for Monte Carlo workloads where intermediate states aren’t kept. See docs/architecture/foundation-specification.md §2.5.

Fields§

§dt: S

Fixed time step (for non-adaptive methods)

§rtol: S

Relative tolerance (for adaptive methods)

§atol: S

Absolute tolerance (for adaptive methods)

§dt_max: S

Maximum time step

§dt_min: S

Minimum time step

§max_steps: usize

Maximum number of steps

§save_trajectory: bool

Save solution at all steps (vs. just final)

§seed: Option<u64>

Random seed (None = use system entropy)

Implementations§

Source§

impl<S: Scalar> SdeOptions<S>

Source

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

Set fixed time step.

Source

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

Set relative tolerance.

Source

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

Set absolute tolerance.

Source

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

Set maximum time step.

Source

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

Set random seed for reproducibility.

Source

pub fn save_trajectory(self, save: bool) -> Self

Enable/disable trajectory saving.

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> SdeOptions<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 SdeOptions<S>

Source§

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

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

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

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

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

§

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

§

impl<S> Send for SdeOptions<S>

§

impl<S> Sync for SdeOptions<S>

§

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

§

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

§

impl<S> UnwindSafe for SdeOptions<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