simmconfigurationcalibration.hpp

Go to the documentation of this file.

/*
 Copyright (C) 2023 Quaternion Risk Management Ltd.
 All rights reserved.
 
 This file is part of ORE, a free-software/open-source library
 for transparent pricing and risk analysis - http://opensourcerisk.org
 
 ORE is free software: you can redistribute it and/or modify it
 under the terms of the Modified BSD License.  You should have received a
 copy of the license along with this program.
 The license is also available online at <http://opensourcerisk.org>
 
 This program is distributed on the basis that it will form a useful
 contribution to risk analytics and model standardisation, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 FITNESS FOR A PARTICULAR PURPOSE. See the license for more details.
*/
 
/*! \file orea/simm/simmconfigurationcalibration.hpp
    \brief SIMM configuration built for SIMM calibration
*/
 
#pragma once
 
 
#include <orea/simm/simmconfigurationbase.hpp>
 
namespace ore {
namespace analytics {
 
/*! Class giving the SIMM configuration as outlined in the document
    <em>ISDA SIMM Methodology, version 2.6.
        Effective Date: December 2, 2023.</em>
*/
class SimmConfigurationCalibration : public SimmConfigurationBase {
public:
    SimmConfigurationCalibration(const QuantLib::ext::shared_ptr<SimmBucketMapper>& simmBucketMapper,
                                 const QuantLib::ext::shared_ptr<SimmCalibration>& simmCalibration,
                                 const QuantLib::Size& mporDays = 10,
                                 const std::string& name = "SIMM Calibration");
 
    //! Return the SIMM <em>Label2</em> value for the given interest rate index
    std::string label2(const QuantLib::ext::shared_ptr<QuantLib::InterestRateIndex>& irIndex) const override;
 
    //! Add SIMM <em>Label2</em> values under certain circumstances.
    void addLabels2(const CrifRecord::RiskType& rt, const std::string& label_2) override;
 
    QuantLib::Real curvatureMarginScaling() const override;
 
    QuantLib::Real weight(const CrifRecord::RiskType& rt, boost::optional<std::string> qualifier = boost::none,
                          boost::optional<std::string> label_1 = boost::none,
                          const std::string& calculationCurrency = "") const override;
 
    QuantLib::Real correlation(const CrifRecord::RiskType& firstRt, const std::string& firstQualifier,
                               const std::string& firstLabel_1, const std::string& firstLabel_2,
                               const CrifRecord::RiskType& secondRt, const std::string& secondQualifier,
                               const std::string& secondLabel_1, const std::string& secondLabel_2,
                               const std::string& calculationCurrency = "") const override;
    
    virtual bool isSimmConfigCalibration() const override { return true; }
 
private:
    //! Find the group of the \p qualifier
    std::string group(const std::string& qualifier, const std::map<std::string, std::set<std::string>>& groups) const;
 
    /*! Map giving a currency's FX Volatility group (High or Regular). This concept
        was introduced in ISDA Simm 2.2
     */
    std::map<std::string, std::set<std::string>> ccyGroups_;
 
    //! IR Historical volatility ratio
    QuantLib::Real hvr_ir_;
};
 
} // namespace analytics
} // namespace ore