Skip to main content

SimulationError

Enum SimulationError 

Source
pub enum SimulationError {
Show 17 variants WalkError { reason: String, }, InvalidParameters { reason: String, }, StepError { reason: String, }, InvalidWalkType { expected: &'static str, }, InvalidAutocorrelation { value: Decimal, }, GarchStationarity { alpha: Positive, beta: Positive, }, InvalidCorrelation { rho: Decimal, }, InsufficientHistoricalData { required: usize, found: usize, }, IndexConversion, ExpirationReached, Decimal(DecimalError), Options(OptionsError), Pricing(PricingError), ExpirationDate(ExpirationDateError), PositiveError(PositiveError), NonFinite { context: &'static str, value: f64, }, Volatility(Box<VolatilityError>),
}
Expand description

Error type for simulation operations.

This enum represents the various errors that can occur during simulation operations, such as random walks, Monte Carlo simulations, and other stochastic processes.

Variants§

§

WalkError

Error during walk generation.

Fields

§reason: String

Detailed reason for the walk generation failure

§

InvalidParameters

Error due to invalid simulation parameters.

Fields

§reason: String

Detailed reason for the invalid parameters

§

StepError

Error during step calculation.

Fields

§reason: String

Detailed reason for the step calculation failure

§

InvalidWalkType

The walk type in the parameters does not match the generator being invoked.

Raised from inside each WalkTypeAble implementation when the supplied walk_type discriminator is not the one expected by the method.

Fields

§expected: &'static str

Human-readable description of the expected walk type, e.g. "Brownian".

§

InvalidAutocorrelation

Autocorrelation parameter is outside the required [-1, 1] interval.

Fields

§value: Decimal

The offending autocorrelation value.

§

GarchStationarity

GARCH stationarity constraint alpha + beta < 1 violated.

Fields

§alpha: Positive

The GARCH alpha coefficient.

§beta: Positive

The GARCH beta coefficient.

§

InvalidCorrelation

Heston correlation rho is outside the valid [-1, 1] interval.

Fields

§rho: Decimal

The offending correlation value.

§

InsufficientHistoricalData

Not enough historical price observations to generate the requested walk.

Fields

§required: usize

Minimum number of observations required.

§found: usize

Number of observations actually available.

§

IndexConversion

Failed to convert the x-axis step index into a Decimal.

§

ExpirationReached

The simulated expiration has already been reached, no further steps can be generated.

§

Decimal(DecimalError)

Decimal arithmetic error surfaced from pricing or Greek calculations.

§

Options(OptionsError)

Options domain error surfaced during simulation.

§

Pricing(PricingError)

Pricing error surfaced during simulation.

§

ExpirationDate(ExpirationDateError)

Expiration-date conversion error.

§

PositiveError(PositiveError)

Positive value errors

§

NonFinite

A simulation kernel produced a non-finite f64 value (NaN / ±∞) at an f64 → Decimal boundary.

Emitted by Brownian / geometric Brownian motion, Heston, telegraph, and general random-walk path generators whenever an intermediate f64 would otherwise be silently cast into Decimal::ZERO. context is a static call-site tag following the same convention as optionstratlib_core::error::DecimalError::Overflow.

Fields

§context: &'static str

Static tag identifying the kernel and step that produced the non-finite value.

§value: f64

The offending f64 value (NaN, +∞, or -∞).

§

Volatility(Box<VolatilityError>)

A volatility failure raised by the pricing capability this layer depends on. Boxed because VolatilityError is the larger enum.

Implementations§

Source§

impl SimulationError

Source

pub fn walk_error(reason: &str) -> Self

Creates a new WalkError variant.

§Arguments
  • reason - Detailed reason for the walk generation failure
Source

pub fn invalid_parameters(reason: &str) -> Self

Creates a new InvalidParameters variant.

§Arguments
  • reason - Detailed reason for the invalid parameters
Source

pub fn step_error(reason: &str) -> Self

Creates a new StepError variant.

§Arguments
  • reason - Detailed reason for the step calculation failure
Source

pub fn non_finite(context: &'static str, value: f64) -> Self

Creates a SimulationError::NonFinite from a static call-site tag and the offending f64 value.

Trait Implementations§

Source§

impl Debug for SimulationError

Source§

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

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

impl Display for SimulationError

Source§

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

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

impl Error for SimulationError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<DecimalError> for SimulationError

Source§

fn from(source: DecimalError) -> Self

Converts to this type from the input type.
Source§

impl From<ExpirationDateError> for SimulationError

Source§

fn from(source: ExpirationDateError) -> Self

Converts to this type from the input type.
Source§

impl From<OptionsError> for SimulationError

Source§

fn from(source: OptionsError) -> Self

Converts to this type from the input type.
Source§

impl From<PositiveError> for SimulationError

Source§

fn from(source: PositiveError) -> Self

Converts to this type from the input type.
Source§

impl From<PricingError> for SimulationError

Source§

fn from(source: PricingError) -> Self

Converts to this type from the input type.
Source§

impl From<VolatilityError> for SimulationError

Source§

fn from(err: VolatilityError) -> Self

Converts to this type from the input type.

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more