GenericLMM_MCPricer Example CPP





http://www.QuantTools.com
CapeTools Generic IR LMM MonteCarlo Pricer function list
GenericLMM_MCPricer function

Welcome | Documentation format | QuantTools Groups | QuantTools Categories | Licence

Key TAGs | Excel Index | API Index



Example C++ Driver function. Preparing the parameters and the final function call (the result).

High level view of the code structure (resulting in the final function call to GenericLMM_MCPricer() )

These are the financial QuantTools function calls that are used within the examples :





The objects generated by these functions are inter-connected in the following way :




C++ Example - GenericLMM_MCPricer




        
    //     ##################################################################################
    //     The first function here GenericLMM_MCPricer(), contains a series of
    //     function calls leading upto the main function call, the second function
    //     within this file ( GenericLMM_MCPricerPart() ).
    //     which contains the answer that we are looking for.

    //     The first function here is simply an example of how to construct the parameters 
    //     in order acquire either a string Key (that is to be passed to other functions) 
    //     or a computed result.

    //     If you are viewing this source code from the chm or web help file you can use the
    //     outlining features to collapse certain sections of the code for better readability. 
    //     ##################################################################################
    

#include <string>
#include <exception>

#include <sstream>
#include <iomanip>

// Point the "additional includes directory" within your editor to the following paths ( where <InstallFolder> is your installation folder)
// <InstallFolder>/Libs/Headers/ (For the library header files)
// <InstallFolder>/Libs/Client/ (For the client helper header and source files)

// The helper files are optional and you can include only those files needed for your functionality
// Each helper header/source file pair corresponds to a single QuantTools category of functions.

// Include QuantTools library header files
#include <QuantTools_all.hpp>

// Include Client Helper QuantTools header files 
#include <QuantToolsClient_all.hpp>

// For Debug builds add a reference to the CTQuantToolsCPPAPI20D.lib
// For Release builds add a reference to the CTQuantToolsCPPAPI20.lib
// You add a reference via the ProjectProperties->Linker->Input menu item

// Some global parameter in order to append to user defined keys.
// We use it here to ensure that we have unique Keys (in the case several of our examples
// use the same key-name)
// In normal use, a user defined string will be used and so this variable will be pointless.

static long nCTLMMMCPricerGlobal = 0;

// Used by parameters that take an optional range value. 
// In Excel we simply omit the value, within the API functions, 
// we pass an empty range object
CTRangeDataCPP oEmptyRange;

std::string szTickedKeyName;
std::ostringstream szTemp;
    
std::string CPP_EX_GenericLMM_MCPricer()
{
    nCTLMMMCPricerGlobal += 1;
            
    std::string szErrorMsg = "";
    
    try
    {


    //    Creates an one dimensional interpolation object.
    

    std::string MyInterpObject1D;
    MyInterpObject1D = 
        InterpObject1DPart();
    
    


    //    Creates an one dimensional interpolation object.
    

    std::string MyInterpObject1D_2;
    MyInterpObject1D_2 = 
        InterpObject1D__2Part();
    
    


    //    Creates a two dimensional interpolation object.
    

    std::string MyInterpObject2D;
    MyInterpObject2D = 
        InterpObject2DPart();
    
    


    //    Creates a two dimensional interpolation object.
    

    std::string MyInterpObject2D_2;
    MyInterpObject2D_2 = 
        InterpObject2D__2Part();
    
    


    //    UK date calendar used within the UK stock exchange.
    

    std::string MyCALUKExchange;
    MyCALUKExchange = 
        CALUKExchangePart();
    
    


    //    EURO calendar used for holiday adjustments.
    

    std::string MyEuroCal;
    MyEuroCal = 
        CALEUROPart();
    
    


    //    Creates a centralized valuation date object.
    

    std::string MyValuationDate;
    MyValuationDate = 
        ValueDateObjPart();
    
    


    //    Creates a Deposit template which is almost identical to a Libor 
    //    Index, but without the YieldCurve information.
    
    std::string MyDepoTPL;
    MyDepoTPL = 
        CreateDepoTemplatePart(
        MyCALUKExchange,
        MyEuroCal);
    
    


    //    Creates a Swap template which is almost identical to the definition 
    //    of the parameters of a swap contract, but without the swap duration, 
    //    buysell, and YieldCurve information.
    
    std::string MySwapTPL;
    MySwapTPL = 
        CreateSwapTemplatePart(
        MyEuroCal,
        MyDepoTPL);
    
    


    //    Creates a yield curve using market rates (No cross-currency 
    //    Swaps).
    
    std::string MyMiniYC;
    MyMiniYC = 
        MKTYC_D__3Part(
        MyValuationDate,
        MyDepoTPL,
        MySwapTPL);
    
    


    //    Creates a new Index code.
    
    std::string MyNewIndex2;
    MyNewIndex2 = 
        CreateIndex__2Part(
        MyCALUKExchange,
        MyEuroCal,
        MyMiniYC);
    
    


    //    Creates a Libor Forward Model Process container object.
    
    std::string MyLMMProcess2;
    MyLMMProcess2 = 
        LMMProcess2Part(
        MyNewIndex2);
    
    


    //    Creates a an extended linear-exponential volatility model for 
    //    the libor market model.
    
    std::string My3rdLMMLinearExpVolModel2;
    My3rdLMMLinearExpVolModel2 = 
        LMMLinearExpVolModel2__3Part(
        MyLMMProcess2);
    
    


    //    Creates an extended exponential correlation model for the libor 
    //    market model.
    
    std::string My2ndLMMLinearExpCorrModel2;
    My2ndLMMLinearExpCorrModel2 = 
        LMMLinearExpCorrModel2__2Part(
        MyLMMProcess2);
    
    


    //    Given volatility and correlation specification objects, creates 
    //    a Libor Forward Market Simulation Process object to be used 
    //    within the 'CapeTools LMM Process Simulation' or 'CapeTools 
    //    Generic IR LMM MonteCarlo Pricer' category of functions.
    
    std::string MyLMMSimProcess;
    MyLMMSimProcess = 
        LMMSimProcessPart(
        MyLMMProcess2,
        My3rdLMMLinearExpVolModel2,
        My2ndLMMLinearExpCorrModel2);
    
    


    //    Creates a generic pricing monte carlo object given a process 
    //    object and a pricing grid.
    
    std::string MyGenericLMM_MCPricer;
    MyGenericLMM_MCPricer = 
        GenericLMM_MCPricerPart(
        MyLMMSimProcess,
        MyInterpObject1D,
        MyInterpObject1D_2,
        MyInterpObject2D,
        MyInterpObject2D_2);
    
    // This is the result we are looking for.
    return MyGenericLMM_MCPricer;
    

    }
    catch(std::exception e)
    {
        szErrorMsg = e.what();
        throw;
    }
    catch(...)
    {
        throw;
    }
                        
}                
        


// ///////////////////////////////////////////////////////////////////

std::string GenericLMM_MCPricerPart(
        std::string MyLMMSimProcess,
        std::string MyInterpObject1D,
        std::string MyInterpObject1D_2,
        std::string MyInterpObject2D,
        std::string MyInterpObject2D_2)
{

        //  Create example range for parameter GenericLMM_MCPricer_PayOffTable
        CTRangeDataCPP GenericLMM_MCPricer_PayOffTable;
            
        // We could set the value for each cell individually, but for display
        // purposes, this is quicker and more informative.
        GenericLMM_MCPricer_PayOffTable.RangeFromStr
         (    
        "{"
        "#21/Jul/2006#     |      |      |      |  ;"
        "#23/Oct/2006#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#22/Jan/2007#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#23/Apr/2007#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#23/Jul/2007#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#22/Oct/2007#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Jan/2008#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Apr/2008#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Jul/2008#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Oct/2008#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Jan/2009#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Apr/2009#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Jul/2009#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Oct/2009#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Jan/2010#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Apr/2010#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Jul/2010#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Oct/2010#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Jan/2011#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Apr/2011#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     |  ;"
        "#21/Jul/2011#     | Libor(cRow) + _a     | Interp1D(1,cRow)     | GridRowSum(cRow, cCol-2, cCol-1)     | max(GridColMin(cCol-1, 1, cRow) - LiborMin(1, cRow), 0.0) * DCF(cRow) * Cvg(cRow)"
        "}"
         );
                
        //  Create example range for parameter GenericLMM_MCPricer_ConstParams
        CTRangeDataCPP GenericLMM_MCPricer_ConstParams;
            
        // We could set the value for each cell individually, but for display
        // purposes, this is quicker and more informative.
        GenericLMM_MCPricer_ConstParams.RangeFromStr
         (    
        "{"
        "_a     | 0.0001 ;"
        "_b     | 20 ;"
        "_c     | 2.5 ;"
        "_var1     | 40"
        "}"
         );
                


        std::ostringstream szTemp; szTemp.str("");
        szTemp << std::setw(0) << nCTLMMMCPricerGlobal;


    //    Key value to use as a handle for the created object
        std::string MyGenericLMM_MCPricer = std::string("MyGenericLMM_MCPricer") + std::string("_") + szTemp.str();
    
             

    //    When creating this object for the first time, set this parameter 
    //    to a positive value.
        long Reload = 1;
             

    //    With the PayOff table, the first column represents event dates.
        bool ValidateDates = false;
             

    //    The number of simulations.
        long NoOfSims = 10;

                    
    //  Excel function call would be this - "CT.PRO.GenericLMM_MCPricer()"

    //    Creates a generic pricing monte carlo object given a process 
    //    object and a pricing grid.
        std::string rGenericLMM_MCPricer;
                                                                                                                        
        rGenericLMM_MCPricer = CTLMMMCPricerSA::GenericLMM_MCPricer(
                MyGenericLMM_MCPricer,
                Reload,
                MyLMMSimProcess,
                GenericLMM_MCPricer_PayOffTable,
                ValidateDates,
                NoOfSims,
                GenericLMM_MCPricer_ConstParams,
                MyInterpObject1D,
                MyInterpObject1D_2,
                MyInterpObject2D,
                MyInterpObject2D_2);


    return rGenericLMM_MCPricer;
}        








Copyright (c) 2003-2007 CapeTools - All Rights Reserved.