SubOptionBook





http://www.QuantTools.com
CapeTools Exotic Options Tools function list

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

Key TAGs | Excel Index | API Index



Given an option book (created via option book functions within the CapeTools Storage, CapeTools Stock Option Portfolio or CapeTools Futures Option Portfolio category of functions), will create a sub option book according to the users criteria.

The 'Criteria' parameter defines the query and is composed of three columns.

The first is the column name, the second is the lowest value to select, and the third is the highest value to select.

Thus if you wanted to select all deals that composed of between 1 and 100 contracts you can specify a three column range with the values {Units, 1, 100}. To select all 'EUR' trades you can use {Ccy, 'EUR', 'EUR'} You can add additional rows to this criteria (the rows will be And-ed).

The columns of the criteria depend heavily on the type of portfolio passed to the 'PortfolioKey' parameter.

The column names take on the parameter names of the function used to created the portfolio (excluding the 'TradeKey' and 'Reload' parameters).



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



Note: Within Excel, the function is named - CT.EXOT.SubOptionBook




High level graphic of SubOptionBook() 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 sub option book 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. PortfolioKey parameter

    Portoflio Key to an already created FX/Equity/Div/Futures portfolio.
  4. Criteria parameter

    A range of selection criteria. Each row represents the criteria for a particular parameter within the given portfolio.


Extended information

Function Syntax

VB Syntax


String CTOptionBookTools.SubOptionBook( _
String Key, _
Long Reload, _
String PortfolioKey, _
Variant Criteria)


Excel Spreadsheet Syntax


=CT.EXOT.SubOptionBook(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell PortfolioKey,
XLRange Criteria)


C++ Syntax


static std::string SubOptionBook(
std::string Key,
long Reload,
std::string PortfolioKey,
CTRangeDataCPP Criteria);


DotNET Syntax


System.String CTOptionBookToolsSA.SubOptionBook(
System.String Key,
System.Int32 Reload,
System.String PortfolioKey,
CTRangeData Criteria);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
PortfolioKeyStringTRUE
CriteriaRangeFALSE


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
KeyFALSEMySubOptionBook
ReloadFALSE1
PortfolioKeyFALSEPortfolioKeyNAME.EXTTAG.TICKER (from a function call)
CriteriaFALSESubOptionBook_Criteria_Range (creates a range object)


Example range for parameter : Criteria

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

IDDEAL-11DEAL-15

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



CTQL.CTRangeData SubOptionBook_Criteria;


string[] arrBSubOptionBook_Criteria = {
"ID",
"DEAL-11",
"DEAL-15"  //  Array Data

};

CTQL.StringVector arrSubOptionBook_Criteria =
new  CTQL.StringVector(arrBSubOptionBook_Criteria);

// Second parameter determines whether the array is a column array (false) or a row array (true)
SubOptionBook_Criteria = new  CTQL.CTRangeData(arrSubOptionBook_Criteria, true);



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.OptionPortfolios20 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 SubOptionBook() 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 SubOptionBook() function call


MySubOptionBook_5.SUBBK.0

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