1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2
3/*
4 Copyright (C) 2013, 2018 Peter Caspers
5
6 This file is part of QuantLib, a free-software/open-source library
7 for financial quantitative analysts and developers - http://quantlib.org/
8
9 QuantLib is free software: you can redistribute it and/or modify it
10 under the terms of the QuantLib license. You should have received a
11 copy of the license along with this program; if not, please email
12 <quantlib-dev@lists.sf.net>. The license is also available online at
13 <http://quantlib.org/license.shtml>.
14
15 This program is distributed in the hope that it will be useful, but WITHOUT
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 FOR A PARTICULAR PURPOSE. See the license for more details.
18*/
19
20/*! \file nonstandardswaption.hpp
21 \brief nonstandard swap option class
22*/
23
24#ifndef quantlib_instruments_nonstandardswaption_hpp
25#define quantlib_instruments_nonstandardswaption_hpp
26
27#include <ql/option.hpp>
28#include <ql/instruments/swaption.hpp>
29#include <ql/instruments/nonstandardswap.hpp>
30#include <ql/pricingengines/swaption/basketgeneratingengine.hpp>
31#include <ql/termstructures/yieldtermstructure.hpp>
32#include <ql/termstructures/volatility/swaption/swaptionvolstructure.hpp>
33#include <ql/models/calibrationhelper.hpp>
34
35namespace QuantLib {
36
37 //! nonstandard swaption class
38 /*! \ingroup instruments
39 */
40
41 class NonstandardSwaption : public Option {
42 public:
43 class arguments;
44 class engine;
45 NonstandardSwaption(const Swaption &fromSwaption);
46 NonstandardSwaption(ext::shared_ptr<NonstandardSwap> swap,
47 const ext::shared_ptr<Exercise>& exercise,
48 Settlement::Type delivery = Settlement::Physical,
49 Settlement::Method settlementMethod = Settlement::PhysicalOTC);
50
51 //! \name Instrument interface
52 //@{
53 bool isExpired() const override;
54 void setupArguments(PricingEngine::arguments*) const override;
55 //@}
56 //! \name Inspectors
57 //@{
58 Settlement::Type settlementType() const { return settlementType_; }
59 Settlement::Method settlementMethod() const {
60 return settlementMethod_;
61 }
62 Swap::Type type() const { return swap_->type(); }
63
64 const ext::shared_ptr<NonstandardSwap> &underlyingSwap() const {
65 return swap_;
66 }
67 //@}
68 std::vector<ext::shared_ptr<BlackCalibrationHelper>>
69 calibrationBasket(const ext::shared_ptr<SwapIndex>& standardSwapBase,
70 const ext::shared_ptr<SwaptionVolatilityStructure>& swaptionVolatility,
71 BasketGeneratingEngine::CalibrationBasketType basketType =
72 BasketGeneratingEngine::MaturityStrikeByDeltaGamma) const;
73
74 private:
75 // arguments
76 ext::shared_ptr<NonstandardSwap> swap_;
77 Settlement::Type settlementType_;
78 Settlement::Method settlementMethod_;
79 };
80
81 //! %Arguments for nonstandard swaption calculation
82 class NonstandardSwaption::arguments : public NonstandardSwap::arguments,
83 public Option::arguments {
84 public:
85 arguments() = default;
86 ext::shared_ptr<NonstandardSwap> swap;
87 Settlement::Type settlementType;
88 Settlement::Method settlementMethod;
89 void validate() const override;
90 };
91
92 //! base class for nonstandard swaption engines
93 class NonstandardSwaption::engine
94 : public GenericEngine<NonstandardSwaption::arguments,
95 NonstandardSwaption::results> {};
96}
97
98#endif
99

source code of quantlib/ql/instruments/nonstandardswaption.hpp