quantlib_rs 0.1.0

A ground-up, idiomatic Rust quantitative finance library inspired by QuantLib.
Documentation
//! # `quantlib_rs`
//!
//! A ground-up, idiomatic Rust quantitative finance library inspired by QuantLib.
//!
//! ## Key Architectural Features
//! - **Fearless Concurrency**: All core traits and data structures implement `Send + Sync`.
//! - **Generational Handles & Snapshots**: Typed generational indices for market observables (`QuoteId`), avoiding cyclic smart pointers and borrow panics.
//! - **Machine-Precision Greeks via Autodiff**: Stack-allocated forward-mode Dual and Hyper-Dual numbers evaluate exact Greeks in a single pass.
//! - **Zero `unsafe` Code**: Guaranteed safe Rust under `#![deny(unsafe_code)]`.
//!
//! ## Quickstart
//! ```
//! use quantlib_rs::prelude::*;
//!
//! let today = Date::from_ymd(2026, Month::September, 3).unwrap();
//! let maturity = Date::from_ymd(2027, Month::September, 3).unwrap();
//!
//! let spot = 100.0;
//! let strike = 100.0;
//! let rate = 0.05;
//! let dividend = 0.02;
//! let vol = 0.20;
//!
//! let process = GeneralizedBlackScholesProcess::new(spot, rate, dividend, vol, today);
//! let call = EuropeanOption::new(OptionType::Call, strike, maturity);
//! let engine = AnalyticEuropeanEngine::new(process);
//!
//! let npv = engine.calculate(&call).unwrap();
//! let greeks = engine.calculate_greeks(&call).unwrap();
//!
//! assert!(npv > 0.0);
//! assert!(greeks.delta > 0.0 && greeks.delta < 1.0);
//! ```

#![deny(unsafe_code)]
#![warn(missing_docs)]

pub mod cashflows;
pub mod core;
pub mod engines;
pub mod instruments;
pub mod math;
pub mod termstructures;
pub mod time;

/// Convenient re-exports of commonly used types and traits.
pub mod prelude {
    pub use crate::cashflows::{CashFlow, FixedRateCoupon, Leg, SimpleCashFlow};
    pub use crate::core::market_store::MarketStore;
    pub use crate::core::quote::{Quote, QuoteId, SimpleQuote};
    pub use crate::engines::analytic_european_engine::{
        black_scholes_price, AnalyticEuropeanEngine, Greeks, PricingError,
    };
    pub use crate::engines::bond_engine::DiscountingBondEngine;
    pub use crate::engines::swap_engine::DiscountingSwapEngine;
    pub use crate::instruments::bonds::{BondError, DurationType, FixedRateBond, ZeroCouponBond};
    pub use crate::instruments::option::{EuropeanOption, OptionType};
    pub use crate::instruments::swaps::{SwapType, VanillaSwap};
    pub use crate::math::autodiff::{Dual64, HyperDual64};
    pub use crate::math::distributions::{inverse_normal_cdf, normal_cdf, normal_pdf};
    pub use crate::math::interpolation::{
        CubicSpline, Extrapolation, InterpolationError, LinearInterpolation,
    };
    pub use crate::math::solvers::{Bisection, NewtonRaphson, SolverError};
    pub use crate::termstructures::bootstrapped_curve::{
        DepositRateHelper, PiecewiseYieldCurve, RateHelper, SwapRateHelper,
    };
    pub use crate::termstructures::interpolated_discount_curve::{
        CurveError, InterpolatedDiscountCurve,
    };
    pub use crate::termstructures::process::GeneralizedBlackScholesProcess;
    pub use crate::termstructures::vol_term_structure::{BlackConstantVol, BlackVolTermStructure};
    pub use crate::termstructures::yield_term_structure::{FlatForward, YieldTermStructure};
    pub use crate::time::calendar::{BusinessDayConvention, Calendar};
    pub use crate::time::calendars::{NullCalendar, USMarket, UnitedStates, WeekendsOnly};
    pub use crate::time::date::{Date, DateError, Month, Period, Weekday};
    pub use crate::time::day_counter::DayCounter;
    pub use crate::time::day_counters::{
        Actual360, Actual365Fixed, ActualActual, ActualActualConvention, Thirty360,
        Thirty360Convention,
    };
    pub use crate::time::schedule::{DateGenerationRule, Schedule};
}