Logo
Reference manual - version qle_version
FxModel Class Referenceabstract
Inheritance diagram for FxModel:

Public Member Functions

virtual const QuantLib::ext::shared_ptr< ParametrizationparametrizationBase () const =0
virtual Handle< QuotefxSpotToday () const =0
virtual Size n () const =0
virtual Size m () const =0
virtual Array eulerStep (const Time t0, const Array &x0, const Time dt, const Array &dw, const Real r_dom, const Real r_for) const =0
Public Member Functions inherited from LinkableCalibratedModel
void update () override
virtual void calibrate (const std::vector< QuantLib::ext::shared_ptr< CalibrationHelper > > &, OptimizationMethod &method, const EndCriteria &endCriteria, const Constraint &constraint=Constraint(), const std::vector< Real > &weights=std::vector< Real >(), const std::vector< bool > &fixParameters=std::vector< bool >())
 Calibrate to a set of market instruments (usually caps/swaptions).
virtual void calibrate (const std::vector< QuantLib::ext::shared_ptr< BlackCalibrationHelper > > &, OptimizationMethod &method, const EndCriteria &endCriteria, const Constraint &constraint=Constraint(), const std::vector< Real > &weights=std::vector< Real >(), const std::vector< bool > &fixParameters=std::vector< bool >())
 for backward compatibility
Real value (const Array &params, const std::vector< QuantLib::ext::shared_ptr< CalibrationHelper > > &)
Real value (const Array &params, const std::vector< QuantLib::ext::shared_ptr< BlackCalibrationHelper > > &)
 for backward compatibility
const QuantLib::ext::shared_ptr< Constraint > & constraint () const
EndCriteria::Type endCriteria () const
 Returns end criteria result.
const Array & problemValues () const
 Returns the problem values.
Array params () const
 Returns array of arguments on which calibration is done.
virtual void setParams (const Array &params)
virtual void setParam (Size idx, const Real value)

Additional Inherited Members

Protected Member Functions inherited from LinkableCalibratedModel
virtual void generateArguments ()
Protected Attributes inherited from LinkableCalibratedModel
std::vector< QuantLib::ext::shared_ptr< Parameter > > arguments_
QuantLib::ext::shared_ptr< Constraintconstraint_
EndCriteria::Type endCriteria_
Array problemValues_

Member Function Documentation

◆ parametrizationBase()

virtual const QuantLib::ext::shared_ptr< Parametrization > parametrizationBase ( ) const
pure virtual

parametrization (as base class)

Implemented in FxBsModel.

◆ fxSpotToday()

virtual Handle< Quote > fxSpotToday ( ) const
pure virtual

today's fx rate on which the model is based

Implemented in FxBsModel.

◆ n()

virtual Size n ( ) const
pure virtual

dimension of model state, excluding auxilliary states

Implemented in FxBsModel.

◆ m()

virtual Size m ( ) const
pure virtual

number of Brownians to evolve the state

Implemented in FxBsModel.

◆ eulerStep()

virtual Array eulerStep ( const Time t0,
const Array & x0,
const Time dt,
const Array & dw,
const Real r_dom,
const Real r_for ) const
pure virtual

perform an Euler step given short rates for the rates

Implemented in FxBsModel.