File: scheduler.cpp

package info (click to toggle)
quantlib 0.2.1.cvs20020322-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 4,716 kB
  • ctags: 4,614
  • sloc: cpp: 19,601; sh: 7,389; makefile: 796; ansic: 22
file content (134 lines) | stat: -rw-r--r-- 4,692 bytes parent folder | download
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134


/*
 Copyright (C) 2000, 2001, 2002 RiskMap srl

 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 ferdinando@ametrano.net
 The license is also available online at http://quantlib.org/html/license.html

 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.
*/
/*! \file scheduler.cpp
    \brief date scheduler

    \fullpath
    ql/%scheduler.cpp
*/

// $Id: scheduler.cpp,v 1.8 2002/01/16 14:43:48 nando Exp $

#include <ql/scheduler.hpp>
#include <ql/dataformatters.hpp>

namespace QuantLib {

    Scheduler::Scheduler(const Calendar& calendar,
      const Date& startDate, const Date& endDate, int frequency,
      RollingConvention rollingConvention, bool isAdjusted,
      const Date& stubDate)
    : calendar_(calendar), startDate_(startDate), endDate_(endDate),
      frequency_(frequency), rollingConvention_(rollingConvention),
      isAdjusted_(isAdjusted), stubDate_(stubDate), lastIsRegular_(true) {
        // sanity checks
        QL_REQUIRE(startDate_ != Date(), "null start date");
        QL_REQUIRE(endDate_ != Date(),   "null end date");
        QL_REQUIRE(startDate_ < endDate_,
            "start date (" +
                DateFormatter::toString(startDate_) +
                ") later than end date (" +
                DateFormatter::toString(endDate_) +
                ")");
        if (stubDate_ != Date()) {
            QL_REQUIRE(stubDate_ > startDate_,
                "stub date (" +
                    DateFormatter::toString(stubDate_) +
                    ") later than start date (" +
                    DateFormatter::toString(startDate_) + ")");
            QL_REQUIRE(!calendar_.isHoliday(stubDate_) ||
                       !isEndOfMonth(stubDate_),
                "stub date (" +
                    DateFormatter::toString(stubDate_) +
                    ") is holiday and end of month for " +
                    calendar_.name() + " calendar");
        } else {
            QL_REQUIRE(!calendar_.isHoliday(startDate_) ||
                       !isEndOfMonth(startDate_),
                "start date (" +
                    DateFormatter::toString(startDate_) +
                    ") is holiday and end of month for " +
                    calendar_.name() + " calendar");
        }
        QL_REQUIRE(12%frequency_ == 0,
            "frequency (" +
            IntegerFormatter::toString(frequency_) +
            " per year) does not correspond to a whole number of months");

        // calculations
        Date seed = startDate_;
        Date last = (isAdjusted_ ?
                     calendar_.roll(endDate_,rollingConvention_) :
                     endDate_);
        // add start date
        dates_.push_back(startDate_);

        // add stub date if given
        if (stubDate_ != Date()) {
            seed = stubDate_;
            dates_.push_back(isAdjusted_ ?
                             calendar_.roll(stubDate_) :
                             stubDate_);
        }

        // add subsequent dates
        int periods = 1, months = 12/frequency_;
        while (true) {
            Date temp = seed.plus(periods*months,Months);
            if (isAdjusted_)
                temp = calendar_.roll(temp,rollingConvention_);
            dates_.push_back(temp);
            // check exit condition
            if (temp >= last)
                break;
            else
                periods++;
        }

        // possibly correct last inserted date
        if (dates_.back() > last) {
            dates_.back() = last;
            lastIsRegular_ = false;
        }

        // possibly collapse last two dates
        int N = dates_.size();
        if (calendar_.roll(dates_[N-2],rollingConvention_) ==
            calendar_.roll(dates_[N-1],rollingConvention_)) {
                dates_[N-2] = dates_[N-1];
                dates_.pop_back();
                lastIsRegular_ = true;
        }

        // done
    }

    bool Scheduler::isRegular(Size i) const {
        if (i == 1)
            return (stubDate_ == Date());
        else if (i == size()-1)
            return lastIsRegular_;
        else
            return true;
    }

    bool Scheduler::isEndOfMonth(const Date& d) const {
        return (d.month() != calendar_.roll(d+1).month());
    }

}