IRStepMonteCarlo Example CPPNET





http://www.QuantTools.com
CapeTools (Compact) IR Process Simulation function list
IRStepMonteCarlo function

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

Key TAGs | Excel Index | API Index



Example C++.NET 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 IRStepMonteCarlo() )

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++.NET Example - IRStepMonteCarlo





    //     ##################################################################################
    //     The first function here IRStepMonteCarlo(), contains a series of
    //     function calls leading upto the main function call, the second function
    //     within this file ( IRStepMonteCarloPart() ).
    //     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. 
    //     ##################################################################################
        

#using <mscorlib.dll>


// If you add a reference via the Visual Studio project, 
// then the following line is not needed.
#using <QuantToolsNET.v2.dll> 

using namespace System;

// 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 int nCTIRProcessSimCGlobal = 0;
    
// Used by function parameters that take an optional range value. 
// In Excel we simply omit the value, within the API functions, 
// we pass an empty range object
static CTQL::CTRangeData* oEmptyRange = new CTQL::CTRangeData();
    
public: String* CPPNET_EX_IRStepMonteCarlo()
{
    nCTIRProcessSimCGlobal += 1;

    String* szErrorMsg = "";
    
    try
    {


    //    Creates a centralized valuation date object.


    String* MyValuationDate;
    MyValuationDate = 
        ValueDateObjPart();
    
    


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


    String* MyCALUKExchange;
    MyCALUKExchange = 
        CALUKExchangePart();
    
    


    //    EURO calendar used for holiday adjustments.


    String* MyEuroCal;
    MyEuroCal = 
        CALEUROPart();
    
    


    //    Creates a Deposit template which is almost identical to a Libor 
    //    Index, but without the YieldCurve information.

    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.

    String* MySwapTPL;
    MySwapTPL = 
        CreateSwapTemplatePart(
        MyEuroCal,
        MyDepoTPL);
    
    


    //    Creates a yield curve using market rates (No cross-currency 
    //    Swaps).

    String* MyYCInterpOnDCF;
    MyYCInterpOnDCF = 
        MKTYC_DPart(
        MyValuationDate,
        MyDepoTPL,
        MySwapTPL);
    
    


    //    Creates a new Index code.

    String* MyNewIndex;
    MyNewIndex = 
        CreateIndexPart(
        MyCALUKExchange,
        MyEuroCal,
        MyYCInterpOnDCF);
    
    


    //    Creates a Single-factor Hull-White (extended Vasicek) Forward 
    //    ShortRate Model process object.

    String* MyHullWhite1FProcess;
    MyHullWhite1FProcess = 
        HullWhite1FProcessPart(
        MyNewIndex,
        MyYCInterpOnDCF);
    
    


    //    Creates a Interest Rate Step Monte Carlo object given a process 
    //    object and a time line dates array.

    String* MyIRStepMonteCarlo;
    MyIRStepMonteCarlo = 
        IRStepMonteCarloPart(
        MyHullWhite1FProcess,
        MyValuationDate);
    
    // This is the result we are looking for.
    return MyIRStepMonteCarlo;
    

    }
    catch(Exception e)
    {
        szErrorMsg = e.Message;
        throw e;
    }
}                
        


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

private: String* IRStepMonteCarloPart(
    String* MyHullWhite1FProcess,
    String* MyValuationDate)
{

        //  Create example range for parameter IRStepMonteCarlo_MandatoryDates
        CTQL::CTRangeData* IRStepMonteCarlo_MandatoryDates;    
        

        Int32 arrBIRStepMonteCarlo_MandatoryDates[] = { 
            CTQL::Date::serialNumber(S"19/7/2005", S"dd/mm/yyyy"), 
            CTQL::Date::serialNumber(S"19/1/2006", S"dd/mm/yyyy"), 
            CTQL::Date::serialNumber(S"19/7/2006", S"dd/mm/yyyy"), 
            CTQL::Date::serialNumber(S"19/1/2007", S"dd/mm/yyyy"), 
            CTQL::Date::serialNumber(S"19/7/2007", S"dd/mm/yyyy"), 
            CTQL::Date::serialNumber(S"19/1/2008", S"dd/mm/yyyy"), 
            CTQL::Date::serialNumber(S"19/7/2008", S"dd/mm/yyyy"), 
            CTQL::Date::serialNumber(S"19/1/2009", S"dd/mm/yyyy"), 
            CTQL::Date::serialNumber(S"19/7/2009", S"dd/mm/yyyy"), 
            CTQL::Date::serialNumber(S"19/1/2010", S"dd/mm/yyyy"), 
            CTQL::Date::serialNumber(S"19/7/2010", S"dd/mm/yyyy"), 
            CTQL::Date::serialNumber(S"19/1/2011", S"dd/mm/yyyy")  //  Array Data
        
        };
        
        CTQL::IntVector* arrIRStepMonteCarlo_MandatoryDates = 
            new  CTQL::IntVector(__try_cast<Array*>(arrBIRStepMonteCarlo_MandatoryDates));
    
        // Second parameter determines whether the array is a column array (false) or a row array (true)
        IRStepMonteCarlo_MandatoryDates = new  CTQL::CTRangeData(arrIRStepMonteCarlo_MandatoryDates, false);
            



    //    Key value to use as a handle for the created object
        String* MyIRStepMonteCarlo = String::Format(S"{0}_{1}", S"MyIRStepMonteCarlo", System::Convert::ToString(nCTIRProcessSimCGlobal));


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


    //    Used to calculate time in years.
        CTQL::CTIEnums::DayCountEnum dayCounter = CTQL::CTIEnums::DayCountEnum::DayCount_30360;


    //    The minimum number of steps that the discretization of the 'MandatoryDates' 
    //    parameter will take.
        int MinNoOfSteps = 50;


    //    The random generator type to use.
        String* MCMethod = S"Pseudo";


    //    Seed value.
        int Seed = 0;

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

    //    Creates a Interest Rate Step Monte Carlo object given a process 
    //    object and a time line dates array.
        String* rIRStepMonteCarlo;
                                        
        rIRStepMonteCarlo = CTQL::CTIRProcessSimCSA->IRStepMonteCarlo(
                MyIRStepMonteCarlo,
                Reload,
                MyHullWhite1FProcess,
                MyValuationDate,
                dayCounter,
                IRStepMonteCarlo_MandatoryDates,
                MinNoOfSteps,
                MCMethod,
                Seed);


    return rIRStepMonteCarlo;
}        








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