CDSAccPremUponDefault





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

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

Key TAGs | Excel Index | API Index



Returns the Accrued Premium (upon default) array for each premium period from a Credit Default Swap object.

If however the contract is defined as not paying any accrued premium upon default, this array will contain zeros.

This function requires the input of a Credit Default Swap object key, which must have been produced via a call to one of the following functions : CDSwapObj() or CDBinarySwapObj(). These functions would have returned a string 'KEY' which is to be passed to the 'CDSObject' parameter of this function.



Note: Within Excel, the function is named - CT.CDS.AccPremUponDefault




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



Parameter Description


  1. CDSObject parameter

    Key to an already constructed Credit Default Swap object.


Extended information

Function Syntax

VB Syntax


Variant CTCreditDefaultSwaps.CDSAccPremUponDefault( _
String CDSObject)


Excel Spreadsheet Syntax


=CT.CDS.AccPremUponDefault(
Excel String Cell CDSObject)


C++ Syntax


static CTRangeDataCPP CDSAccPremUponDefault(
std::string CDSObject);


DotNET Syntax


CTRangeData CTCreditDefaultSwapsSA.CDSAccPremUponDefault(
System.String CDSObject);

Parameter data types

ArgNameArgTypeIsKey
CDSObjectStringTRUE


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
CDSObjectFALSECDSObjectNAME.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.CreditDerivatives20 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 CDSAccPremUponDefault() 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 CDSAccPremUponDefault() function call


Example
38919390130
39013391040
39104391950
39195392860
39286393770
39377394680
39468395590
39559396500
39650397420
39742398340
39834399240
39924400150
40015401070
40107401990
40199402890
40289403800
40380404720
40472405640
40564406540
40654407450



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