XCcySwap





http://www.QuantTools.com
CapeTools Query Curves function list

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

Key TAGs | Excel Index | API Index



Returns the spread on the non-dollar leg of a XCcySwap against the neutral dollar leg.

The YieldCurve passed in must have been created by one of the XCcy yieldcurve stripper functions which incorporates basis swap against the dollar (see the CapeTools XCCY Curves category of functions).

If you use any other yieldcurve object, you are assuming no spread between the index and the dollar and thus the basis swap value will be zero.



Note: Within Excel, the function is named - CT.MKT.XCcySwap




High level graphic of XCcySwap() function with parameters. Blue square node is the actual function with the parameters ordered.



Parameter Description


  1. Start parameter

    Start date of the swap
  2. EndDate parameter

    End date of the swap
  3. XCcyCurve parameter

    Key to an constructed XCcy YieldCurve object.


Extended information

Function Syntax

VB Syntax


Double CTQryCurves.XCcySwap( _
Long Start, _
Long EndDate, _
String XCcyCurve)


Excel Spreadsheet Syntax


=CT.MKT.XCcySwap(
Excel Numeric Cell Start,
Excel Numeric Cell EndDate,
Excel String Cell XCcyCurve)


C++ Syntax


static double XCcySwap(
long Start,
long EndDate,
std::string XCcyCurve);


DotNET Syntax


System.Double CTQryCurvesSA.XCcySwap(
System.Int32 Start,
System.Int32 EndDate,
System.String XCcyCurve);

Parameter data types

ArgNameArgTypeIsKey
StartLongFALSE
EndDateLongFALSE
XCcyCurveStringTRUE


Example Inputs

The first column represents the name of the parameters. The second column specifies whether the parameters are optional or not. Finally the last column provides some sample input data.
Function call input string-keys are always in the format : "NAME.EXTTAG.TICKER" The "EXTTAG.TICKER" part is determined from the output of other, capetools, object creation functions.


ArgNameIsOptional (Excel only)Example
StartFALSE21/Jul/2006 (serial date type)
EndDateFALSE21/Jul/2011 (serial date type)
XCcyCurveFALSEXCcyCurveNAME.EXTTAG.TICKER (from a function call)


Example function usage


The C# example below contains all the sub-function calls leading up to this function call. As a result, the example can contain a lot of code.

The VB.NET, J#, C++.NET, Java, Excel VBA, Visual Basic 6 (via COM) and C++ examples below contain function code stubs for the calls leading up to this function call. However, the function call for this function is displayed.
You can easily reproduce the stub functions code from the C# example.


If you are accessing this functrion via the MiniXL libraries, this function is present within the CT.QL.Curves20 MiniXL Excel Addin.

Within our Excel Example Addin Generator, we have used the following QuantTools sub-functions in order to prepare the arguments needed to call the XCcySwap() function. If you are executing this function via the MiniXL libraries, the module addin name, (in brackets, to the right of the sub-functions listed below), indicates the MiniXL library in which the sub-function is held. You will need to load this library into your Excel session (along with any other libraries that the sub-function call within the addin requires (ie - CT.QT.Utils20 addin in almost all cases) in order for the example to compute successfully.

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





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




The following four examples demostrate calling this function within a Microsoft .NET environment

The following four examples demostrate calling this function within a non .NET environment

The following is a sample output from executing the XCcySwap() function call


-0.000319406171182995

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