Loading [MathJax]/extensions/tex2jax.js
QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.34
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members
TreeCallableFixedRateBondEngine Class Reference

Numerical lattice engine for callable fixed rate bonds. More...

#include <treecallablebondengine.hpp>

+ Inheritance diagram for TreeCallableFixedRateBondEngine:
+ Collaboration diagram for TreeCallableFixedRateBondEngine:

Constructors

Note
the term structure is only needed when the short-rate model cannot provide one itself.
Handle< YieldTermStructuretermStructure_
 
 TreeCallableFixedRateBondEngine (const ext::shared_ptr< ShortRateModel > &, Size timeSteps, Handle< YieldTermStructure > termStructure=Handle< YieldTermStructure >())
 
 TreeCallableFixedRateBondEngine (const ext::shared_ptr< ShortRateModel > &, const TimeGrid &timeGrid, Handle< YieldTermStructure > termStructure=Handle< YieldTermStructure >())
 
void calculate () const override
 
void calculateWithSpread (Spread s) const
 

Additional Inherited Members

- Public Types inherited from Observer
typedef set_type::iterator iterator
 
- Public Member Functions inherited from LatticeShortRateModelEngine< CallableBond::arguments, CallableBond::results >
 LatticeShortRateModelEngine (const ext::shared_ptr< ShortRateModel > &model, Size timeSteps)
 
 LatticeShortRateModelEngine (const Handle< ShortRateModel > &model, Size timeSteps)
 
 LatticeShortRateModelEngine (const ext::shared_ptr< ShortRateModel > &model, const TimeGrid &timeGrid)
 
void update () override
 
- Public Member Functions inherited from GenericModelEngine< ModelType, ArgumentsType, ResultsType >
 GenericModelEngine (Handle< ModelType > model=Handle< ModelType >())
 
 GenericModelEngine (const ext::shared_ptr< ModelType > &model)
 
- Public Member Functions inherited from GenericEngine< ArgumentsType, ResultsType >
PricingEngine::argumentsgetArguments () const override
 
const PricingEngine::resultsgetResults () const override
 
void reset () override
 
void update () override
 
- Public Member Functions inherited from PricingEngine
 ~PricingEngine () override=default
 
virtual argumentsgetArguments () const =0
 
virtual const resultsgetResults () const =0
 
virtual void reset ()=0
 
virtual void calculate () const =0
 
- Public Member Functions inherited from Observable
 Observable ()
 
 Observable (const Observable &)
 
Observableoperator= (const Observable &)
 
 Observable (Observable &&)=delete
 
Observableoperator= (Observable &&)=delete
 
virtual ~Observable ()=default
 
void notifyObservers ()
 
- Public Member Functions inherited from Observer
 Observer ()=default
 
 Observer (const Observer &)
 
Observeroperator= (const Observer &)
 
virtual ~Observer ()
 
std::pair< iterator, boolregisterWith (const ext::shared_ptr< Observable > &)
 
void registerWithObservables (const ext::shared_ptr< Observer > &)
 
Size unregisterWith (const ext::shared_ptr< Observable > &)
 
void unregisterWithAll ()
 
virtual void update ()=0
 
virtual void deepUpdate ()
 
- Protected Attributes inherited from LatticeShortRateModelEngine< CallableBond::arguments, CallableBond::results >
TimeGrid timeGrid_
 
Size timeSteps_
 
ext::shared_ptr< Latticelattice_
 
- Protected Attributes inherited from GenericModelEngine< ModelType, ArgumentsType, ResultsType >
Handle< ModelType > model_
 
- Protected Attributes inherited from GenericEngine< ArgumentsType, ResultsType >
ArgumentsType arguments_
 
ResultsType results_
 

Detailed Description

Numerical lattice engine for callable fixed rate bonds.

Definition at line 34 of file treecallablebondengine.hpp.

Constructor & Destructor Documentation

◆ TreeCallableFixedRateBondEngine() [1/2]

TreeCallableFixedRateBondEngine ( const ext::shared_ptr< ShortRateModel > &  model,
Size  timeSteps,
Handle< YieldTermStructure termStructure = Handle<YieldTermStructure>() 
)

Definition at line 28 of file treecallablebondengine.cpp.

+ Here is the call graph for this function:

◆ TreeCallableFixedRateBondEngine() [2/2]

TreeCallableFixedRateBondEngine ( const ext::shared_ptr< ShortRateModel > &  model,
const TimeGrid timeGrid,
Handle< YieldTermStructure termStructure = Handle<YieldTermStructure>() 
)

Definition at line 37 of file treecallablebondengine.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ calculate()

void calculate ( ) const
overridevirtual

Implements PricingEngine.

Definition at line 46 of file treecallablebondengine.cpp.

+ Here is the call graph for this function:

◆ calculateWithSpread()

void calculateWithSpread ( Spread  s) const
private

Definition at line 50 of file treecallablebondengine.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ termStructure_

Handle<YieldTermStructure> termStructure_
private

Definition at line 56 of file treecallablebondengine.hpp.