File: forward.i

package info (click to toggle)
quantlib-swig 1.40-4
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 2,280 kB
  • sloc: python: 6,024; java: 1,552; cs: 774; makefile: 349; sh: 22
file content (85 lines) | stat: -rw-r--r-- 2,690 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/*
 Copyright (C) 2015 Gouthaman Balaraman
 Copyright (C) 2018 Matthias Lungwitz

 This file is part of QuantLib, a free-software/open-source library
 for financial quantitative analysts and developers - http://quantlib.org/

 QuantLib is free software: you can redistribute it and/or modify it
 under the terms of the QuantLib license.  You should have received a
 copy of the license along with this program; if not, please email
 <quantlib-dev@lists.sf.net>. The license is also available online at
 <https://www.quantlib.org/license.shtml>.

 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE.  See the license for more details.
*/


#ifndef quantlib_forward_i
#define quantlib_forward_i

%include instruments.i
%include termstructures.i
%include interestrate.i

// Forward
%{
using QuantLib::Forward;
%}

%shared_ptr(Forward)
class Forward : public Instrument{
    public:
        Date settlementDate() const;
        bool isExpired() const;
        const Calendar& calendar() const;
        BusinessDayConvention businessDayConvention() const;
        const DayCounter& dayCounter() const;
        Handle<YieldTermStructure> discountCurve() const;
        Handle<YieldTermStructure> incomeDiscountCurve() const;
        Real spotValue() const;
        Real spotIncome(const Handle<YieldTermStructure>&
                                               incomeDiscountCurve) const;

        // calculations
        Real forwardValue();
        InterestRate impliedYield(
                        Real underlyingSpotValue,
                        Real forwardValue,
                        Date settlementDate,
                        Compounding compoundingConvention,
                        DayCounter dayCounter);
    private:
        Forward();
};


%{
using QuantLib::BondForward;
using QuantLib::FixedRateBond;
using QuantLib::BusinessDayConvention;
using QuantLib::Position;
%}

%shared_ptr(BondForward)
class BondForward : public Forward {
  public:
    BondForward(const Date& valueDate,
                const Date& maturityDate,
                Position::Type type,
                Real strike,
                Natural settlementDays,
                const DayCounter& dayCounter,
                const Calendar& calendar,
                BusinessDayConvention businessDayConvention,
                const ext::shared_ptr<Bond>& bond,
                const Handle<YieldTermStructure>& discountCurve = {},
                const Handle<YieldTermStructure>& incomeDiscountCurve = {});

    Real forwardPrice();
    Real cleanForwardPrice();
};

#endif