Swap





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.

Both legs must be in the same currency.

However you cannot specify Quanto features, Compounding features or CMS swap indexes within any of the legs passed in.

To specify those features please refer to the Swap2 function.

The swap Key generated here, is to be used within the Swaption() function call.

However if one wishes to price or query the features of a swap with the limitations that this function possesses, this object can be used.

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() 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() or CreateAmortFloatLeg() functions.

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

The discounting curve is retrieved from the fixleg object.



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 : "SWPFIXFLT"



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




High level graphic of Swap() 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.


Extended information

Function Syntax

VB Syntax


String CTSwaps.Swap( _
String Key, _
Long Reload, _
String FixLeg, _
String FloatLeg)


Excel Spreadsheet Syntax


=CT.SWP.Swap(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell FixLeg,
Excel String Cell FloatLeg)


C++ Syntax


static std::string Swap(
std::string Key,
long Reload,
std::string FixLeg,
std::string FloatLeg);


DotNET Syntax


System.String CTSwapsSA.Swap(
System.String Key,
System.Int32 Reload,
System.String FixLeg,
System.String FloatLeg);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
FixLegStringTRUE
FloatLegStringTRUE


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)


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 Swap() 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 Swap() function call


MySwap_9.SWPFIXFLT.0

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