lmmcurvestate.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 
/*
 Copyright (C) 2006, 2007 Ferdinando Ametrano
 Copyright (C) 2006, 2007 Mark Joshi
 
 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
 <http://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_lmmcurvestate_hpp
#define quantlib_lmmcurvestate_hpp
 
#include <ql/models/marketmodels/curvestate.hpp>
 
namespace QuantLib {
 
 
    class LMMCurveState : public CurveState {
    /* There will n+1 rate times expressing payment and reset times
        of forward rates.
 
                |-----|-----|-----|-----|-----|      (size = 6)
                t0    t1    t2    t3    t4    t5     rateTimes
                f0    f1    f2    f3    f4           forwardRates
                d0    d1    d2    d3    d4    d5     discountBonds
                d0/d0 d1/d0 d2/d0 d3/d0 d4/d0 d5/d0  discountRatios
                sr0   sr1   sr2   sr3   sr4          cotSwaps
    */
      public:
        explicit LMMCurveState(const std::vector<Time>& rateTimes);
 
        void setOnForwardRates(const std::vector<Rate>& fwdRates,
                               Size firstValidIndex = 0);
 
        void setOnDiscountRatios(const std::vector<DiscountFactor>& discRatios,
                                 Size firstValidIndex = 0);
 
 
        Real discountRatio(Size i, Size j) const override;
        Rate forwardRate(Size i) const override;
 
        Rate coterminalSwapRate(Size i) const override;
        Rate coterminalSwapAnnuity(Size numeraire, Size i) const override;
 
        Rate cmSwapRate(Size i, Size spanningForwards) const override;
        Rate cmSwapAnnuity(Size numeraire, Size i, Size spanningForwards) const override;
        const std::vector<Rate>& forwardRates() const override;
        const std::vector<Rate>& coterminalSwapRates() const override;
        const std::vector<Rate>& cmSwapRates(Size spanningForwards) const override;
        std::unique_ptr<CurveState> clone() const override;
 
      private:
        Size first_;
        std::vector<DiscountFactor> discRatios_;
        std::vector<Rate> forwardRates_;
        mutable std::vector<Rate> cmSwapRates_;
        mutable std::vector<Real> cmSwapAnnuities_;
        mutable std::vector<Rate> cotSwapRates_;
        mutable std::vector<Real> cotAnnuities_;
 
        mutable Size firstCotAnnuityComped_;
    };
 
}
 
#endif