NumericLgmSwaptionEngine Class Reference

#include <qle/pricingengines/numericlgmmultilegoptionengine.hpp>

Inheritance diagram for NumericLgmSwaptionEngine:

Collaboration diagram for NumericLgmSwaptionEngine:

Public Member Functions
	NumericLgmSwaptionEngine (const QuantLib::ext::shared_ptr< LinearGaussMarkovModel > &model, const Real sy, const Size ny, const Real sx, const Size nx, const Handle< YieldTermStructure > &discountCurve=Handle< YieldTermStructure >(), const Size americanExerciseTimeStepsPerYear=24)
	NumericLgmSwaptionEngine (const QuantLib::ext::shared_ptr< LinearGaussMarkovModel > &model, const Real maxTime=50.0, const QuantLib::FdmSchemeDesc scheme=QuantLib::FdmSchemeDesc::Douglas(), const Size stateGridPoints=64, const Size timeStepsPerYear=24, const Real mesherEpsilon=1E-4, const Handle< YieldTermStructure > &discountCurve=Handle< YieldTermStructure >(), const Size americanExerciseTimeStepsPerYear=24)
void	calculate () const override
Public Member Functions inherited from NumericLgmMultiLegOptionEngineBase
	NumericLgmMultiLegOptionEngineBase (const QuantLib::ext::shared_ptr< LgmBackwardSolver > &solver, const Handle< YieldTermStructure > &discountCurve=Handle< YieldTermStructure >(), const Size americanExerciseTimeStepsPerYear=24)

Additional Inherited Members
Static Public Member Functions inherited from NumericLgmMultiLegOptionEngineBase
static bool	instrumentIsHandled (const MultiLegOption &m, std::vector< std::string > &messages)
Protected Member Functions inherited from NumericLgmMultiLegOptionEngineBase
CashflowInfo	buildCashflowInfo (const Size i, const Size j) const
void	calculate () const
Static Protected Member Functions inherited from NumericLgmMultiLegOptionEngineBase
static bool	instrumentIsHandled (const std::vector< Leg > &legs, const std::vector< bool > &payer, const std::vector< Currency > &currency, const QuantLib::ext::shared_ptr< Exercise > &exercise, const Settlement::Type &settlementType, const Settlement::Method &settlementMethod, std::vector< std::string > &messages)
Protected Attributes inherited from NumericLgmMultiLegOptionEngineBase
QuantLib::ext::shared_ptr< LgmBackwardSolver >	solver_
Handle< YieldTermStructure >	discountCurve_
Size	americanExerciseTimeStepsPerYear_
std::vector< Leg >	legs_
std::vector< bool >	payer_
std::vector< Currency >	currency_
QuantLib::ext::shared_ptr< Exercise >	exercise_
Settlement::Type	settlementType_
Settlement::Method	settlementMethod_
Real	npv_
Real	underlyingNpv_
std::map< std::string, boost::any >	additionalResults_

Detailed Description

Definition at line 105 of file numericlgmmultilegoptionengine.hpp.

Constructor & Destructor Documentation

NumericLgmSwaptionEngine() [1/2]

NumericLgmSwaptionEngine	(	const QuantLib::ext::shared_ptr< LinearGaussMarkovModel > &	model,
		const Real	sy,
		const Size	ny,
		const Real	sx,
		const Size	nx,
		const Handle< YieldTermStructure > &	discountCurve = Handle<YieldTermStructure>(),
		const Size	americanExerciseTimeStepsPerYear = 24
	)

Definition at line 563 of file numericlgmmultilegoptionengine.cpp.

    : NumericLgmMultiLegOptionEngineBase(QuantLib::ext::make_shared<LgmConvolutionSolver2>(model, sy, ny, sx, nx),
                                         discountCurve, americanExerciseTimeStepsPerYear) {
    registerWith(solver_->model());
    registerWith(discountCurve_);
}

NumericLgmSwaptionEngine() [2/2]

NumericLgmSwaptionEngine	(	const QuantLib::ext::shared_ptr< LinearGaussMarkovModel > &	model,
		const Real	maxTime = 50.0,
		const QuantLib::FdmSchemeDesc	scheme = QuantLib::FdmSchemeDesc::Douglas(),
		const Size	stateGridPoints = 64,
		const Size	timeStepsPerYear = 24,
		const Real	mesherEpsilon = 1E-4,
		const Handle< YieldTermStructure > &	discountCurve = Handle<YieldTermStructure>(),
		const Size	americanExerciseTimeStepsPerYear = 24
	)

Definition at line 573 of file numericlgmmultilegoptionengine.cpp.

    : NumericLgmMultiLegOptionEngineBase(
          QuantLib::ext::make_shared<LgmFdSolver>(model, maxTime, scheme, stateGridPoints, timeStepsPerYear, mesherEpsilon),
          discountCurve, americanExerciseTimeStepsPerYear) {
    registerWith(solver_->model());
    registerWith(discountCurve_);
}

Member Function Documentation

calculate()

void calculate ( ) const

override

Definition at line 586 of file numericlgmmultilegoptionengine.cpp.

                                               {
    legs_ = arguments_.legs;
    payer_.resize(arguments_.payer.size());
    for (Size i = 0; i < arguments_.payer.size(); ++i) {
        payer_[i] = QuantLib::close_enough(arguments_.payer[i], -1.0);
    }
    currency_ = std::vector<Currency>(legs_.size(), arguments_.swap->iborIndex()->currency());
    exercise_ = arguments_.exercise;
    settlementType_ = arguments_.settlementType;
    settlementMethod_ = arguments_.settlementMethod;
 
    NumericLgmMultiLegOptionEngineBase::calculate();
 
    results_.value = npv_;
    results_.additionalResults = additionalResults_;
    results_.additionalResults["underlyingNpv"] = underlyingNpv_;
} // NumericLgmSwaptionEngine::calculate

Here is the call graph for this function: