Skip to main content

BullSpread

Struct BullSpread 

Source
pub struct BullSpread { /* private fields */ }
Expand description

Bull spread option payoff and profit.

Bull Spread = Long Call + Short Call

Implementations§

Source§

impl BullSpread

Source

pub fn build(k_l: f64, k_s: f64, cost: f64) -> Result<Self, DigiFiError>

Creates a new BullSpread instance.

§Input
  • k_l: Long call option strike price
  • k_s: Short call option strike price
  • cost: Initial option price (cost)
§Errors
  • Returns an error if the short call strike price is smaller than the long call strike price.

Trait Implementations§

Source§

impl Clone for BullSpread

Source§

fn clone(&self) -> BullSpread

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BullSpread

Source§

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

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

impl ErrorTitle for BullSpread

Source§

fn error_title() -> String

Returns the error title.
Source§

impl Payoff for BullSpread

Source§

fn payoff(&self, s: f64) -> f64

Bull spread option payoff.

§Input
  • s: Underlying asset price
§Output
  • Payoff of the bull spread option
§LaTeX Formula
  • \textit{Bull Spread Payoff} = max(S_{t}-K_{l}, 0) + min(K_{s}-S_{t}, 0)
§Examples
use ndarray::{Array1, array};
use digifi::utilities::TEST_ACCURACY;
use digifi::financial_instruments::{Payoff, BullSpread};

let s: Array1<f64> = Array1::from_vec(vec![3.0, 4.0, 5.0, 6.0, 7.0]);

let bull_spread: BullSpread = BullSpread::build(4.0, 6.0, 1.0).unwrap();

assert!((bull_spread.payoff_iter(&s) - Array1::from_vec(vec![0.0, 0.0, 1.0, 2.0, 2.0])).map(|v| v.abs() ).sum() < TEST_ACCURACY);
Source§

fn profit(&self, s: f64) -> f64

Bull spread option profit.

§Input
  • s: Underlying asset price
§Output
  • Profit of the bull spread option
§LaTeX Formula
  • \textit{Bull Spread Profit} = max(S_{t}-K_{l}, 0) + min(K_{s}-S_{t}, 0) - \textit{Cost}
Source§

fn update_cost(&mut self, new_cost: f64)

Updates the cost/premium of the instrument. Read more
Source§

fn payoff_iter(&self, s: &Array1<f64>) -> Array1<f64>

Payoff function applied to the array of values.
Source§

fn validate_payoff(&self, val_length: usize) -> Result<(), DigiFiError>

Validation of payoff object to satisfy the computational requirements. Read more
Source§

fn profit_iter(&self, s: &Array1<f64>) -> Array1<f64>

Profit function applied to the array of values.
Source§

impl Copy for BullSpread

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> PayoffClone for T
where T: 'static + Payoff + Clone,

Source§

fn clone_box(&self) -> Box<dyn Payoff>

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