libitofin 0.11.0

A ground-up Rust port of QuantLib: quantitative-finance primitives for pricing, risk, and numerical methods.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

//! Default-protection side.
//!
//! Port of `ql/default.hpp:32-34` (`struct Protection { enum Side }`), whose
//! wrapper struct exists only to scope the enum. The port flattens the two
//! names into one, following
//! [`OptionType`](crate::option::OptionType) (`Option::Type`) and
//! [`FuturesType`](crate::instruments::FuturesType) (`Futures::Type`).
//!
//! The side tells a credit-default swap which leg it pays: the buyer pays the
//! premium and receives the default payment, the seller the reverse.
//!
//! ## Divergences from QuantLib
//!
//! - No integer discriminants are pinned. QuantLib's own `Protection::Side(-1)`
//!   "not set" sentinel (`ql/experimental/credit/nthtodefault.hpp:138`) only
//!   appears in the experimental basket instruments, which are out of scope for
//!   EPIC Credit (#676); the ported engines switch on the enum by value
//!   (`ql/pricingengines/credit/midpointcdsengine.cpp:134-138`).

/// Which side of a default-protection contract a party holds
/// (`Protection::Side`).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ProtectionSide {
    /// Pays the premium leg and receives the default payment.
    Buyer,
    /// Receives the premium leg and pays the default payment.
    Seller,
}