Spread fitting method helper. More...
#include <nonlinearfittingmethods.hpp>
Inheritance diagram for SpreadFittingMethod:
Collaboration diagram for SpreadFittingMethod:
Public Member Functions | |
| SpreadFittingMethod (const ext::shared_ptr< FittingMethod > &method, Handle< YieldTermStructure > discountCurve, Real minCutoffTime=0.0, Real maxCutoffTime=QL_MAX_REAL) | |
| std::unique_ptr< FittedBondDiscountCurve::FittingMethod > | clone () const override |
| clone of the current object More... | |
| Public Member Functions inherited from FittedBondDiscountCurve::FittingMethod | |
| virtual | ~FittingMethod ()=default |
| virtual Size | size () const =0 |
| total number of coefficients to fit/solve for More... | |
| Array | solution () const |
| output array of results of optimization problem More... | |
| Integer | numberOfIterations () const |
| final number of iterations used in the optimization problem More... | |
| Real | minimumCostValue () const |
| final value of cost function after optimization More... | |
| EndCriteria::Type | errorCode () const |
| error code of the optimization More... | |
| virtual std::unique_ptr< FittingMethod > | clone () const =0 |
| clone of the current object More... | |
| bool | constrainAtZero () const |
| return whether there is a constraint at zero More... | |
| Array | weights () const |
| return weights being used More... | |
| Array | l2 () const |
| return l2 penalties being used More... | |
| ext::shared_ptr< OptimizationMethod > | optimizationMethod () const |
| return optimization method being used More... | |
| const Constraint & | constraint () const |
| return optimization contraint More... | |
| DiscountFactor | discount (const Array &x, Time t) const |
| open discountFunction to public More... | |
Protected Member Functions | |
| void | init () override |
| rerun every time instruments/referenceDate changes More... | |
| Protected Member Functions inherited from FittedBondDiscountCurve::FittingMethod | |
| FittingMethod (bool constrainAtZero=true, const Array &weights=Array(), ext::shared_ptr< OptimizationMethod > optimizationMethod=ext::shared_ptr< OptimizationMethod >(), Array l2=Array(), Real minCutoffTime=0.0, Real maxCutoffTime=QL_MAX_REAL, Constraint constraint=NoConstraint()) | |
| constructors More... | |
| virtual void | init () |
| rerun every time instruments/referenceDate changes More... | |
| virtual DiscountFactor | discountFunction (const Array &x, Time t) const =0 |
| discount function called by FittedBondDiscountCurve More... | |
Private Member Functions | |
| Size | size () const override |
| total number of coefficients to fit/solve for More... | |
| DiscountFactor | discountFunction (const Array &x, Time t) const override |
| discount function called by FittedBondDiscountCurve More... | |
Private Attributes | |
| ext::shared_ptr< FittingMethod > | method_ |
| DiscountFactor | rebase_ |
| Handle< YieldTermStructure > | discountingCurve_ |
Additional Inherited Members | |
| Protected Attributes inherited from FittedBondDiscountCurve::FittingMethod | |
| bool | constrainAtZero_ |
| constrains discount function to unity at \( T=0 \), if true More... | |
| FittedBondDiscountCurve * | curve_ |
| internal reference to the FittedBondDiscountCurve instance More... | |
| Array | solution_ |
| solution array found from optimization, set in calculate() More... | |
| Array | guessSolution_ |
| optional guess solution to be passed into constructor. More... | |
| ext::shared_ptr< FittingCost > | costFunction_ |
| base class sets this cost function used in the optimization routine More... | |
Detailed Description
Spread fitting method helper.
Fits a spread curve on top of a discount function according to the given parametric method
- Examples
- FittedBondCurve.cpp.
Definition at line 239 of file nonlinearfittingmethods.hpp.
Constructor & Destructor Documentation
◆ SpreadFittingMethod()
| SpreadFittingMethod | ( | const ext::shared_ptr< FittingMethod > & | method, |
| Handle< YieldTermStructure > | discountCurve, | ||
| Real | minCutoffTime = 0.0, |
||
| Real | maxCutoffTime = QL_MAX_REAL |
||
| ) |
Definition at line 317 of file nonlinearfittingmethods.cpp.
Member Function Documentation
◆ clone()
|
overridevirtual |
clone of the current object
Implements FittedBondDiscountCurve::FittingMethod.
Definition at line 334 of file nonlinearfittingmethods.cpp.
◆ init()
|
overrideprotectedvirtual |
rerun every time instruments/referenceDate changes
Reimplemented from FittedBondDiscountCurve::FittingMethod.
Definition at line 346 of file nonlinearfittingmethods.cpp.
Here is the call graph for this function:
◆ size()
|
overrideprivatevirtual |
total number of coefficients to fit/solve for
Implements FittedBondDiscountCurve::FittingMethod.
Definition at line 338 of file nonlinearfittingmethods.cpp.
◆ discountFunction()
|
overrideprivatevirtual |
discount function called by FittedBondDiscountCurve
Implements FittedBondDiscountCurve::FittingMethod.
Definition at line 342 of file nonlinearfittingmethods.cpp.
Member Data Documentation
◆ method_
|
private |
Definition at line 254 of file nonlinearfittingmethods.hpp.
◆ rebase_
|
private |
Definition at line 256 of file nonlinearfittingmethods.hpp.
◆ discountingCurve_
|
private |
Definition at line 258 of file nonlinearfittingmethods.hpp.