IVCapFloorPortfolio




http://www.QuantTools.com
CapeTools CapFloor Portfolio function list

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

Key TAGs | Excel Index | API Index


Creates a CapFloor portfolio object for the solving of implied volatilites.

A discounting yieldcurve object will be associated with each Cap/Floor object once created.

A 'Key' string value will be returned on a successful creation of the CapFloor portfolio 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 : "IVFBOOKCF"



Note: Within Excel, the function is named - CT.BOOK.IVCapFloorPortfolio


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



Parameter Description


  1. Key parameter

    Key Handle to be used for the new IV CapFloor Portfolio 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. GroupedIndex parameter

    Key to an already constructed GroupedIndex object. This object is needed in order to extract the necessary index objects needed for pricing. CMS index objects are not supported for CapFloor deals.
  4. YCKey parameter

    Key to an already constructed YieldCurve object. This curve will be used for discounting.
  5. CFRange parameter

    A 8 column CapFloor range : 'CapFloorName', 'Premium', 'CapFloor', 'StartDate', 'EndDate', 'Notional', 'Strike', 'IndexCode' and 'Margin'. The range must contain the titles (detailed within the previous paragraph) for each column.


Extended information

Function Syntax

VB Syntax 


String CTCFPortfolio.IVCapFloorPortfolio( _
String Key, _
Long Reload, _
String GroupedIndex, _
String YCKey, _
Variant CFRange)


Excel Spreadsheet Syntax 


=CT.BOOK.IVCapFloorPortfolio(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell GroupedIndex,
Excel String Cell YCKey,
XLRange CFRange)


C++ Syntax 


static std::string IVCapFloorPortfolio(
std::string Key,
long Reload,
std::string GroupedIndex,
std::string YCKey,
CTRangeDataCPP CFRange);


DotNET Syntax 


System.String CTCFPortfolioSA.IVCapFloorPortfolio(
System.String Key,
System.Int32 Reload,
System.String GroupedIndex,
System.String YCKey,
CTRangeData CFRange);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
GroupedIndexStringTRUE
YCKeyStringTRUE
CFRangeRangeFALSE

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
KeyFALSEMyIVCapFloorPortfolio
ReloadFALSE1
GroupedIndexFALSEGroupedIndexNAME.EXTTAG.TICKER (from a function call)
YCKeyFALSEYCKeyNAME.EXTTAG.TICKER (from a function call)
CFRangeFALSEIVCapFloorPortfolio_CFRange_Range (creates a range object)


Example range for parameter : CFRange

Within Excel, a range such as this can be passed directly into the CFRange parameter.

CapFloorNamePremiumCapFloorStartDateEndDateNotionalStrikeIndexCodeMargin
CF-1234563894330.2floor21/Jul/201121/Jul/2016500000005.17EURLIBOR3M0.0002
CF : 21-Jul-2012 / 5.28%3428953.47floor21/Jul/201221/Jul/2017500000005.28EURLIBOR1M0.0002
CF : 21-Jul-2013 / 5.38%3300377.31floor21/Jul/201321/Jul/2018500000005.38EURLIBOR1M0.0002
CF : 21-Jul-2014 / 5.51%3181521.95floor21/Jul/201421/Jul/2019500000005.51EURLIBOR6M0.0002
CF : 21-Jul-2015 / 5.66%3956794.44floor21/Jul/201521/Jul/2020500000005.66EURLIBOR6M0.0002
CF : 21-Jul-2016 / 5.79%353898.32cap21/Jul/201621/Jul/2021100000005.79EURLIBOR12M0.0002
CF : 21-Jul-2017 / 5.98%372130.86cap21/Jul/201721/Jul/2022100000005.98EURLIBOR12M0.0002
CF : 21-Jul-2018 / 6.14%384588.06cap21/Jul/201821/Jul/2023100000006.14EURLIBOR3M0.0002
CF : 21-Jul-2019 / 6.33%381981.1cap21/Jul/201921/Jul/2024100000006.33EURLIBOR3M0.0002
CF : 21-Jul-2020 / 6.5%376023.42cap21/Jul/202021/Jul/2025100000006.5EURLIBOR6M0.0002
CF : 21-Jul-2021 / 6.6%429948.18cap21/Jul/202121/Jul/2026100000006.6EURLIBOR6M0.0002

Example C# API usage for setting the range data for parameter : CFRange 


CTQL.CTRangeData IVCapFloorPortfolio_CFRange = new CTQL.CTRangeData();

System.Text.StringBuilder IVCapFloorPortfolio_CFRange_builder =
new System.Text.StringBuilder(100);

IVCapFloorPortfolio_CFRange_builder.Append("{");
IVCapFloorPortfolio_CFRange_builder.Append("CapFloorName	 | Premium	 | CapFloor	 | StartDate	 | EndDate	 | Notional	 | Strike	 | IndexCode	 | Margin ;");
IVCapFloorPortfolio_CFRange_builder.Append("CF-123456	 | 3894330.2	 | floor	 | #21/Jul/2011#	 | #21/Jul/2016#	 | 50000000	 | 5.17	 | EURLIBOR3M	 | 0.0002 ;");
IVCapFloorPortfolio_CFRange_builder.Append("CF : 21-Jul-2012 / 5.28%	 | 3428953.47	 | floor	 | #21/Jul/2012#	 | #21/Jul/2017#	 | 50000000	 | 5.28	 | EURLIBOR1M	 | 0.0002 ;");
IVCapFloorPortfolio_CFRange_builder.Append("CF : 21-Jul-2013 / 5.38%	 | 3300377.31	 | floor	 | #21/Jul/2013#	 | #21/Jul/2018#	 | 50000000	 | 5.38	 | EURLIBOR1M	 | 0.0002 ;");
IVCapFloorPortfolio_CFRange_builder.Append("CF : 21-Jul-2014 / 5.51%	 | 3181521.95	 | floor	 | #21/Jul/2014#	 | #21/Jul/2019#	 | 50000000	 | 5.51	 | EURLIBOR6M	 | 0.0002 ;");
IVCapFloorPortfolio_CFRange_builder.Append("CF : 21-Jul-2015 / 5.66%	 | 3956794.44	 | floor	 | #21/Jul/2015#	 | #21/Jul/2020#	 | 50000000	 | 5.66	 | EURLIBOR6M	 | 0.0002 ;");
IVCapFloorPortfolio_CFRange_builder.Append("CF : 21-Jul-2016 / 5.79%	 | 353898.32	 | cap	 | #21/Jul/2016#	 | #21/Jul/2021#	 | 10000000	 | 5.79	 | EURLIBOR12M	 | 0.0002 ;");
IVCapFloorPortfolio_CFRange_builder.Append("CF : 21-Jul-2017 / 5.98%	 | 372130.86	 | cap	 | #21/Jul/2017#	 | #21/Jul/2022#	 | 10000000	 | 5.98	 | EURLIBOR12M	 | 0.0002 ;");
IVCapFloorPortfolio_CFRange_builder.Append("CF : 21-Jul-2018 / 6.14%	 | 384588.06	 | cap	 | #21/Jul/2018#	 | #21/Jul/2023#	 | 10000000	 | 6.14	 | EURLIBOR3M	 | 0.0002 ;");
IVCapFloorPortfolio_CFRange_builder.Append("CF : 21-Jul-2019 / 6.33%	 | 381981.1	 | cap	 | #21/Jul/2019#	 | #21/Jul/2024#	 | 10000000	 | 6.33	 | EURLIBOR3M	 | 0.0002 ;");
IVCapFloorPortfolio_CFRange_builder.Append("CF : 21-Jul-2020 / 6.5%	 | 376023.42	 | cap	 | #21/Jul/2020#	 | #21/Jul/2025#	 | 10000000	 | 6.5	 | EURLIBOR6M	 | 0.0002 ;");
IVCapFloorPortfolio_CFRange_builder.Append("CF : 21-Jul-2021 / 6.6%	 | 429948.18	 | cap	 | #21/Jul/2021#	 | #21/Jul/2026#	 | 10000000	 | 6.6	 | EURLIBOR6M	 | 0.0002");
IVCapFloorPortfolio_CFRange_builder.Append("}");

// Parse the string into the Range object.
IVCapFloorPortfolio_CFRange.RangeFromStr( IVCapFloorPortfolio_CFRange_builder.ToString() );


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.IRPortfolio20 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 IVCapFloorPortfolio() 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 IVCapFloorPortfolio() function call


MyIVCapFloorPortfolio_1.IVFBOOKCF.0

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