Swap2





http://www.QuantTools.com
CapeTools Swaps function list

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

Key TAGs | Excel Index | API Index



Creates a simple FIX vs FLT SWAP object that can be amortised and have stepping up/down margins and coupons.

The swap legs can be in different currencies.

You can specify Quanto features, compounding features or CMS swap indexes within any of the floating legs passed in.

You cannot use this swap object within the Swaption() function (please refer to the Swap() function for this).

You can also specify Exchange of principals (these are optional).

This is needed in the case that the currencies of the two legs are different.

Principal exchanges are entered from the perspective of the FIX leg only.

This function requires the input of a FIX leg object, which must have been produced via a call to one of the following functions : CreateFixedRateLeg(), CreateZeroCouponLeg() or CreateAmortFixLeg(). These functions would have returned a string 'KEY' which is to be passed to the 'FixLeg' parameter of this function.

This function requires the input of a float leg object key, which must have been produced via a call to one of the following functions : CreateFloatLeg(), CreateIALeg(), CreateQLeg(), CreateQIALeg(), CreateAmortIALeg(), CreateAmortQLeg(), CreateAmortQIALeg(), CreateZCFloatLeg(), CreateZCIALeg(), CreateZCQLeg() CreateZCQIALeg() or CreateAmortFloatLeg() functions.

These functions would have returned a string 'KEY' which is to be passed to the 'FloatLeg' parameter of this function.



This function creates an object and returns a string-key value to represent this created object.
The TAG value of the string-key returned (second part of the key) is : "SWPFIXFLT2"



Note: Within Excel, the function is named - CT.SWP.Swap2




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



Parameter Description


  1. Key parameter

    Key value to use as a handle for the created object
  2. Reload parameter

    When creating this object for the first time, set this parameter to a positive value. Within Excel, when re-computing a worksheet where you do not wish to recreate the object, set this parameter to zero (0).
  3. FixLeg parameter

    Key to an already created FIX leg object.
  4. FloatLeg parameter

    Key to an already created FLT leg object.
  5. FXManagerKey parameter

    Optional key to an already created FXManager object.
  6. ReportPVCcy parameter

    Optional currency code that you wish the value of the leg to be reported in (must be specified if the 'FXManagerKey' parameter is specified).


Extended information

Function Syntax

VB Syntax


String CTSwaps.Swap2( _
String Key, _
Long Reload, _
String FixLeg, _
String FloatLeg, _
String FXManagerKey, _
CCYEnum ReportPVCcy)


Excel Spreadsheet Syntax


=CT.SWP.Swap2(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell FixLeg,
Excel String Cell FloatLeg,
Excel String Cell FXManagerKey,
Excel String Cell ReportPVCcy)


C++ Syntax


static std::string Swap2(
std::string Key,
long Reload,
std::string FixLeg,
std::string FloatLeg,
std::string FXManagerKey,
CCYEnum ReportPVCcy);


DotNET Syntax


System.String CTSwapsSA.Swap2(
System.String Key,
System.Int32 Reload,
System.String FixLeg,
System.String FloatLeg,
System.String FXManagerKey,
CTIEnums.CCYEnum ReportPVCcy);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
FixLegStringTRUE
FloatLegStringTRUE
FXManagerKeyStringTRUE
ReportPVCcyCCYEnumFALSE


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
KeyFALSEMySwap
ReloadFALSE1
FixLegFALSEFixLegNAME.EXTTAG.TICKER (from a function call)
FloatLegFALSEFloatLegNAME.EXTTAG.TICKER (from a function call)
FXManagerKeyTRUEFXManagerKeyNAME.EXTTAG.TICKER (from a function call)
ReportPVCcyTRUEGBP


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.Swaps20 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 Swap2() 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 Swap2() function call


MySwap_10.SWPFIXFLT2.0

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