Struct SolverResult 

#[non_exhaustive]
pub struct SolverResult {
    pub iv: f64,
    pub method: SolverMethod,
    pub iterations: u32,
    pub converged: bool,
    pub status: SolverStatus,
    pub residual: f64,
}

Result of an iv_solver::solve_iv attempt.

Check converged (or status) before consuming iv. Whenever the solver does not converge, iv is f64::NAN and status explains why. converged is exactly status == SolverStatus::Converged.

New fields may be added in future minor versions; construct via the solver, not via field initializers.

Fields (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.

iv: f64

Solved implied volatility (annualized). f64::NAN unless status is SolverStatus::Converged.

method: SolverMethod

Solver method used to produce this result.

iterations: u32

Number of iterations taken.

converged: bool

Whether the solver converged. Equivalent to status == SolverStatus::Converged.

status: SolverStatus

The precise outcome of the solve (the reason behind converged).

residual: f64

Residual |model_price - market_price| at the solution (or at the best endpoint examined when no root was found).

Trait Implementations

impl Clone for SolverResult

fn clone(&self) -> SolverResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SolverResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SolverResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SolverResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.