Skip to main content

EquityOptionData

Struct EquityOptionData 

Source
pub struct EquityOptionData {
Show 49 fields pub base: EquityInstrumentBase, pub put_or_call: String, pub payoff_type: String, pub binary_type: Option<String>, pub cash_amount: Option<f64>, pub barrier_type: Option<String>, pub barrier_level: Option<f64>, pub barrier_level2: Option<f64>, pub rebate: Option<f64>, pub rebate_at_hit: Option<bool>, pub lookback_type: Option<String>, pub averaging_type: Option<String>, pub asian_strike_type: Option<String>, pub forward_start_date: Option<String>, pub strike_fraction: Option<f64>, pub autocall_barrier: Option<f64>, pub protection_barrier: Option<f64>, pub autocall_coupon: Option<f64>, pub autocall_observations: Option<usize>, pub tree_type: Option<String>, pub tree_steps: Option<usize>, pub tree_term_structure: Option<bool>, pub exercise_dates: Option<Vec<String>>, pub autocall_observation_dates: Option<Vec<String>>, pub coupon_barrier: Option<f64>, pub coupon_memory: Option<bool>, pub notional: Option<f64>, pub cash_dividends: Option<Vec<CashDividendData>>, pub futures_settlement: Option<String>, pub strike_price: Option<f64>, pub volatility: Option<f64>, pub maturity: String, pub dividend: Option<f64>, pub current_price: Option<f64>, pub multiplier: Option<f64>, pub entry_price: Option<f64>, pub simulation: Option<u64>, pub mc_time_steps: Option<usize>, pub mc_scheme: Option<String>, pub mc_sampler: Option<String>, pub mc_seed: Option<u64>, pub mc_model: Option<String>, pub fd_spot_steps: Option<usize>, pub fd_time_steps: Option<usize>, pub heston: Option<HestonParams>, pub exercise_style: Option<String>, pub pricer: Option<String>, pub discount_curve: Option<CurveInput>, pub vol_surface: Option<VolInput>,
}

Fields§

§base: EquityInstrumentBase§put_or_call: String§payoff_type: String§binary_type: Option<String>

Binary settlement: “cash” (default) or “asset”.

§cash_amount: Option<f64>

Amount paid by a cash-or-nothing binary (default 1.0).

§barrier_type: Option<String>

Barrier variant: “up_in” | “up_out” | “down_in” | “down_out”.

§barrier_level: Option<f64>§barrier_level2: Option<f64>

Second barrier level (makes the option a double barrier).

§rebate: Option<f64>

Barrier rebate amount.

§rebate_at_hit: Option<bool>

Knock-out rebate paid at the touch (default: at expiry).

§lookback_type: Option<String>

Lookback flavor: “floating” (default) or “fixed”.

§averaging_type: Option<String>

Asian averaging: “arithmetic” (default) | “geometric”.

§asian_strike_type: Option<String>

Asian strike: “fixed” (default, average price) | “floating” (average strike).

§forward_start_date: Option<String>

Forward-start: strike fixing date and strike as a fraction of the fixing spot (default 1.0).

§strike_fraction: Option<f64>§autocall_barrier: Option<f64>

Autocallable: early-redemption and knock-in protection levels (absolute), per-period coupon (rebate), observation count, notional.

§protection_barrier: Option<f64>§autocall_coupon: Option<f64>§autocall_observations: Option<usize>§tree_type: Option<String>

Binomial tree parameterization: LeisenReimer (default), CRR, JarrowRudd, Tian, Trigeorgis, EQP.

§tree_steps: Option<usize>

Binomial tree steps (default 1000; Leisen-Reimer bumps even counts to odd).

§tree_term_structure: Option<bool>

Price the tree with term structures of rates and volatility applied per step (variance-equal time grid). tree_type is then ignored.

§exercise_dates: Option<Vec<String>>

Bermudan exercise dates (YYYY-MM-DD, strictly increasing, after valuation and at or before maturity). Required when exercise_style is Bermudan. Expiry is always exercisable through the terminal payoff.

§autocall_observation_dates: Option<Vec<String>>

Explicit autocall observation dates (YYYY-MM-DD, strictly increasing, after valuation and at or before maturity). Overrides autocall_observations; use business-day adjusted dates from a holiday calendar so observations do not land on weekends.

§coupon_barrier: Option<f64>

Phoenix: conditional-coupon barrier (absolute level).

§coupon_memory: Option<bool>

Phoenix: memory coupons (missed coupons recovered later).

§notional: Option<f64>§cash_dividends: Option<Vec<CashDividendData>>

Discrete cash dividends (ex-date + amount per share).

§futures_settlement: Option<String>

When set, the option is on a future (Black-76): “discounted” (standard) or “margined” (futures-style). underlying_price is then the futures price.

§strike_price: Option<f64>

Strike; required for vanilla/binary/barrier/asian payoffs, unused for forward-start and autocallable contracts.

§volatility: Option<f64>

Constant volatility; the simple alternative to vol_surface.

§maturity: String§dividend: Option<f64>§current_price: Option<f64>§multiplier: Option<f64>§entry_price: Option<f64>§simulation: Option<u64>

Monte Carlo path count (engine “MC” only).

§mc_time_steps: Option<usize>

MC time steps: 1 = terminal simulation; > 1 = path-wise stepping.

§mc_scheme: Option<String>

“exact” (default) | “euler” | “milstein”

§mc_sampler: Option<String>

“sobol” (default, low-discrepancy) | “pseudo” (seeded PCG64)

§mc_seed: Option<u64>§mc_model: Option<String>

“gbm” (default, constant vol) | “local_vol” (Dupire from the option’s vol surface). Applies to the MonteCarlo and FiniteDifference engines.

§fd_spot_steps: Option<usize>

Finite difference grid nodes in spot (default 400).

§fd_time_steps: Option<usize>

Finite difference time steps (default 400).

§heston: Option<HestonParams>

Heston parameters; required when mc_model is “heston”.

§exercise_style: Option<String>§pricer: Option<String>§discount_curve: Option<CurveInput>

Optional discount curve; when absent a flat curve is built from risk_free_rate (which stays the simple way to specify a rate).

§vol_surface: Option<VolInput>

Optional volatility surface; when absent a flat surface is built from volatility. One of the two must be provided.

Trait Implementations§

Source§

impl Clone for EquityOptionData

Source§

fn clone(&self) -> EquityOptionData

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 EquityOptionData

Source§

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

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

impl<'de> Deserialize<'de> for EquityOptionData

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 Serialize for EquityOptionData

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

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

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> 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