QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.34
Loading...
Searching...
No Matches
fdmdividendhandler.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) 2008 Andreas Gaida
5 Copyright (C) 2008 Ralph Schreyer
6 Copyright (C) 2008, 2009 Klaus Spanderen
7
8 This file is part of QuantLib, a free-software/open-source library
9 for financial quantitative analysts and developers - http://quantlib.org/
10
11 QuantLib is free software: you can redistribute it and/or modify it
12 under the terms of the QuantLib license. You should have received a
13 copy of the license along with this program; if not, please email
14 <quantlib-dev@lists.sf.net>. The license is also available online at
15 <http://quantlib.org/license.shtml>.
16
17 This program is distributed in the hope that it will be useful, but WITHOUT
18 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 FOR A PARTICULAR PURPOSE. See the license for more details.
20*/
21
22/*! \file fdmdividendhandler.hpp
23 \brief dividend handler for fdm method for one equity direction
24*/
25
26#ifndef quantlib_fdm_dividend_handler_hpp
27#define quantlib_fdm_dividend_handler_hpp
28
32
33namespace QuantLib {
34
35 class DayCounter;
36
37 class FdmDividendHandler : public StepCondition<Array> {
38 public:
40 const ext::shared_ptr<FdmMesher>& mesher,
41 const Date& referenceDate,
42 const DayCounter& dayCounter,
43 Size equityDirection);
44
45 void applyTo(Array& a, Time t) const override;
46
47 const std::vector<Time>& dividendTimes() const;
48 const std::vector<Date>& dividendDates() const;
49 const std::vector<Real>& dividends() const;
50
51 private:
52 Array x_; // grid-equity values in physical units
53
54 std::vector<Time> dividendTimes_;
55 std::vector<Date> dividendDates_;
56 std::vector<Real> dividends_;
57 const ext::shared_ptr<FdmMesher> mesher_;
59 };
60}
61#endif
1-D array used in linear algebra.
Definition: array.hpp:52
Concrete date class.
Definition: date.hpp:125
day counter class
Definition: daycounter.hpp:44
std::vector< Date > dividendDates_
const std::vector< Time > & dividendTimes() const
std::vector< Time > dividendTimes_
const ext::shared_ptr< FdmMesher > mesher_
void applyTo(Array &a, Time t) const override
const std::vector< Date > & dividendDates() const
const std::vector< Real > & dividends() const
condition to be applied at every time step
const DefaultType & t
Schedule of dividend dates.
mesher for a fdm grid
Real Time
continuous quantity with 1-year units
Definition: types.hpp:62
std::size_t Size
size of a container
Definition: types.hpp:58
Definition: any.hpp:35
std::vector< ext::shared_ptr< Dividend > > DividendSchedule
conditions to be applied at every time step