Skip to main content

SolverConfig

Struct SolverConfig 

Source
#[non_exhaustive]
pub struct SolverConfig { pub nr_max_iterations: u32, pub price_tolerance: f64, pub iv_tolerance: f64, pub vega_floor: f64, pub iv_min: f64, pub iv_max: f64, pub brent_max_iterations: u32, pub near_expiry_cutoff_hours: f64, }
Expand description

Configuration for the implied-volatility solver.

Construct via SolverConfig::default for sensible defaults, or via SolverConfig::builder for selective overrides:

use black_76::SolverConfig;

let cfg = SolverConfig::builder()
    .iv_min(0.001)
    .iv_max(10.0)
    .price_tolerance(1e-10)
    .build();
assert_eq!(cfg.iv_max, 10.0);

New fields may be added in future minor versions.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§nr_max_iterations: u32

Maximum Newton-Raphson iterations before switching to Brent.

§price_tolerance: f64

Price residual reported by the solver, and the secondary price sanity threshold for the bracket-collapse path. Convergence itself is decided in volatility space (see iv_tolerance).

§iv_tolerance: f64

Volatility-space convergence tolerance. The solver converges when the Newton step (or the Brent bracket width) in sigma falls below this value. Deciding convergence in sigma-space behaves the same whether the forward is 1.0 or 100_000.0, unlike an absolute price tolerance.

§vega_floor: f64

Minimum vega to continue Newton-Raphson iterations. Below this, the solver falls back to Brent’s method to avoid the explosive Newton step (price - target) / vega as vega -> 0 (deep OTM, near expiry).

§iv_min: f64

Minimum allowed IV (annualized). The solver clamps every NR step to [iv_min, iv_max]. Default 0.01 (1%).

§iv_max: f64

Maximum allowed IV (annualized). Default 5.0 (500%).

§brent_max_iterations: u32

Maximum Brent’s-method iterations.

§near_expiry_cutoff_hours: f64

Near-expiry cutoff in hours. Below this, the solver bypasses NR/Brent and returns iv = NaN, converged = false, status = SolverStatus::NearExpiryIntrinsic; price the option intrinsically yourself rather than implying a volatility.

Implementations§

Source§

impl SolverConfig

Source

pub fn builder() -> SolverConfigBuilder

Returns a fresh builder seeded with the default config.

Trait Implementations§

Source§

impl Clone for SolverConfig

Source§

fn clone(&self) -> SolverConfig

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 Debug for SolverConfig

Source§

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

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

impl Default for SolverConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for SolverConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for SolverConfig

Source§

fn eq(&self, other: &SolverConfig) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for SolverConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SolverConfig

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> 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> 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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,