QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.34
Loading...
Searching...
No Matches
treeswaptionengine.hpp
Go to the documentation of this file.
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2
3/*
4 Copyright (C) 2001, 2002, 2003 Sadruddin Rejeb
5 Copyright (C) 2005, 2007 StatPro Italia srl
6
7 This file is part of QuantLib, a free-software/open-source library
8 for financial quantitative analysts and developers - http://quantlib.org/
9
10 QuantLib is free software: you can redistribute it and/or modify it
11 under the terms of the QuantLib license. You should have received a
12 copy of the license along with this program; if not, please email
13 <quantlib-dev@lists.sf.net>. The license is also available online at
14 <http://quantlib.org/license.shtml>.
15
16 This program is distributed in the hope that it will be useful, but WITHOUT
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 FOR A PARTICULAR PURPOSE. See the license for more details.
19*/
20
21/*! \file treeswaptionengine.hpp
22 \brief Numerical lattice engine for swaptions
23*/
24
25#ifndef quantlib_tree_swaption_engine_hpp
26#define quantlib_tree_swaption_engine_hpp
27
30
31namespace QuantLib {
32
33 //! Numerical lattice engine for swaptions
34 /*! \ingroup swaptionengines
35
36 \warning This engine is not guaranteed to work if the
37 underlying swap has a start date in the past, i.e.,
38 before today's date. When using this engine, prune
39 the initial part of the swap so that it starts at
40 \f$ t \geq 0 \f$.
41
42 \test calculations are checked against cached results
43 */
45 : public LatticeShortRateModelEngine<Swaption::arguments,
46 Swaption::results> {
47 public:
48 /*! \name Constructors
49 \note the term structure is only needed when the short-rate
50 model cannot provide one itself.
51 */
52 //@{
53 TreeSwaptionEngine(const ext::shared_ptr<ShortRateModel>&,
54 Size timeSteps,
56 TreeSwaptionEngine(const ext::shared_ptr<ShortRateModel>&,
57 const TimeGrid& timeGrid,
60 Size timeSteps,
62 //@}
63 void calculate() const override;
64
65 private:
67 };
68
69}
70
71
72#endif
Shared handle to an observable.
Definition: handle.hpp:41
Engine for a short-rate model specialized on a lattice.
time grid class
Definition: timegrid.hpp:43
Numerical lattice engine for swaptions.
void calculate() const override
Handle< YieldTermStructure > termStructure_
std::size_t Size
size of a container
Definition: types.hpp:58
Engine for a short-rate model specialized on a lattice.
Definition: any.hpp:35
Swaption class.