LMMDisplayStep Example Java





http://www.QuantTools.com
CapeTools LMM Process Simulation function list
LMMDisplayStep function

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

Key TAGs | Excel Index | API Index



Example Java 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 LMMDisplayStep() )

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 :




Java 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. 
    //     ##################################################################################
        

public class Java_EX_LMMDisplayStep()
{
    static 
    {
        try 
        {
            System.loadLibrary("CTQuantToolsAPI20");
        } 
        catch (UnsatisfiedLinkError e) 
        {
            System.err.println("Native code library failed to load. Make sure that the CTQuantToolsAPI20.dll is installed correctly.\n" + e);
            System.exit(1);
        }
    }

    static int nCTLMMProcessSimGlobal = 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();
    static String szTickedKeyName;
                

    public static CTRangeData Java_EX_LMMDisplayStep(String argv[])
    {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
    nCTLMMProcessSimGlobal += 1;
            
    String szErrorMsg = "";

    try
    {



    //    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 centralized valuation date object.
    

    String MyValuationDate;
    MyValuationDate = 
        ValueDateObjPart();
    
    


    //    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 MyMiniYC;
    MyMiniYC = 
        MKTYC_D__3Part(
        MyValuationDate,
        MyDepoTPL,
        MySwapTPL);
    
    


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


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


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


    //    Creates an extended exponential correlation model for the libor 
    //    market model.
    
    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.
    
    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(Exception e)
    {
        szErrorMsg = e.getMessage();
        System.exit(1);
    }
                    
}                
        


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

private static CTRangeData LMMDisplayStepPart(
    String MyLMMSimProcess)
{
    // Used by functions returning a range value. Via the szRangeDescription variable, you can inspect the results
    int _nRows, _nCols;
    String szRangeDescription;




    //    The index within the TimeLine range passed into the LMM Process 
    //    object (1-based).
        int 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 = (CTRangeData)CTQL.CTLMMProcessSimSA.LMMDisplayStep(
                MyLMMSimProcess,
                TimeStep);
    
        _nRows = rLMMDisplayStep.GetRows();
        _nCols = rLMMDisplayStep.GetCols();
        szRangeDescription = rLMMDisplayStep.ToMatrixString();



    return rLMMDisplayStep;

}        








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