AmortiseGeneralDB2





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

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

Key TAGs | Excel Index | API Index



Produces an Amortised schedule based on the general-declining balance calculation [ Depreciation for PeriodN = (({Notional}-{FinalNot}) - Total depreciation from prior periods) * ({Factor} divided by {NumOfPeriods}) ]. If you use a factor of 2, the calculation will be based on a double-declining balance calculation.

Returns a three column range object, Balance, Depreciation and Cumulative Depreciation.

You can indicate an ending notional and whether you would like to repeat notional amounts (ie - useful for the cases where you are comparing notional amounts for two legs that have been built on two different frequencies, Semi-Annual and Quarterly.

You probably want the Quarterly notional amounts to be repeated twice in order to match the notional amounts of the leg build using the semi-annual frequency).

This function requires the input of a Schedule object key, which must have been produced via a call to one of the following functions : MakeSchedule() or MakeSchedule2(). These functions would have returned a string 'KEY' which is to be passed to the 'ScheduleKey' parameter of this function.



Note: Within Excel, the function is named - CT.UTIL.AmortiseGeneralDB2




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



Parameter Description


  1. Notional parameter

    Initial notional amount. Amortisation function will control the generation of notional for following cash flows.
  2. FinalNot parameter

    Final Notional is the value at the end of the depreciation . Normally zero (0).
  3. NumPeriods parameter

    Number of periods over which the asset is depreciated (sometimes called the useful life of the asset).
  4. dFactor parameter

    Is the rate at which the balance declines. A factor of 2 imply the double-declining balance method.
  5. nRepeatNot parameter

    The number of times you would like to repeat the Notional amounts computed (normally 1).
  6. ShortFirstPeriod parameter

    Indicates whether the very first period is a short (stub) period.


Extended information

Function Syntax

VB Syntax


Variant CTUtils.AmortiseGeneralDB2( _
Double Notional, _
Double FinalNot, _
Long NumPeriods, _
Double dFactor, _
Long nRepeatNot, _
Boolean ShortFirstPeriod)


Excel Spreadsheet Syntax


=CT.UTIL.AmortiseGeneralDB2(
Excel Numeric Cell Notional,
Excel Numeric Cell FinalNot,
Excel Numeric Cell NumPeriods,
Excel Numeric Cell dFactor,
Excel Numeric Cell nRepeatNot,
Excel Boolean Value Cell ShortFirstPeriod)


C++ Syntax


static CTRangeDataCPP AmortiseGeneralDB2(
double Notional,
double FinalNot,
long NumPeriods,
double dFactor,
long nRepeatNot,
bool ShortFirstPeriod);


DotNET Syntax


CTRangeData CTUtilsSA.AmortiseGeneralDB2(
System.Double Notional,
System.Double FinalNot,
System.Int32 NumPeriods,
System.Double dFactor,
System.Int32 nRepeatNot,
System.Boolean ShortFirstPeriod);

Parameter data types

ArgNameArgTypeIsKey
NotionalDoubleFALSE
FinalNotDoubleFALSE
NumPeriodsLongFALSE
dFactorDoubleFALSE
nRepeatNotLongFALSE
ShortFirstPeriodBooleanFALSE


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
NotionalFALSE5000000
FinalNotFALSE1000000
NumPeriodsFALSE10
dFactorFALSE2.0
nRepeatNotFALSE2
ShortFirstPeriodFALSEfalse


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.Utils20 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 AmortiseGeneralDB2() 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.


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


Example
BalanceDepreciationCumDepreciation
5e+00600
5e+00600
2.5e+0062.5e+0062.5e+006
2.5e+0062.5e+0062.5e+006
1.25e+0061.25e+0063.75e+006
1.25e+0061.25e+0063.75e+006
1e+0062500004e+006
1e+0062500004e+006
1e+00604e+006
1e+00604e+006



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