Logo
Fully annotated reference manual - version 1.8.12
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
AnnuityMapping Class Referenceabstract

#include <qle/models/annuitymapping.hpp>

+ Inheritance diagram for AnnuityMapping:
+ Collaboration diagram for AnnuityMapping:

Public Member Functions

virtual ~AnnuityMapping ()
 
virtual Real map (const Real S) const =0
 
virtual Real mapPrime (const Real S) const
 
virtual Real mapPrime2 (const Real S) const
 
virtual bool mapPrime2IsZero () const =0
 

Protected Attributes

double h_ = 1E-6
 

Detailed Description

base class for annuity mapping functions used in TSR models

Definition at line 35 of file annuitymapping.hpp.

Constructor & Destructor Documentation

◆ ~AnnuityMapping()

virtual ~AnnuityMapping ( )
virtual

Definition at line 37 of file annuitymapping.hpp.

37{}

Member Function Documentation

◆ map()

virtual Real map ( const Real  S) const
pure virtual

Implemented in LinearAnnuityMapping.

+ Here is the caller graph for this function:

◆ mapPrime()

Real mapPrime ( const Real  S) const
virtual

Reimplemented in LinearAnnuityMapping.

Definition at line 23 of file annuitymapping.cpp.

23{ return (map(S + h_) - map(S - h_)) / (2.0 * h_); }
virtual Real map(const Real S) const =0
+ Here is the call graph for this function:

◆ mapPrime2()

Real mapPrime2 ( const Real  S) const
virtual

Reimplemented in LinearAnnuityMapping.

Definition at line 24 of file annuitymapping.cpp.

24{ return (map(S + h_) - 2.0 * map(S) + map(S - h_)) / (h_ * h_); }
+ Here is the call graph for this function:

◆ mapPrime2IsZero()

virtual bool mapPrime2IsZero ( ) const
pure virtual

Implemented in LinearAnnuityMapping.

Member Data Documentation

◆ h_

double h_ = 1E-6
protected

Definition at line 53 of file annuitymapping.hpp.