LMMDisplayStep Example CPP

C++ Example - LMMDisplayStep

// ##################################################################################

// The first function here LMMDisplayStep(), contains a series of

// function calls leading upto the main function call, the second function

// within this file ( LMMDisplayStepPart() ).

// 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 nCTLMMProcessSimGlobal = 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;

CTRangeData CPP_EX_LMMDisplayStep()

{

nCTLMMProcessSimGlobal += 1;

std::string szErrorMsg = "";

try

{

// 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);

// Displays the value of the LIBOR rates at a particular time step

// across all simulations.

CTRangeData resLMMDisplayStep;

resLMMDisplayStep =

LMMDisplayStepPart(

MyLMMSimProcess);

// This is the result we are looking for.

return resLMMDisplayStep;

}

catch(std::exception e)

{

szErrorMsg = e.what();

throw;

}

catch(...)

{

throw;

}

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

CTRangeData LMMDisplayStepPart(

std::string MyLMMSimProcess)

{

// The index within the TimeLine range passed into the LMM Process

// object (1-based).

long TimeStep = 1;

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

// Displays the value of the LIBOR rates at a particular time step

// across all simulations.

CTRangeData rLMMDisplayStep;

rLMMDisplayStep = CTLMMProcessSimSA::LMMDisplayStep(

MyLMMSimProcess,

TimeStep);

return rLMMDisplayStep;

}