Reuters Pppro Function Reference
Reuters Pppro Function Reference
Reuters PowerPlus Pro 4.5.1 Function Reference Guide, Document Number 450531.3, 4 August 2003
Document History
History
Document Date
Number
Comments
450531.3
4 August 2003
450531.2
3 June 2003
450531.1
23 May 2003
4 August 2003
4 August 2003
TA B L E O F C O N T E N TS
Part I:
Introduction
Chapter 1
Part II:
Reuters Adfin Realtime
Chapter 2
Chapter 3
Part III:
Reuters Adfin Bonds
Chapter 4
4 August 2003
Table of Contents
AdBondSpread ............................................................................................................................................ 38
AdBondYield ............................................................................................................................................... 39
BdCalcCpn .................................................................................................................................................. 39
BdCashFlows .............................................................................................................................................. 40
BdConvFactor ............................................................................................................................................. 40
BdCpnCrv ................................................................................................................................................... 41
BdCpnValue ................................................................................................................................................ 41
BdIrsStructure ............................................................................................................................................. 42
BdPvbpCrv .................................................................................................................................................. 42
BdRepo ....................................................................................................................................................... 43
BdSettle ...................................................................................................................................................... 44
BdSettleLock ............................................................................................................................................... 45
CpnNext ...................................................................................................................................................... 45
CpnNumber ................................................................................................................................................ 46
CpnPrev ...................................................................................................................................................... 46
Chapter 5
Chapter 6
Chapter 7
4 August 2003
Chapter 8
Table of Contents
Part IV:
Reuters Adfin Credit
Chapter 9
Part V:
Reuters Adfin Foreign Exchange and Money Markets
Chapter 10
4 August 2003
Table of Contents
FxSwpToSwpD ........................................................................................................................................... 95
FxSwpToSwpP ............................................................................................................................................ 96
Part VI:
Reuters Adfin Options
Chapter 11
Chapter 12
Chapter 13
Chapter 14
Chapter 15
Chapter 16
Part VII:
Reuters Adfin Exotic Options
8
4 August 2003
Table of Contents
Chapter 17
Chapter 18
Chapter 19
Chapter 20
Chapter 21
Chapter 22
Chapter 23
Chapter 24
Chapter 25
4 August 2003
Table of Contents
Chapter 26
Chapter 27
Chapter 28
Part VIII:
Reuters Adfin Swaps
Chapter 29
Chapter 30
Part IX:
Reuters Adfin Term Structure
Chapter 31
Chapter 32
10
4 August 2003
Table of Contents
Part X:
Reuters Adfin Common
Chapter 33
Chapter 34
Chapter 35
Chapter 36
Chapter 37
4 August 2003
11
Table of Contents
Part XI:
Reuters 3000 Data Engine
Chapter 38
Part XII:
Reuters Adfin Extended Arguments
Appendix A
12
4 August 2003
Table of Contents
4 August 2003
13
Table of Contents
14
4 August 2003
PART I:
INTRODUCTION
Introduction
16
4 August 2003
CHAPTER 1
Contents
4 August 2003
17
18
The Reuters PowerPlus Pro 4.5.1 Function Reference Guide is a complete reference guide to
Reuters PowerPlus Pro functions.
The Reuters PowerPlus Pro 4.5.1 Function Reference Guide is intended for all users of PowerPlus
Pro that choose to build models to perform customized analyses.
The Reuters PowerPlus Pro 4.5.1 Function Reference Guide assumes that you are familiar with:
The Reuters PowerPlus Pro 4.5.1 Function Reference Guide is organized in chapters representing
the different categories of Adfin functions
First read Conventions Used in This Guide on page 19 to familiarize yourself with the manner in
which information is presented and the terminology used in this guide.
4 August 2003
Convention
Explanation
italics
Terminology
Emphasizes an explanation
Bold text
courier font
<courier_italics>
root#
any_other_user$
Term
What You Do
Activate
Choose
Click
Quickly press and release the mouse button while the cursor is over the item
Double-click
Quickly press and release the mouse button twice in succession while the cursor
is over the item
Press and hold the mouse button while the cursor is over the item, then move the
cursor to the required position, and then release the mouse button
Enter
Type in data
Highlight
Place the cursor over a row in a table (or a cell in a matrix) and quickly press and
release the mouse button while the pointer is over the item
Press
4 August 2003
19
Reuters
PowerPlus Pro
and Reuters
3000 Data
Engine guides
On-line help
20
The Reuters PowerPlus Pro guides are delivered in the \commmon\doc\pdf\Reuters PowerPlus Pro
directory as Adobe PDF files that you can display on-screen and print using Adobe Acrobat Reader
(also delivered with Reuters PowerPlus Pro).
Title
Document Number
4510505
4510504
4510531
4510506
Reuters PowerPlus Pro is delivered with context-sensitive and indexed online help. Choose
Reuters Help Online Help.
4 August 2003
PART II:
REUTERS ADFIN
REALTIME
22
4 August 2003
R E A L T I M E D A TA F U N C T I O N S
CHAPTER 2
Contents
RtChain
RtContribute
RtGet
RtNow
RtSeries
RtToday
RtUpdate
4 August 2003
23
RtChain
RtChain
Purpose
RtChain fills a Microsoft Excel range with the underlying records of a chain or tile.
Syntax
Note
Arguments
Source alias
Instrument code
Cell reference of the upper left corner of the destination array
Name of the macro to run
Extended argument defining the operation (see RtMode on page
374)
RtContribute
Purpose
Syntax
locally within Microsoft Excel, to share the data among all open spreadsheets
at the network level, to share the data among all users connected to the source
=RtContribute(SourceAlias, InstrumentCode, FieldNameArray, FieldValueArray,
RtMode)
Arguments
SourceAlias
InstrumentCode
FieldNameArray
FieldValueArray
RtMode
24
Source alias
Instrument code
One-dimensional array of field names or numbers
Array of field values
Extended argument defining the operation (see RtMode on page
374)
4 August 2003
RtGet
Purpose
Syntax
Note
Arguments
Use the non-volatile RtGet function if you have installed Microsoft Excel 2002.
SourceAlias
InstrumentCode
FieldName
RtMode
Source alias
Instrument code
One-dimensional field names or numbers
Extended argument defining the operation (see RtMode on page
374)
RtNow
Purpose
Syntax
Note
Argument
Retrieves the current system date and time. RtNow is a non-volatile and asynchronous function that
replaces the volatile Now() function of Microsoft Excel 2002. Adfin Real Time enables you to
manage RtNow updates separately from the global recalculation of your spreadsheet, thus
improving its real time performance. RtNow can only run with Microsoft Excel 2002.
=RtNow(RtMode)
RtSeries
Purpose
Retrieves historical snap quotes for a real time instrument. RtSeries displays real time data in an
array at time interval. Retrieved data is automatically duplicated, allowing you to build a real time
data series for the requested instrument.
4 August 2003
25
RtToday
Syntax
Arguments
SourceAlias
InstrumentCode
FieldNameArray
DestinationCell
MacroName
RtMode
Source alias
Instrument code
One-dimensional array of field names or numbers
Cell reference of the upper left corner of the destination array
Name of the macro to run
Extended argument defining the operation (see RtMode on page
374)
RtToday
Purpose
Syntax
Note
Arguments
Retrieves the current system date. RtToday is a non-volatile and asynchronous function that
replaces the volatile Today() function of Microsoft Excel 2002. Adfin Real Time enables you to
manage RtToday updates separately from the global recalculation of your spreadsheet, thus
improving its real time performance. RtToday only runs with Microsoft Excel 2002.
=RtToday()
RtUpdate
Purpose
Syntax
Arguments
26
Performs an asynchronous action such as updating real time data or running an Excel macro upon
reception of real time updates. Also performs snapshot updates, using a snap mechanism.
=RtUpdate(SourceAlias, InstrumentArray, FieldNameArray, DestinationCell,
MacroName, RtMode)
SourceAlias
Source alias
4 August 2003
InstrumentArray
FieldNameArray
DestinationCell
MacroName
RtMode
4 August 2003
27
RtUpdate
28
4 August 2003
H I S T O R I C A L D A TA F U N C T I O N S
CHAPTER 3
Contents
RtHistory
RtHistoryInfo
4 August 2003
29
RtHistory
RtHistory
Purpose
Syntax
Arguments
SourceAlias
InstrumentCode
FieldNames
DestinationCell
HistoryStructure
HistoryMode
Source alias
Instrument codes
String of field names separated by a comma or 1-dimensional array of field
names or numbers
Cell reference of the upper left corner of the destination array
Extended argument defining the range of dates, between which data is
retrieved (see HistoryStructure on page 333)
Extended argument customizing the format of the retrieved data (see
HistoryMode on page 331)
RtHistoryInfo
Purpose
Syntax
Arguments
Returns a string or an array listing all fields available in TS1 for an instrument. To get the result as an
array, use RES:ARRAY keyword in HistoryMode.
=RtHistoryInfo(SourceAlias, InstrumentCode, HistoryMode)
SourceAlias
InstrumentCode
HistoryMode
30
Source alias
Instrument codes
Extended argument customizing the return array (seeHistoryMode
on page 331)
4 August 2003
4 August 2003
31
RtHistoryInfo
32
4 August 2003
PART III:
REUTERS ADFIN
BONDS
34
4 August 2003
CHAPTER 4
Contents
Accrued
AdBondDeriv
AdBondPrice
AdBondSpread
AdBondYield
BdCalcCpn
BdCashFlows
BdConvFactor
BdCpnCrv
BdCpnValue
BdIrsStructure
BdPvbpCrv
BdRepo
BdSettle
BdSettleLock
CpnNext
CpnNumber
CpnPrev
4 August 2003
35
Accrued
Accrued
Purpose
Syntax
Arguments
CalcDate
Maturity
Coupon
BondStructure
Calculation date
Maturity date of the bond
Nominal coupon rate, expressed as a percentage
Extended argument defining the bond structure (see BondStructure
on page 247)
AdBondDeriv
Purpose
Syntax
Arguments
SettlementDate
RateArray
Maturity
36
Settlement date
Term structure array
Depending on the model, this array has several forms:
- a single value if the Yield To Maturity is used
- a 1 dimensional array containing the Vasicek-Fong coefficients if VF
is specified
- a 2-dimensional array containing the dates (rows or columns
depending on the orientation of the array specified by the LAY
keyword), and the values for the rates if a ZCCurve is used
- a 2-dimensional array containing the dates (rows or columns
depending on the orientation of the array specified by the LAY
keyword), the values for the rates, and the volatilities if BDT is used
The model used is specified by the keyword RM (Rate Model) in the
RateStructure argument.
Maturity date of the bond
4 August 2003
Coupon
Spread
BondStructure
RateStructure
CalcStructure
AdMode
AdBondPrice
Purpose
Syntax
Arguments
SettlementDate
RateArray
Maturity
Settlement date
Term structure array
Depending on the model, this array has several forms:
- a single value if the Yield To Maturity is used
- a 1 dimensional array containing the Vasicek-Fong coefficients if VF
is specified
- a 2-dimensional array containing the dates (rows or columns
depending on the orientation of the array specified by the LAY
keyword), and the values for the rates if a ZCCurve is used
- a 2-dimensional array containing the dates (rows or columns
depending on the orientation of the array specified by the LAY
keyword), the values for the rates, and the volatilities if BDT is used
- The model used is specified by the keyword RM (Rate Model) in the
RateStructure argument.
Maturity date of the bond
4 August 2003
37
AdBondSpread
Coupon
Spread
BondStructure
RateStructure
CalcStructure
AdMode
AdBondSpread
Purpose
Syntax
Arguments
SettlementDate
RateArray
Price
38
Settlement date
Term structure array
Depending on the model, this array has several forms:
- a single value if the Yield To Maturity is used
- a 1 dimensional array containing the Vasicek-Fong coefficients if VF
is specified
- a 2-dimensional array containing the dates (rows or columns
depending on the orientation of the array specified by the LAY
keyword) and the values for the rates if a zero-coupon curve is used
- a 2-dimensional array containing the dates (rows or columns
depending on the orientation of the array specified by the LAY
keyword), the values for the rates, and the volatilities if BDT is used
The model used is specified by the keyword RM (Rate Model) in the
RateStructure argument.
Clean or gross price expressed as a percentage of the nominal
4 August 2003
Maturity
Coupon
BondStructure
RateStructure
CalcStructure
AdMode
AdBondYield
Purpose
Syntax
Arguments
Calculates the Yield To Maturity of non optionable bonds. Calculates the yields at call/put dates of
optionable bonds.
=AdBondYield(SettlementDate, HorizonDate, Maturity, Coupon, BondStructure,
RateStructure, AdMode)
SettlementDate
Price
Maturity
Coupon
Bondstructure
RateStructure
AdMode
Settlement date
(Market) Price of the bond
Maturity date of the bond
Nominal coupon rate, expressed as a percentage
Extended argument defining the bond structure (see BondStructure
on page 247)
Extended argument defining the rate model (see RateStructure on
page 365)
Extended argument customizing the return value (see AdMode on
page 237)
BdCalcCpn
Purpose
4 August 2003
39
BdCashFlows
Syntax
Arguments
CalcDate
Maturity
Coupon
Bondstructure
BdMode
Calculation date
Maturity date of the bond
Nominal coupon rate, expressed as a percentage
Extended argument defining the bond structure (see BondStructure
on page 247)
Extended argument customizing the return value (see BdMode on
page 243)
BdCashFlows
Purpose
Syntax
Arguments
CalcDate
Maturity
Coupon
Bondstructure
BdMode
Calculation date
Maturity date of the bond
Nominal coupon rate, expressed as a percentage
Extended argument defining the bond structure (see BondStructure
on page 247)
Extended argument customizing the return value (see BdMode on
page 243)
BdConvFactor
Purpose
Syntax
Arguments
40
BondFutStructure
4 August 2003
MaturityCode
Maturity
Coupon
ConvMode
BdMode
BdCpnCrv
Purpose
Syntax
Arguments
Calculates the nominal coupon rate from the bond price and a zero-coupon yield curve.
=BdCpnCrv(CalcDate, HorizonDate, DateArray, RateArray, Maturity, BondStructure,
CalcMethod)
CalcDate
Price
DateArray
RateArray
Maturity
Bondstructure
Calcmethod
Calculation date
Clean or gross price expressed as a percentage of the nominal
Array of zero-coupon dates
Array of zero-coupon rates or discount factors
Maturity date of the bond
Extended argument defining the bond structure (see BondStructure
on page 247)
Extended argument defining the calculation method (see
CalcMethod on page 257)
BdCpnValue
Purpose
Syntax
Arguments
CalcDate
Maturity
Calculation date
Maturity date of the bond
4 August 2003
41
BdIrsStructure
Coupon
Bondstructure
BdIrsStructure
Purpose
Syntax
Arguments
Returns the interest rate swap structure corresponding to a swap in which fixed cash flows match
the bond ones.
=BdIrsStructure (BondStructure)
BondStructure
BdPvbpCrv
Purpose
Syntax
Arguments
Calculates the price variation per basis point for each point of a zero-coupon yield curve.
=BdPvbpCrv(CalcDate, HorizonDate, DateArray, RateArray, Maturity, Coupon,
BondStructure, CalcMethod, BdMode)
CalcDate
Price
DateArray
RateArray
Maturity
Coupon
Bondstructure
Calcmethod
Bdmode
42
Calculation date
Clean or gross price expressed as a percentage of the nominal
Array of zero-coupon dates
Array of zero-coupon rates or discount factors
Maturity date of the bond
Nominal coupon rate, expressed as a percentage
Extended argument defining the bond structure (see BondStructure
on page 247)
Extended argument defining the calculation method (see
CalcMethod on page 257)
Extended argument customizing the return value (see BdMode on
page 243)
4 August 2003
BdRepo
Purpose
Calculates the implied repo rate, the future value, or the present value of a repo using a bond
structure.
The expected result must be specified in RepoMode using the RES keyword.
To define how the present value and/or the future value of the bond are expressed (clean price,
gross price, or yield), use the NPV and FV keywords in RepoMode.
To define the repo rate type (usually MMBA0 or MMBA5), use the RR keyword.
Syntax
Arguments for
implied repo rate
calculation
CalcDate
HorizonDate
Npv
Fv
RepoRate
Maturity
Coupon
BondStructure
RepoMode
Calculation date
Horizon date of the repo
Clean price (as a percentage of the nominal), or gross price (as a
percentage of the nominal), or yield to maturity of the bond at
CalcDate (present value)
Clean price (as a percentage of the nominal), or gross price (as a
percentage of the nominal), or yield to maturity of the bond at
HorizonDate (future value)
# not used - enter 0 #
Maturity date of the bond
Nominal coupon rate of the bond, expressed as a percentage
Extended argument defining the bond structure (see BondStructure
on page 247)
Extended argument defining the calculation (see RepoMode on page
371)
If calculating the implied repo rate, RepoMode should include the
argument "RES:IMPRATE".
4 August 2003
43
BdSettle
Arguments for
future value
calculation
CalcDate
HorizonDate
Npv
Fv
RepoRate
Maturity
Coupon
BondStructure
RepoMode
Arguments for
present value
calculation
CalcDate
HorizonDate
Npv
Fv
RepoRate
Maturity
Coupon
Bondstructure
RepoMode
Calculation date
Horizon date of the repo
Clean price (as a percentage of the nominal), or gross price (as a
percentage of the nominal), or yield to maturity of the bond at
CalcDate (present value)
# not used - enter 0 #
Repo rate
Maturity date of the bond
Nominal coupon rate of the bond, expressed as a percentage
Extended argument defining the bond structure (see BondStructure
on page 247)
Extended argument defining the calculation (see BondStructure on
page 247)
If calculating the future value, RepoMode should include the argument
"RES:FV".
Calculation date
Horizon date of the repo
# not used - enter 0 #
Clean price (as a percentage of the nominal), or gross price (as a
percentage of the nominal), or yield to maturity of the bond at
HorizonDate (future value)
Repo rate
Maturity date of the bond
Nominal coupon rate, expressed as a percentage
Extended argument defining the bond structure (see BondStructure
on page 247)
Extended argument defining the calculation (see RepoMode on page
371)
If calculating the present value, RepoMode should include the
argument "RES:NPV".
BdSettle
Purpose
44
4 August 2003
Syntax
Arguments
Return Value
=BdSettle(CalcDate, BondStructure)
Bondstructure
BdSettleLock
Purpose
Syntax
Arguments
Calculates the settlement date for bonds with lockout periods using a bond structure.
=BdSettleLock (CalcDate, Maturity, BondStructure)
CalcDate
Maturity
BondStructure
Calculation date
Maturity date of the bond
Extended argument defining the bond structure (see BondStructure
on page 247)
CpnNext
Purpose
Syntax
Arguments
CalcDate
Maturity
BondStructure
Calculation date
Maturity date of the bond
Extended argument defining the bond structure (see BondStructure
on page 247)
4 August 2003
45
CpnNumber
CpnNumber
Purpose
Syntax
Arguments
CalcDate
Maturity
BondStructure
Calculation date
Maturity date of the bond
Extended argument defining the bond structure (see BondStructure
on page 247)
CpnPrev
Purpose
Syntax
Arguments
CalcDate
Maturity
BondStructure
46
Calculation date
Maturity date of the bond
Extended argument defining the bond structure (see BondStructure
on page 247)
4 August 2003
CHAPTER 5
Contents
CfAvgLife
CfConv
CfDur
CfPvbp
CfPx
CfPxCrv
CfRepo
CfVol
CfYld
4 August 2003
47
CfAvgLife
CfAvgLife
Purpose
Syntax
Arguments
CalcDate
CfDates
Cf
CalcMethod
Calculation date
Array of cash flow dates corresponding to the bond principal reimbursement
Array of cash flow values corresponding to the bond principal reimbursement
Extended argument defining the calculation method (see CalcMethod on page
257)
CfConv
Purpose
Syntax
Arguments
CalcDate
Yield
CfDates
Cf
CalcMethod
Calculation date
Yield to maturity
Array of cash flow dates corresponding to the bond reimbursement
Array of cash flow values corresponding to the bond reimbursement
Extended argument defining the calculation method (see CalcMethod on
page 257)
CfDur
Purpose
Syntax
48
4 August 2003
Arguments
CalcDate
Yield
CfDates
Cf
CalcMethod
Calculation date
Yield to maturity
Array of cash flow dates corresponding to the bond reimbursement
Array of cash flow values corresponding to the bond reimbursement
Extended argument defining the calculation method (see CalcMethod on
page 257)
CfPvbp
Purpose
Syntax
Arguments
Calculates the price variation per basis point (PVBP) using cash flows.
=CfPvbp(CalcDate, Yield, CfDates, Cf, CalcMethod)
CalcDate
Yield
CfDates
Cf
CalcMethod
Calculation date
Yield to maturity
Array of cash flow dates corresponding to the bond reimbursement
Array of cash flow values corresponding to the bond reimbursement
Extended argument defining the calculation method (see CalcMethod on
page 257)
CfPx
Purpose
Syntax
Arguments
CalcDate
Yield
CfDates
Cf
CalcMethod
Calculation date
Yield to maturity
Array of cash flow dates corresponding to the bond reimbursement
Array of cash flow values corresponding to the bond reimbursement
Extended argument defining the calculation method (see CalcMethod on
page 257)
4 August 2003
49
CfPxCrv
CfPxCrv
Purpose
Syntax
Arguments
Calculates the price from a zero-coupon yield curve using cash flows.
=CfPxCrv(CalcDate, DateArray, RateArray, CfDates, Cf, CalcMethod)
CalcDate
DateArray
RateArray
CfDates
Cf
CalcMethod
Calculation date
Array of zero-coupon dates
Array of zero-coupon rates or discount factors
Array of cash flow dates corresponding to the bond reimbursement
Array of cash flow values corresponding to the bond reimbursement
Extended argument defining the calculation method (see CalcMethod on
page 257)
CfRepo
Purpose
Calculates the implied repo rate, the future value, or the present value of a repo using cash flows.
The expected result must be specified in RepoMode using the RES keyword.
To define how the present value and/or the future value of the bond are expressed (clean price,
gross price, or yield), use the NPV and FV keywords in RepoMode. To define the repo rate type
(usually MMBA0 or MMBA5), use the RR keyword.
Syntax
Arguments for
implied repo rate
calculation
CalcDate
HorizonDate
Npv
Fv
RepoRate
50
Calculation date
Horizon date of the repo
Clean price (as a percentage of the nominal), or gross price (as a
percentage of the nominal), or yield to maturity of the bond at CalcDate
(present value)
Clean price (as a percentage of the nominal), or gross price (as a
percentage of the nominal), or yield to maturity of the bond at HorizonDate
(future value)
# not used - enter 0 #
4 August 2003
CfDates
Cf
RepoMode
4 August 2003
51
CfVol
Arguments for
future value
calculation
CalcDate
HorizonDate
Npv
Fv
RepoRate
CfDates
Cf
RepoMode
Arguments for
present value
calculation
CalcDate
HorizonDate
Npv
Fv
RepoRate
CfDates
Cf
RepoMode
Calculation date
Horizon date of the repo
Clean price (as a percentage of the nominal), or gross price (as a
percentage of the nominal), or yield to maturity of the bond at CalcDate
(present value)
# not used - enter 0 #
Repo rate
Array of cash flow dates corresponding to the bond reimbursement
Array of cash flow values corresponding to the bond reimbursement
Extended argument defining the calculation (see RepoMode on page 371)
If calculating the future value, RepoMode should include the argument
"RES:FV".
Calculation date
Horizon date of the repo
# not used - enter 0 #
Clean price (as a percentage of the nominal), or gross price (as a
percentage of the nominal), or yield to maturity of the bond at HorizonDate
(future value)
Repo rate
Array of cash flow dates corresponding to the bond reimbursement
Array of cash flow values corresponding to the bond reimbursement
Extended argument defining the calculation (see RepoMode on page 371)
If calculating the present value, RepoMode should include the argument
"RES:NPV".
CfVol
Purpose
Syntax
Arguments
Calculates the volatility of the bond or the modified duration using cash flows.
=CfVol(CalcDate, Yield, CfDates, Cf, CalcMethod)
CalcDate
Yield
52
Calculation date
Yield to maturity
4 August 2003
CfDates
Cf
CalcMethod
CfYld
Purpose
Syntax
Arguments
CalcDate
GrossPrice
CfDates
Cf
CalcMethod
Calculation date
Clean price plus accrued interest expressed in the same unit as cash flows
Array of cash flow dates corresponding to the bond reimbursement
Array of cash flow values corresponding to the bond reimbursement
Extended argument defining the calculation method (see CalcMethod on
page 257)
4 August 2003
53
CfYld
54
4 August 2003
CHAPTER 6
Contents
AdConvBdDeriv
AdConvCalcCpn
AdConvCashFlows
AdConvImpliedVol
AdConvOpDeriv
AdConvPrice
AdConvRatios
AdConvYield
4 August 2003
55
AdConvBdDeriv
AdConvBdDeriv
Purpose
Syntax
Arguments
Returns all derivatives of the underlying bond in an array from the price of the convertible, using a
conversion structure.
=AdConvBdDeriv(SettlementDate, Maturity, Coupon, RateArray, Spread,
ConvStructure, RateStructure, CalcStructure, AdMode)
SettlementDate
Maturity
Coupon
RateArray
Spread
ConvStructure
RateStructure
CalcStructure
AdMode
Settlement date
Maturity date of the convertible bond
Coupon rate, expressed as a percentage
Argument defining the interest rate model in the bond currency:
single-factor models: single interest rate or zero-coupon array
two-factor model: a [dates/rates/rate volatilities/mean reversions] array
Credit spread of the issuer expressed in basis points
Extended argument defining the conversion structure (see ConvMode on
page 274)
Extended argument defining the structure of the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see CalcStructure on
page 262)
Extended argument customizing the return value (see AdMode on page
237)
AdConvCalcCpn
Purpose
Syntax
Arguments
Returns all coupon features of a convertible bond in an array using a conversion structure.
=AdConvCalcCpn (SettlementDate, Maturity, Coupon, ConvStructure, AdMode)
SettlementDate
Maturity
Coupon
56
Settlement date
Maturity date of the convertible bond
Coupon rate, expressed as a percentage
4 August 2003
ConvStructure
AdMode
AdConvCashFlows
Purpose
Syntax
Arguments
SettlementDate
Maturity
Coupon
ConvStructure
AdMode
Settlement date
Maturity date of the convertible bond
Coupon rate, expressed as a percentage
Extended argument defining the conversion structure (see ConvStructure
on page 274)
Extended argument customizing the return value (see AdMode on page
237)
AdConvImpliedVol
Purpose
Syntax
Arguments
SettlementDate
Maturity
Price
Coupon
Settlement date
Maturity date of the convertible bond
Clean or gross price of the convertible bond expressed in the current
currency.
Coupon rate, expressed as a percentage
4 August 2003
57
AdConvOpDeriv
RateArray
EquityPrice
EquityDivArray
SpotFX
Spread
ConvStructure
RateStructure
CalcStructure
AdConvOpDeriv
Purpose
Syntax
Arguments
Returns an array of all derivatives (Delta, Gamma, Rho, Theta, Vega) of the optional part of the
bond.
=AdConvOpDeriv (SettlementDate, Maturity, Coupon, RateArray, EquityPrice,
EquityVolatility, EquityDivArray, SpotFX, Spread, ConvStructure, RateStructure,
CalcStructure, AdMode)
SettlementDate
Maturity
Coupon
RateArray
EquityPrice
EquityVolatility
EquityDivArray
SpotFX
58
Settlement date
Maturity date of the convertible bond
Coupon rate, expressed as a percentage
Argument defining the interest rate model in the bond currency:
single-factor models: single interest rate or zero-coupon array
two-factor model: a [dates/rates/rate volatilities/mean reversions]
array
Spot price of the underlying instrument
Volatility of the underlying instrument
Annual dividend rate or array of dividend dates and amounts
Spot rate for the cross currency
4 August 2003
Spread
ConvStructure
RateStructure
CalcStructure
AdMode
AdConvPrice
Purpose
Syntax
Arguments
SettlementDate
Maturity
Coupon
RateArray
EquityPrice
EquityVolatility
EquityDivArray
SpotFX
Spread
ConvStructure
RateStructure:
CalcStructure
Settlement date
Maturity date of the convertible bond
Coupon rate, expressed as a percentage
Argument defining the interest rate model in the bond currency:
single-factor models: single interest rate or zero-coupon array
two-factor model: a [dates/rates/rate volatilities/mean reversions] array
Spot price of the underlying instrument
Volatility of the underlying instrument
Annual dividend rate or array of dividend dates and amounts
Spot rate for the cross currency
Credit spread of the issuer expressed in basis points
Extended argument defining the conversion structure (see ConvStructure
on page 274)
Extended argument defining the structure of the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see CalcStructure
on page 262)
4 August 2003
59
AdConvRatios
AdMode
AdConvRatios
Purpose
Syntax
Arguments
SettlementDate
Maturity
Price
EquityPrice
SpotFX
ConvStructure
AdMode
Settlement date
Maturity date of the convertible bond
Clean or gross price of the convertible bond expressed as a percentage of
the nominal
Spot price of the underlying instrument
Spot rate for the cross currency
Extended argument defining the conversion structure (see ConvStructure
on page 274)
Extended argument customizing the return value (see AdMode on page
237)
AdConvYield
Purpose
Syntax
Arguments
Calculates the yield of the underlying bond from the price of the convertible, using a conversion
structure.
=AdConvYield (SettlementDate, Maturity, Price,Coupon, ConvStructure,
RateStructure)
SettlementDate
Price
Maturity
Coupon
60
Settlement date
Clean or gross price of the convertible bond in current currency
Maturity date of the convertible bond
Coupon rate, expressed as a percentage
4 August 2003
ConvStructure
RateStructure
4 August 2003
61
AdConvYield
62
4 August 2003
CHAPTER 7
Contents
FrnCalcCpn
FrnCashFlows
FrnMargin
FrnPx
4 August 2003
63
FrnCalcCpn
FrnCalcCpn
Purpose
Syntax
Arguments
CalcDate
StartDate
Maturity
CurrentIndex
QuotedMargin
FrnStructure
FrnMode
Calculation date
Start date of the FRN (issue date)
Maturity date of the FRN
Index rate for the current coupon
Margin applied to the index
Extended argument defining the FRN structure (see FrnStructure on
page 320)
Extended argument customizing the return value (see FrnMode on
page 317)
FrnCashFlows
Purpose
Syntax
Arguments
Generates an array with the remaining cash flows of a floating rate instrument.
=FrnCashFlows(CalcDate, ZcDates, ZcRates, StartDate, Maturity, QuotedMargin,
FloatingRateArray, FrnStructure, FrnMode)
CalcDate
ZcDates
ZcRates
StartDate
Maturity:
QuotedMargin
FloatingRateArray
FrnStructure
64
Calculation date
Array of zero-coupon dates
Array of zero-coupon rates or discount factors
Start date of the FRN (issue date)
Maturity date of the FRN (expressed as a date or a code such as "1Y")
Margin applied to the index
Array of floating leg rates
Extended argument defining the FRN structure (see FrnStructure on
page 320)
4 August 2003
FrnMode
FrnMargin
Purpose
Syntax
Arguments
CalcDate
StartDate
Maturity
Px
QuotedMargin
FloatingRateArray
FrnStructure
FrnMode
Calculation date
Start date of the FRN (issue date)
Maturity date of the FRN (expressed as a date or a code such as
"1Y")
Margin or yield expressed as a percentage or price expressed as a
percentage of the nominal
Margin applied to the index
Two-cell array defining the value of the current index and the value of
the projected index.
Extended argument defining the FRN structure (see FrnStructure
on page 320)
Extended argument customizing the return value (see FrnMode on
page 317)
FrnPx
Purpose
Syntax
4 August 2003
65
FrnPx
Arguments
CalcDate
ZcDates
ZcRates
StartDate
Maturity
QuotedMargin
FloatingRateArray
FrnStructure
FrnMode
66
Calculation date
Array of zero-coupon dates
Array of zero-coupon rates or discount factors
Start date of the FRN (issue date)
Maturity date of the FRN (expressed as a date or a code such as "1Y")
Margin applied to the index
Array of floating leg rates
Extended argument defining the FRN structure (see FrnStructure on
page 320)
Extended argument customizing the return value (see FrnMode on page
317)
4 August 2003
CHAPTER 8
Contents
IlbCalcCpn
IlbCashFlows
IlbPx
IlbYld
4 August 2003
67
IlbCalcCpn
IlbCalcCpn
Purpose
Syntax
Arguments
CalcDate
Maturity
Coupon
InflationRateArray
IlbStructure
IlbMode
Calculation date
Maturity date of the bond
Nominal coupon rate, expressed as a number or a percent
Array of anticipated inflation rates
Extended argument defining the index-linked bond structure (see
IlbStructure on page 337)
Extended argument customizing the return value (see IlbMode on page
335)
IlbCashFlows
Purpose
Syntax
Arguments
CalcDate
Maturity
Coupon
InflationRateArray
IlbStructure
IlbMode
68
Calculation date
Maturity date of the bond
Nominal coupon rate, expressed as a number or a percentage
Array of anticipated inflation rates
Extended argument defining the index-linked bond structure (see
IlbStructure on page 337)
Extended argument customizing the return value (see IlbMode on
page 335)
4 August 2003
IlbPx
Purpose
Syntax
Arguments
CalcDate
Maturity
Coupon
Yield
InflationRateArray
IlbStructure
IlbMode
Calculation date
Maturity date of the bond
Nominal coupon rate, expressed as a number or a percentage
Yield to maturity
Array of anticipated inflation rates
Extended argument defining the index-linked bond structure (see
IlbStructure on page 337)
Extended argument customizing the return value (see IlbMode on
page 335)
IlbYld
Purpose
Syntax
Arguments
CalcDate
Maturity
Coupon
Price
InflationRateArray
IlbStructure
IlbMode
Calculation date
Maturity date of the bond
Nominal coupon rate, expressed as a number or a percentage
Clean or gross price expressed as a percentage of the nominal
Array of anticipated inflation rates
Extended argument defining the index-linked bond structure (see
IlbStructure on page 337)
Extended argument customizing the return value (see IlbMode on page
335)
4 August 2003
69
IlbYld
70
4 August 2003
PART IV:
REUTERS ADFIN
CREDIT
72
4 August 2003
CREDIT FUNCTIONS
CHAPTER 9
Contents
4 August 2003
73
AdCdsNpv
AdCdsSpread
AdFxCdsNpv
AdFxCdsSpread
AdCdsNpv
Purpose
Depending on the model specified by the RISKMODEL keyword, the function calculates the net
present value of a credit default swap, using:
Syntax
Arguments
SettlementDate
StartDate
Maturity
Spread
RateArray
CreditArray
CdsStructure
CreditStructure
RateStructure
Settlement date
Start date of the credit default swap
Maturity of the credit default swap, expressed as a date or code
Spread of the credit default swap, expressed as basis points
Interest rate model
Credit model
Extended argument defining the structure of the credit default swap (see
CdsStructure on page 268)
Extended argument defining the credit model (see CreditStructure on
page 276)
Extended argument defining the interest rate model (see RateStructure
on page 365)
AdCdsSpread
Purpose
74
Depending on the model specified by the RISKMODEL keyword, the function calculates the spread of
a credit default swap from the net present value, using:
4 August 2003
Syntax
Arguments
Settlement date
Start date of the credit default swap
Maturity
Maturity of the credit default swap, expressed as a date or code
Npv
Net present value of the credit default swap
RateArray
Interest rate model
CreditArray
Credit model
CdsStructure
Extended argument defining the structure of the credit default swap (see
CdsStructure on page 268)
CreditStructure Extended argument defining the credit model (see CreditStructure on page
276)
RateStructure
Extended argument defining the interest rate model (see RateStructure on
page 365)
SettlementDate
StartDate
AdFxCdsNpv
Purpose
Depending on the model specified by the RISKMODEL keyword, the function calculates the net
present value of a Quanto credit default swap, using:
Syntax
Arguments
SettlementDate
StartDate
Maturity
Spread
PaidRate
Settlement date
Start date of the credit default swap
Maturity of the credit default swap, expressed as a date or code
Spread of the credit default swap, expressed as basis points
Interest rate model of the paid leg
4 August 2003
75
AdFxCdsSpread
AdFxCdsSpread
Purpose
Depending on the model specified by the RISKMODEL keyword, the function calculates the spread of
a Quanto credit default swap from the net present value, using:
Syntax
Arguments
SettlementDate
StartDate
Maturity
Npv
PaidRate
ReceivedRate
FxArray
CreditArray
CdsStructure
CreditStructure
RateStructure
76
Settlement date
Start date of the credit default swap
Maturity of the credit default swap, expressed as a date or code
Net present value of the credit default swap
Interest rate model of the paid leg
Interest rate model of the received leg
Array of dates and swap points
Credit model
Extended argument defining the structure of the credit default swap (see
CdsStructure on page 268)
Extended argument defining the credit model (see CreditStructure on
page 276)
Extended argument defining the interest rate model (see RateStructure on
page 365)
4 August 2003
Return Value
The spread of the Quanto credit default swap, expressed as basis points.
4 August 2003
77
AdCreditStructure
AdJLTCreditStructure
AdCreditStructure
Purpose
Syntax
Arguments
Depending on the model specified by the RISKMODEL keyword, the function calibrates the Cox,
Ingersoll, and Ross model or the credit event probability curve, either from an array of credit default
swaps, or from a credit zero-coupon curve.
=AdCreditStructure(RateArray, InstrumentArray, CreditStructure, RateStructure,
AdMode)
RateArray
InstrumentArray
CreditStructure
RateStructure
AdMode
AdJLTCreditStructure
Purpose
Syntax
Arguments
Calibrates a credit event probability curve from a rating transition matrix, using the Jarrow, Lando,
and Turnbull model.
=AdJLTCreditStructure(RateArray, RiskyZcArray, TransitionArray, CreditStructure,
RateStructure, AdMode)
RateArray
RiskyZcArray
78
4 August 2003
TransitionArray
CreditStructure
RateStructure
AdMode
4 August 2003
79
AdCreditZcCurve
Purpose
Depending on the model specified by the RISKMODEL keyword, the function builds a credit
zero-coupon curve, using:
Syntax
Arguments
SettlementDate
RateArray
CreditArray
CreditStructure
RateStructure
AdMode
Settlement date
Interest rate model
Credit model
Extended argument defining the credit model (see CreditStructure on
page 276)
Extended argument defining the interest rate model (see RateStructure
on page 365)
Extended argument customizing the return value (see AdMode on page
237)
AdDefaultProba
Purpose
Syntax
80
Depending on the model specified by the RISKMODEL keyword, the function calculates the
probabilities of default for an array of dates, using the Cox, Ingersoll, and Ross model or a curve
credit model.
=AdDefaultProba(SettlementDate, DateArray, CreditArray, CreditStructure, AdMode)
4 August 2003
Arguments
Settlement date
Array of dates
CreditArray
Credit model
CreditStructure Extended argument defining the credit model (see CreditStructure on page
276)
AdMode
Extended argument customizing the return value (see AdMode on page 237)
SettlementDate
DateArray
4 August 2003
81
AdDefaultProba
82
4 August 2003
PART V:
REUTERS ADFIN
FOREIGN
EXCHANGE AND
MONEY MARKETS
84
4 August 2003
Contents
AdDepToFra
AdDepToFraBA
AdZcToFraBA
FxCalcPeriod
FxCross
FxCrossA
FxCrossD
FxDepToSwpD
FxDepToSwpP
FxGenCalc
FxGenParse
FxSwpToDepD
FxSwpToDepP
FxSwpToOut
FxSwpToSwp
FxSwpToSwpD
FxSwpToSwpP
4 August 2003
85
AdDepToFra
AdDepToFra
Purpose
Syntax
Arguments
Date1
Date2
Date3
RateMode
Rate1
Rate3
First date
Second date
Third date
Extended argument defining the type of rates used (see RateMode on
page 359)
Rate applicable for the period from Date1 to Date2
Rate applicable for the period from Date1 to Date3
AdDepToFraBA
Purpose
Syntax
Arguments
Date1
Date2
Date3
RateMode
Rate1BA
Rate3BA
86
First date
Second date
Third date
Extended argument defining the type of rates used (see RateMode on
page 359)
Rates applicable for the period from Date1 to Date2 (array Bid/Ask)
Rates applicable for the period from Date1 to Date3 (array Bid/Ask)
4 August 2003
AdZcToFraBA
Purpose
Calculates FRA bid and ask rates from a zero-coupon yield curve.
To indicate the zero-coupon yield curve type (rates or discount factors), use the ZCTYPE keyword in
YcMode. To determine the zero-coupon yield curve, the function AdTermStructure can be used.
Syntax
Arguments
StirFutStructure
StartDate
Period
ZcArray
YcMode
FxCalcPeriod
Purpose
Syntax
Arguments
CalcDate
Cur1Cur2
Period
FxMode
FxCross
Purpose
Calculates the spot cross rate assuming that the cross value date and the spot dates are equal.
4 August 2003
87
FxCrossA
The cross spot rate is by default returned in two cells. To get the cross rate in the Bid/Ask or Ask/Bid
format, this function can be combined with the AdFormat function.
Syntax
Arguments
Cur1Cur2
Spot1BA
Spot2BA
FxMode
FxCrossA
Purpose
Calculates the spot cross rate correcting the spot rates if the cross spot date and the spot date of
each currency are not equal.
The cross spot rate is by default returned in two cells. To get the cross rate in the Bid/Ask or Ask/Bid
format, this function can be combined with the AdFormat function.
Syntax
Arguments
CalcDate
Cur1Cur2
Spot1BA
Spot2BA
Dep1BA
Dep2BA
DepUsdBA
FxMode
FxCrossD
Purpose
88
Calculates the spot cross rate correcting the spot rates if the cross spot date SpotDate12 and the
currency spot dates SpotDate1 and SpotDate2 are not equal.
4 August 2003
The cross spot rate is by default returned in two cells. To get the cross rate in the Bid/Ask or Ask/Bid
format, this function can be combined with the AdFormat function.
Syntax
Arguments
SpotDate12
SpotDate1
SpotDate2
Cur1Cur2
Spot1BA
Spot2BA
Dep1BA
Dep2BA
DepUsdBA
FxMode
FxDepToSwpD
Purpose
Calculates the synthetic swap point from deposit using a number of days. If any of the two
currencies is the USD, an alternate set of arguments can be used to avoid the burden of determining
which of Cur1 or Cur2 stands for the USD.
To get outrights instead of swap points, this function can be combined with the FxSwpToOut function.
The cross swap point is by default returned in two cells. To get the swap point in the Bid/Ask or
Ask/Bid format, this function can be combined with the AdFormat function.
Syntax
Arguments for
two non-USD
currencies
NbDays
Cur1Cur2
Spot12BA
Dep1BA
4 August 2003
89
FxDepToSwpP
Dep2BA
FxMode
Cur2 deposit rates (in real value) for approximately NbDays (array Bid/Ask)
Extended argument customizing the return value (see FxMode on page 329)
Arguments for
one currency
against USD
NbDays
Cur1Cur2
Spot12BA
Dep1BA
Dep2BA
FxMode
FxDepToSwpP
Purpose
Calculates the synthetic swap point from deposit using a period. If any of the two currencies is the
USD, an alternate set of arguments can be used to avoid the burden of determining which of Cur1 or
Cur2 stands for the USD. To distinguish from both cases, the expected result must be specified in
FxMode using the RES keyword.
To get outrights instead of swap points, this function can be combined with the FxSwpToOut function.
The cross swap point is by default returned in two cells. To get the swap point in the Bid/Ask or
Ask/Bid format, this function can be combined with the AdFormat function.
Syntax
Arguments for
two non-USD
currencies
CalcDate
Period
Cur1Cur2
Spot12BA
Dep1BA
Dep2BA
FxMode
90
4 August 2003
Arguments for
one currency
against USD
CalcDate
Period
Cur1Cur2
Spot12BA
Dep1BA
Dep2BA
FxMode
FxGenCalc
Purpose
Syntax
Arguments
Performs any kind of Forex or Money market calculation from an instrument code. The integration of
the FxGenCalc function within models can be made easier with the FxGenParse function.
=FxGenCalc(InstrumentCode, CurrencyList, CalcDate, Spot1BA, Spot2BA, Spot12BA,
Swp1Array, Swp2Array, Dep1Array, Dep2Array, DepUsdArray, FxMode)
InstrumentCode
CurrencyList
CalcDate
Spot1BA
Spot2BA
Spot12BA
Swp1Array
Swp2Array
Dep1Array
Dep2Array
DepUsdArray
FxMode
4 August 2003
91
FxGenParse
FxGenParse
Purpose
Syntax
Arguments
Returns information concerning the calculation that corresponds to an instrument code. This
information can be used to select the proper arguments in the FxGenCalc function.
=FxGenParse(InstrumentCode, CurrencyList, FxMode)
InstrumentCode
CurrencyList
FxMode
FxSwpToDepD
Purpose
Calculates the synthetic deposit from swap point using a number of days. If either of the two
currencies is the USD, an alternate set of arguments can be used to avoid the burden of determining
which of Cur1 or Cur2 stands for the USD. To distinguish from both cases, the expected result must
be specified in FxMode using the RES keyword.
The deposit rate is by default returned in two cells. To get the rate in the Bid/Ask or Ask/Bid format,
this function can be combined with the AdFormat function.
Syntax
Arguments for
two non-USD
currencies
NbDays
Cur1Cur2
Spot12BA
DepBA
Swp12BA
FxMode
In this case, FxMode should include the argument "RES:DEP1" if the deposit rate of Cur1 is
calculated from that of Cur2, or "RES:DEP2" if the deposit rate of Cur2 is calculated from that of
Cur1.
92
4 August 2003
Arguments for
one currency
against USD
NbDays
Cur1Cur2
Spot12BA
DepBA
Swp12BA
FxMode
In this case, FxMode should include the argument "RES:DEPCUR" if the deposit rate of Currency is
calculated from that of USD, or "RES:DEPUSD" if the deposit rate of USD is calculated from that of
Currency.
FxSwpToDepP
Purpose
Calculates the synthetic deposit from swap point using a period. If any of the two currencies is the
USD, an alternate set of arguments can be used to avoid the burden of determining which of Cur1 or
Cur2 stands for the USD. To distinguish from both cases, the expected result must be specified in
FxMode using the RES keyword.
The deposit rate is by default returned in two cells. To get the rate in the Bid/Ask or Ask/Bid format,
this function can be combined with the AdFormat function.
Syntax
Arguments for
two non-USD
currencies
CalcDate
Period
Cur1Cur2
Spot12BA
DepBA
Swp12BA
FxMode
In this case, FxMode should include the argument "RES:DEP1" if the deposit rate of Cur1 is
calculated from that of Cur2, or "RES:DEP2" if the deposit rate of Cur2 is calculated from that of
Cur1.
4 August 2003
93
FxSwpToOut
Arguments for
one currency
against USD
CalcDate
Period
Cur1Cur2
Spot12BA
DepBA
Swp12BA
FxMode
In this case, FxMode should include the argument "RES:DEPCUR" if the deposit rate of Currency is
calculated from that of USD, or "RES:DEPUSD" if the deposit rate of USD is calculated from that of
Currency.
FxSwpToOut
Purpose
Syntax
Arguments
Cur1Cur2
Spot12BA
Swp12BA
FxMode
FxSwpToSwp
Purpose
94
Calculates the cross swap point from swap points assuming that the cross value date and the spot
dates are equal.
4 August 2003
To get outrights instead of swap points, this function can be combined with the FxSwpToOut function.
The cross swap point is by default returned in two cells. To get the swap point in the Bid/Ask or
Ask/Bid format, this function can be combined with the AdFormat function.
Syntax
Arguments
Cur1Cur2
Spot1BA
Spot2BA
Swp1BA
Swp2BA
FxMode
FxSwpToSwpD
Purpose
Calculates the cross swap point from swap points, using either the numbers of days or an array of
Start Dates and End Dates, to correct the calculation when the cross value date is different from the
spot date.
To get outrights instead of swap points, this function can be combined with the FxSwpToOut function.
The cross swap point is by default returned in two cells. To get the swap point in the Bid/Ask or
Ask/Bid format, this function can be combined with the AdFormat function.
Syntax
Arguments
NbDays12
NbDays1
NbDays2
Cur1Cur2
Spot1BA
4 August 2003
95
FxSwpToSwpP
Spot2BA
Swp1BA
Swp2BA
FxMode
FxSwpToSwpP
Purpose
Calculates the cross swap point from swap points using a period to correct the calculation when the
cross value date is different from the spot dates.
To get outrights instead of swap points, this function can be combined with the FxSwpToOut function.
The cross swap point is by default returned in two cells. To get the swap point in the Bid/Ask or
Ask/Bid format, this function can be combined with the AdFormat function.
Syntax
Arguments
CalcDate
Period
Cur1Cur2
Spot1BA
Spot2BA
Swp1BA
Swp2BA
FxMode
96
4 August 2003
PART VI:
REUTERS ADFIN
OPTIONS
98
4 August 2003
C H A P T E R 11 O P T I O N S A N D W A R R A N TS F U N C T I O N S
Contents
NormalC
NormalS
OpCalcDeriv
OpHistVol
OpImpliedVol
OpPremium
4 August 2003
99
NormalC
NormalC
Purpose
Syntax
Arguments
Number
x value
NormalS
Purpose
Syntax
Arguments
Number
x value
OpCalcDeriv
Purpose
Syntax
Arguments
Returns all derivatives (delta, gamma, rho, theta, and vega) of an option on a security (index, stock),
a future, a commodity, or a currency in an array.
=OpCalcDeriv(CalcDate, ExpiryDate, SpotPrice, StrikePrice, Volatility,
RiskFreeRateArray, ReturnArray, OptionStructure, RateStructure, CalcStructure,
AdMode)
CalcDate
ExpiryDate
SpotPrice
StrikePrice
Volatility
RiskFreeRateArray
ReturnArray
100
4 August 2003
OptionStructure
RateStructure
CalcStructureC
AdMode
OpHistVol
Purpose
Calculates the historical volatility of an option on a security (index, stock), a future, a commodity, or a
currency, from a set of underlying prices.
To define the type of prices used (either close prices, or high and low prices), use the HVM keyword in
OpMode.
Syntax
Arguments
=OpHistVol(PriceArray, OpMode)
PriceArray
OpMode
OpImpliedVol
Purpose
Syntax
Argument
Calculates the implied volatility of an option on a security (index, stock), a future, a commodity, or a
currency, from the option premium.
=OpImpliedVol(CalcDate, ExpiryDate, SpotPrice, StrikePrice, Premium,
RiskFreeRateArray, ReturnArray, OptionStructure, RateStructure, CalcStructure)
CalcDate
ExpiryDate
4 August 2003
101
OpPremium
SpotPrice
StrikePrice
Premium
RiskFreeRateArray
ReturnArray
OptionStructure
RateStructure
CalcStructure
OpPremium
Purpose
Syntax
Arguments
CalcDate
ExpiryDate
SpotPrice
StrikePrice
Volatility
RiskFreeRateArray
ReturnArray
OptionStructure
RateStructure
CalcStructure
102
4 August 2003
Contents
Bond Options
AdBondOptionDeriv
AdBondOptionPremium
4 August 2003
103
Bond Options
Bond Options
The Bond Options functions include:
AdBondOptionDeriv
AdBondOptionPremium
AdBondOptionDeriv
Purpose
Syntax
Arguments
Returns an array of all the derivatives (delta, gamma, rho, theta, vega) of a bond option defined from
a bond structure.
=AdBondOptionDeriv(CalcDate, RateArray, BondMaturity, Coupon, ExpiryDate,
StrikePrice, BondStructure, OptionStructure, RateStructure, CalcStructure,
AdMode)
CalcDate
RateArray
BondMaturity
Coupon
ExpiryDate
StrikePrice
BondStructure
OptionStructure
RateStructure
CalcStructure
AdMode
104
Calculation date
Term structure array
Maturity date of the bond
Coupon
Expiry date of the option
Strike of the option
Extended argument defining the bond structure (see
BondFutStructure on page 243)
Extended argument defining the option structure (see
OptionStructure on page 354)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
4 August 2003
AdBondOptionPremium
Purpose
Syntax
Arguments
CalcDate
RateArray
BondMaturity
Coupon
ExpiryDate
StrikePrice
BondStructure
OptionStructure
RateStructure
CalcStructure
AdMode
Calculation date
Term structure array
Maturity date of the bond
Coupon
Expiry date of the option
Strike price of the option
Extended argument defining the bond structure (see
BondFutStructure on page 243)
Extended argument defining the option structure (see
OptionStructure on page 354)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
4 August 2003
105
AdBondOptionPremium
106
4 August 2003
C H A P T E R 1 3 V A N I L L A C A PS , F L O O R , A N D C O L L A R S
FUNCTIONS
Contents
AdCapFloorCaplets
AdCapFloorDeriv
AdCapFloorImpliedVol
AdCapFloorPremium
4 August 2003
107
AdCapFloorCaplets
AdCapFloorCaplets
Purpose
Syntax
Arguments
Generates an array with the caplet or floorlet values of a Vanilla cap, floor, or collar.
=AdCapFloorCaplets(SettlementDate, RateArray, StartDate, Maturity,
CapStrikePrice, FloorStrikePrice, FirstRate, CapFloorStructure, RateStructure,
CalcStructure, AdMode)
SettlementDate
RateArray
StartDate
Maturity
CapStrikePrice
FloorStrikePrice
FirstRate
CapFloorStructure
RateStructure
CalcStructure
AdMode
Settlement date
Term structure array
Start date of the cap, floor, or collar
Maturity date of the cap, floor, or collar
Exercise or strike price of the cap
Exercise or strike price of the floor
Rate of the cap, floor, or collar for the current calculation period
Extended argument defining the instrument (see CapFloorStructure
on page 264)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
AdCapFloorDeriv
Purpose
Syntax
Arguments
SettlementDate
RateArray
108
Settlement date
Term structure array
4 August 2003
StartDate
Maturity
CapStrikePrice
FloorStrikePrice
FirstRate
CapFloorStructure
RateStructure
CalcStructure
AdMode
AdCapFloorImpliedVol
Purpose
Syntax
Arguments
SettlementDate
RateArray
StartDate
Maturity
CapStrikePrice
FloorStrikePrice
FirstRate
Premium
CapFloorStructure
RateStructure
Settlement date
Term structure array
Start date of the cap, floor, or collar
Maturity date of the cap, floor, or collar
Exercise or strike price of the cap
Exercise or strike price of the floor
Rate of the cap, floor, or collar for the current calculation period
Market or spot price of the cap, floor, or collar
Extended argument defining the instrument (see CapFloorStructure
on page 264)
Extended argument defining the interest rate model (see
RateStructure on page 365)
4 August 2003
109
AdCapFloorPremium
CalcStructure
AdCapFloorPremium
Purpose
Synatax
Arguments
SettlementDate
RateArray
StartDate
Maturity
CapStrikePrice
FloorStrikePrice
FirstRate
CapFloorStructure
RateStructure
CalcStructure
110
Settlement date
Term structure array
Start date of the cap, floor, or collar
Maturity date of the cap, floor, or collar
Exercise or strike price of the cap
Exercise or strike price of the floor
Rate of the cap, floor, or collar for the current calculation period
Extended argument defining the instrument (see CapFloorStructure
on page 264)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
4 August 2003
C H A P T E R 1 4 B A R R I E R C A PS A N D F L O O R S F U N C T I O N S
Contents
AdBarrierCapFloorCaplets
AdBarrierCapFloorDeriv
AdBarrierCapFloorImpliedVol
AdBarrierCapFloorPremium
4 August 2003
111
AdBarrierCapFloorCaplets
AdBarrierCapFloorCaplets
Purpose
Syntax
Arguments
Generates an array with the caplet or floorlet premiums of a Barrier cap or floor.
=AdBarrierCapFloorCaplets(SettlementDate, RateArray, StartDate, Maturity,
CapStrikePrice, FloorStrikePrice, FirstRate, UpperBarrier, LowerBarrier,
UpperRebate, LowerRebate, CapFloorStructure, RateStructure, CalcStructure,
AdMode)
SettlementDate
RateArray
StartDate
Maturity
CapStrikePrice
FloorStrikePrice
FirstRate
UpperBarrier
LowerBarrier
UpperRebate
LowerRebate
CapFloorStructure
RateStructure
CalcStructure
AdMode
Settlement date
Term structure array
Start date of the Barrier cap or floor
Maturity date of the Barrier cap or floor
Exercise or strike price of the Barrier cap
Exercise or strike price of the Barrier floor
Rate of the Barrier cap or floor for the current calculation period
Upper barrier of the Barrier cap or floor
Lower barrier of the Barrier cap or floor
Upper rebate of the Barrier cap or floor
Lower rebate of the Barrier cap or floor
Extended argument defining the instrument (see CapFloorStructure
on page 264)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
AdBarrierCapFloorDeriv
Purpose
112
4 August 2003
Syntax
Arguments
SettlementDate
RateArray
StartDate
Maturity
CapStrikePrice
FloorStrikePrice
FirstRate
UpperBarrier
LowerBarrier
UpperRebate
LowerRebate
CapFloorStructure
RateStructure
CalcStructure
AdMode
Settlement date
Term structure array
Start date of the Barrier cap or floor
Maturity date of the Barrier cap or floor
Exercise or strike price of the Barrier cap
Exercise or strike price of the Barrier floor
Rate of the Barrier cap or floor for the current calculation period
Upper barrier of the Barrier cap or floor
Lower barrier of the Barrier cap or floor
Upper rebate of the Barrier cap or floor
Lower rebate of the Barrier cap or floor
Extended argument defining the instrument (see CapFloorStructure
on page 264)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
AdBarrierCapFloorImpliedVol
Purpose
Syntax
Arguments
SettlementDate
Settlement date
4 August 2003
113
AdBarrierCapFloorPremium
RateArray
StartDate
Maturity
CapStrikePrice
FloorStrikePrice
FirstRate
Premium
UpperBarrier
LowerBarrier
UpperRebate
LowerRebate
CapFloorStructure
RateStructure
CalcStructure
AdBarrierCapFloorPremium
Purpose
Syntax
Arguments
SettlementDate
RateArray
StartDate
Maturity
CapStrikePrice
FloorStrikePrice
FirstRate
UpperBarrier
114
Settlement date
Term structure array
Start date of the Barrier cap or floor
Maturity date of the Barrier cap or floor
Exercise or strike price of the Barrier cap
Exercise or strike price of the Barrier floor
Rate of the Barrier cap or floor for the current calculation period
Upper barrier of the Barrier cap or floor
4 August 2003
LowerBarrier
UpperRebate
LowerRebate
CapFloorStructure
RateStructure
CalcStructure
4 August 2003
115
AdBarrierCapFloorPremium
116
4 August 2003
C H A P T E R 1 5 D I G I TA L C A PS , F L O O R S , A N D C O L L A R S
FUNCTIONS
Contents
AdDigitalCapFloorCaplets
AdDigitalCapFloorDeriv
AdDigitalCapFloorImpliedVol
AdDigitalCapFloorPremium
4 August 2003
117
AdDigitalCapFloorCaplets
AdDigitalCapFloorCaplets
Purpose
Syntax
Arguments
Generates an array with the caplet or floorlet premiums of a Digital cap, floor, or collar.
=AdDigitalCapFloorCaplets(SettlementDate, RateArray, StartDate, Maturity,
CapStrikePrice, FloorStrikePrice, FirstRate, CapFixedAmount, FloorFixedAmount,
CapFloorStructure, RateStructure, CalcStructure, AdMode)
SettlementDate
RateArray
StartDate
Maturity
CapStrikePrice
FloorStrikePrice
FirstRate
CapFixedAmount
FloorFixedAmount
CapFloorStructure
RateStructure
CalcStructure
AdMode
Settlement date
Term structure array
Start date of the Digital cap, floor, or collar
Maturity date of the Digital cap, floor, or collar
Exercise or strike price of the Digital cap
Exercise or strike price of the Digital floor
Rate of the Digital cap, floor, or collar for the current calculation period
Rebate array of the Digital cap
Rebate array of the Digital floor
Extended argument defining the instrument (see CapFloorStructure
on page 264)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
AdDigitalCapFloorDeriv
Purpose
Syntax
118
4 August 2003
Arguments
SettlementDate
RateArray
StartDate
Maturity
CapStrikePrice
FloorStrikePrice
FirstRate
CapFixedAmount
FloorFixedAmount
CapFloorStructure
RateStructure
CalcStructure
AdMode
Settlement date
Term structure array
Start date of the Digital cap, floor, or collar
Maturity date of the Digital cap, floor, or collar
Exercise or strike price of the Digital cap
Exercise or strike price of the Digital floor
Rate of the Digital cap, floor, or collar for the current calculation period
Rebate array of the Digital cap
Rebate array of the Digital floor
Extended argument defining the instrument (see CapFloorStructure
on page 264)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
AdDigitalCapFloorImpliedVol
Purpose
Syntax
Arguments
SettlementDate
RateArray
StartDate
Maturity
CapStrikePrice
FloorStrikePrice
FirstRate
Premium
Settlement date
Term structure array
Start date of the Digital cap, floor, or collar
Maturity date of the Digital cap, floor, or collar
Exercise or strike price of the Digital cap
Exercise or strike price of the Digital floor
Rate of the Digital cap, floor, or collar for the current calculation period
Market or spot price of the Digital cap, floor, or collar
4 August 2003
119
AdDigitalCapFloorPremium
CapFixedAmount
FloorFixedAmount
CapFloorStructure
RateStructure
CalcStructure
AdDigitalCapFloorPremium
Purpose
Syntax
Arguments
SettlementDate
RateArray
StartDate
Maturity
CapStrikePrice
FloorStrikePrice
FirstRate
CapFixedAmount
FloorFixedAmount
CapFloorStructure
RateStructure
CalcStructure
120
Settlement date
Term structure array
Start date of the Digital cap, floor, or collar
Maturity date of the Digital cap, floor, or collar
Exercise or strike price of the Digital cap
Exercise or strike price of the Digital floor
Rate of the Digital cap, floor, or collar for the current calculation period
Rebate array of the Digital cap
Rebate array of the Digital floor
Extended argument defining the instrument (see CapFloorStructure
on page 264)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
4 August 2003
Contents
AdSwaptionPremium
AdSwaptionDeriv
4 August 2003
121
AdSwaptionPremium
AdSwaptionPremium
Purpose
Syntax
Arguments
CalcDate
RateArray
SwapStartDate
SwapMaturity
ExpiryDate
SpotPrice
StrikePrice
SwapStructure
OptionStructure
RateStructure
CalcStructure
Settlement date
Term structure array
Start date of the swap
Maturity date of the swap
Expiry date of the option
Spot market rate of the swap
Exercise or strike rate of the swap
Extended argument defining the swap (see SwapStructure on page
380)
Extended argument defining the option (see OptionStructure on
page 354)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
AdSwaptionDeriv
Purpose
Syntax
Arguments
122
Returns in an array all derivatives (delta, gamma, theta, vega) of an option on a swap.
=AdSwaptionDeriv(CalcDate, RateArray, SwapStartDate, SwapMaturity, ExpiryDate,
SpotPrice, StrikePrice, SwapStructure, OptionStructure, RateStructure,
CalcStructure, AdMode)
CalcDate
RateArray
Settlement date
Term structure array
4 August 2003
SwapStartDate
SwapMaturity
ExpiryDate
SpotPrice
StrikePrice
SwapStructure
OptionStructure
RateStructure
CalcStructure
AdMode
4 August 2003
123
AdSwaptionDeriv
124
4 August 2003
PART VII:
REUTERS ADFIN
EXOTIC OPTIONS
126
4 August 2003
Contents
Adfin Exotics
OpAsianDeriv
OpAsianImpliedVol
OpAsianPremium
4 August 2003
127
Adfin Exotics
Adfin Exotics
The Exotics functions include:
Asian Options Functions
Barrier Options Functions
Basket Options Functions
Binary Options Functions
Chooser Options Functions
Cliquet Options Functions
Compound Options Functions
Double Barrier Options Functions
ExLookBack Options Functions
FxLinked Options Functions
Power Options Functions
Rainbow Options Functions
OpAsianDeriv
Purpose
Syntax
Arguments
Returns all derivatives (delta, gamma, rho, theta, and vega) of an Asian option in an array. At
maturity, this type of option pays either the difference between the average of the underlying prices
and the strike price, or the difference between the underlying price at maturity and the average of the
underlying prices.
=OpAsianDeriv(CalcDate, FirstFixingDate, ExpiryDate, SpotPrice, StrikePrice,
AveragePrice, NbFixing, Volatility, RiskFreeRateArray, ReturnArray,
ExoticStucture, RateStructure, CalcStructure, AdMode)
CalcDate
FirstFixingDate
ExpiryDate
SpotPrice
128
Calculation date
Date of the first fixing for the average calculation
Expiry date of the option
Market or spot price of the underlying instrument
4 August 2003
StrikePrice
AveragePrice
NbFixing
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
AdMode
OpAsianImpliedVol
Purpose
Syntax
Arguments
Calculates the implied volatility of an Asian option. At maturity, this type of option pays either the
difference between the average of the underlying prices and the strike price, or the difference
between the underlying price at maturity and the average of the underlying prices.
=OpAsianImpliedVol(CalcDate, FirstFixingDate, ExpiryDate, SpotPrice, StrikePrice,
AveragePrice, NbFixing, Premium, RiskFreeRateArray, ReturnArray, ExoticStucture,
RateStructure, CalcStructure)
CalcDate
FirstFixingDate
ExpiryDate
SpotPrice
StrikePrice
AveragePrice
NbFixing
Calculation date
Date of the first fixing for the average calculation
Expiry date of the option
Market or spot price of the underlying instrument
Exercise or strike price of the option, ignored for average strike options
Average of the underlying prices from the first fixing date to the
calculation date
Number of fixings used to calculate the average
4 August 2003
129
OpAsianPremium
Premium
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
OpAsianPremium
Purpose
Syntax
Arguments
Calculates the premium of an Asian option. At maturity, this type of option pays either the difference
between the average of the underlying prices and the strike price, or the difference between the
underlying price at maturity and the average of the underlying prices.
=OpAsianPremium(CalcDate, FirstFixingDate, ExpiryDate, SpotPrice, StrikePrice,
AveragePrice, NbFixing, Volatility, RiskFreeRateArray, ReturnArray,
ExoticStructure, RateStructure, CalcStructure)
CalcDate
FirstFixingDate
ExpiryDate
SpotPrice
StrikePrice
AveragePrice
NbFixing
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
130
Calculation date
Date of the first fixing for the average calculation
Expiry date of the option
Market or spot price of the underlying instrument
Exercise or strike price of the option, ignored for average strike
options
Average of the underlying prices from the first fixing date to the
calculation date
Number of fixings used to calculate the average
Anticipated volatility of the underlying instrument
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
4 August 2003
RateStructure
CalcStructure
4 August 2003
131
OpAsianPremium
132
4 August 2003
Contents
OpBarrierDeriv
OpBarrierImpliedVol
OpBarrierPremium
4 August 2003
133
OpBarrierDeriv
OpBarrierDeriv
Purpose
Syntax
Arguments
Returns all derivatives (delta, gamma, rho, theta, and vega) of a Barrier option in an array. At
maturity, this type of option pays either the difference between the strike price and the underlying
price if activated, or an agreed rebate if the option is knocked out or if it fails to knock-in.
=OpBarrierDeriv(CalcDate, ExpiryDate, SpotPrice, StrikePrice, BarrierPrice,
Volatility, RiskFreeRateArray, ReturnArray, ExoticStucture, RateStructure,
CalcStructure, AdMode)
CalcDate
ExpiryDate
SpotPrice
StrikePrice
BarrierPrice
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
AdMode
Calculation date
Expiry date of the option
Market or spot price of the underlying instrument
Exercise or strike price of the option
Price of the barrier of the option
Anticipated volatility of the underlying instrument
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the structure of the interest rate model
(see RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
OpBarrierImpliedVol
Purpose
134
Calculates the implied volatility of a Barrier option. At maturity, this option pays either the difference
between the strike price and the underlying price if activated, or an agreed rebate if the option is
knocked out or if it fails to knock-in.
4 August 2003
Syntax
Arguments
CalcDate
ExpiryDate
SpotPrice
StrikePrice
BarrierPrice
Premium
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
Calculation date
Expiry date of the option
Market or spot price of the underlying instrument
Exercise or strike price of the option
Price of the barrier of the option
Premium of the option
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the structure of the interest rate model
(see RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
OpBarrierPremium
Purpose
Syntax
Arguments
Calculates the premium of a Barrier option. At maturity, this type of option pays either the difference
between the strike price and the underlying price if activated, or an agreed rebate if the option is
knocked out or if it fails to knock-in.
=OpBarrierPremium(CalcDate, ExpiryDate, SpotPrice, StrikePrice, BarrierPrice,
Volatility, RiskFreeRateArray, ReturnArray, ExoticStucture, RateStructure,
CalcStructure)
CalcDate
ExpiryDate
SpotPrice
StrikePrice
BarrierPrice
Calculation date
Expiry date of the option
Market or spot price of the underlying instrument
Exercise or strike price of the option
Price of the barrier of the option
4 August 2003
135
OpBarrierPremium
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
136
4 August 2003
Contents
OpBasketDeriv
OpBasketPremium
4 August 2003
137
OpBasketDeriv
OpBasketDeriv
Purpose
Syntax
Arguments
Returns all derivatives (delta, gamma, rho, theta, and vega) of a Basket option in an array. Basket
options, also called portfolio options, are a variation of Rainbow options. Their payoff is the weighted
average of the prices within the basket of underlying assets.
=OpBasketDeriv(CalcDate, ExpiryDate, SpotPriceArray, StrikePrice,
CorrelationArray, RiskFreeRateArray, ReturnArray, NbSharesArray, ExoticStucture,
RateStructure, CalcStructure, AdMode)
CalcDate
ExpiryDate
SpotPriceArray
StrikePrice
CorrelationArray
RiskFreeRateArray
ReturnArray
NbSharesArray
ExoticStructure
RateStructure
CalcStructure
AdMode
138
Calculation date
Expiry date of the option
Array containing the spot prices of the underlying instruments
Strike price of the option
Array containing the volatilities of the assets on the diagonal and the
correlation coefficients
Array of data depending on the rate model chosen:
constant risk free rate
zero-coupon curve
Array containing the annualized dividend rates of the underlying
instruments
Specifies the number of shares for each asset
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
4 August 2003
OpBasketPremium
Purpose
Syntax
Arguments
Calculates the premium of a Basket option. Basket options, also called portfolio options, are a
variation of Rainbow options. Their payoff is the weighted average of the prices within the basket of
underlying assets.
=OpBasketPremium(CalcDate, ExpiryDate, SpotPriceArray, StrikePrice,
CorrelationArray, RiskFreeRateArray, ReturnArray, NbSharesArray, ExoticStucture,
RateStructure, CalcStructure)
CalcDate
ExpiryDate
SpotPriceArray
StrikePrice
CorrelationArray
RiskFreeRateArray
ReturnArray
NbSharesArray
ExoticStructure
RateStructure
CalcStructure
Calculation date
Expiry date of the option
Array containing the spot prices of the underlying instruments
Strike price of the option
Array containing the volatilities of the assets on the diagonal and the
correlation coefficients
Array of data depending on the rate model chosen:
constant risk free rate
zero-coupon curve
Array containing the annualized dividend rates of the underlying
instruments
Specifies the number of shares for each asset
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
4 August 2003
139
OpBasketPremium
140
4 August 2003
Contents
OpBinaryDeriv
OpBinaryImpliedVol
OpBinaryPremium
4 August 2003
141
OpBinaryDeriv
OpBinaryDeriv
Purpose
Syntax
Arguments
Returns all derivatives (delta, gamma, rho, theta, and vega) of an All-or-Nothing Binary option or
One -Touch/No-Touch Binary option in an array. At maturity or when the barrier is reached, this type
of option pays a fixed amount of cash or the asset.
=OpBinaryDeriv(CalcDate, ExpiryDate, SpotPrice, BarrierPrice, StrikePrice,
CashAmount, Volatility, RiskFreeRateArray, ReturnArray, ExoticStucture,
RateStructure, CalcStructure, AdMode)
CalcDate
ExpiryDate
SpotPrice
BarrierPrice
StrikePrice
CashAmount
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
AdMode
Calculation date
Expiry date of the option
Market or spot price of the underlying instrument
Price of the barrier of the option
Exercise or strike price of the option
Fixed amount of cash paid if applicable
Anticipated volatility of the underlying instrument
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
OpBinaryImpliedVol
Purpose
142
4 August 2003
Syntax
Arguments
CalcDate
ExpiryDate
SpotPrice
BarrierPrice
StrikePrice
CashAmount
Premium
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
Calculation date
Expiry date of the option
Market or spot price of the underlying instrument
Price of the barrier of the option
Exercise or strike price of the option
Fixed amount of cash paid if applicable
Premium of the option
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
OpBinaryPremium
Purpose
Syntax
Arguments
CalcDate
ExpiryDate
SpotPrice
BarrierPrice
StrikePrice
Calculation date
Expiry date of the option
Market or spot price of the underlying instrument
Price of the barrier of the option
Exercise or strike price of the option
4 August 2003
143
OpBinaryPremium
CashAmount
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
144
4 August 2003
Contents
OpChooserDeriv
OpChooserImpliedVol
OpChooserPremium
4 August 2003
145
OpChooserDeriv
OpChooserDeriv
Purpose
Syntax
Arguments
Returns all derivatives (delta, gamma, rho, theta, vega) of a Chooser option in an array. Chooser
options allow the holder to choose at some pre-determined future date whether the option is a call or
a put, with the same predefined strike price and expiry date.
=OpChooserDeriv(CalcDate, ExpiryDate, PutExpiryDate, CallExpiryDate, SpotPrice,
PutStrikePrice, CallStrikePrice, Volatility, RiskFreeRateArray, ReturnArray,
ExoticStucture, RateStructure, CalcStructure, AdMode)
CalcDate
ExpiryDate
PutExpiryDate
CallExpiryDate
SpotPrice
PutStrikePrice
CallStrikePrice
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
AdMode
Calculation date
Maturity date of the option
Expiry date of the underlying put option
Expiry date of the underlying call option
Market or spot price of the underlying stock
Exercise or strike price of the underlying put option
Exercise or strike price of the underlying call option
Anticipated volatility of the underlying instrument
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
OpChooserImpliedVol
Purpose
146
Calculates the implied volatility of a Chooser option. Chooser options allow the holder to choose at
some pre-determined future date whether the option is a call or a put, with the same predefined
strike price and expiry date.
4 August 2003
Syntax
Arguments
CalcDate
ExpiryDate
PutExpiryDate
CallExpiryDate
SpotPrice
PutStrikePrice
CallStrikePrice
Premium
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
Calculation date
Maturity date of the option
Expiry date of the underlying put option
Expiry date of the underlying call option
Market or spot price of the underlying stock
Exercise or strike price of the underlying put option
Exercise or strike price of the underlying call option
Premium of the option
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
OpChooserPremium
Purpose
Syntax
Arguments
Calculates the premium of a Chooser option. Chooser options allow the holder to choose at some
pre-determined future date whether the option is a call or a put, with the same predefined strike price
and expiry date.
=OpChooserPremium(CalcDate, ExpiryDate, PutExpiryDate, CallExpiryDate, SpotPrice,
PutStrikePrice, CallStrikePrice, Volatility, RiskFreeRateArray, ReturnArray,
ExoticStucture, RateStructure, CalcStructure)
CalcDate
ExpiryDate
PutExpiryDate
Calculation date
Expiry date of the option
Expiry date of the underlying put option
4 August 2003
147
OpChooserPremium
CallExpiryDate
SpotPrice
PutStrikePrice
CallStrikePrice
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
148
4 August 2003
Contents
OpCliquetDeriv
OpCliquetImpliedVol
OpCliquetPremium
4 August 2003
149
OpCliquetDeriv
OpCliquetDeriv
Purpose
Syntax
Arguments
Returns in an array all derivatives (delta, gamma, rho, theta, vega) of a Cliquet option or a
Forward-Start option. A Cliquet or Ratchet option is essentially a series of Forward-Start options with
increasing maturities and strike prices set at the maturity date of the previous option.
=OpCliquetDeriv(CalcDate, StartDateArray, ExpiryDateArray, SpotPrice,
StrikePrice, Volatility, RiskFreeRateArray, ReturnArray, ExoticStucture,
RateStructure, CalcStructure, AdMode)
CalcDate
StartDateArray
ExpiryDateArray
SpotPrice
StrikePrice
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
AdMode
Calculation date
Array of start dates of each Forward-Start option
Array of expiry dates of each Forward-Start option
Market or spot price of the underlying instrument
Exercise or strike price of the option
Anticipated volatility of the underlying instrument
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
OpCliquetImpliedVol
Purpose
150
Calculates the implied volatility of a Cliquet option or a Forward-Start option. A Cliquet or Ratchet
option is essentially a series of Forward-Start options with increasing maturities and strike prices set
at the maturity date of the previous option.
4 August 2003
Syntax
Arguments
CalcDate
StartDateArray
ExpiryDateArray
SpotPrice
StrikePrice
Premium
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
Calculation date
Array of start dates of each Forward-Start option
Array of expiry dates of each Forward-Start option
Market or spot price of the underlying instrument
Exercise or strike price of the option
Premium of the option
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
OpCliquetPremium
Purpose
Syntax
Arguments
Calculates the premium of a Cliquet option or a Forward-Start option. A Cliquet or Ratchet option is
essentially a series of Forward-Start options with increasing maturities and strike prices set at the
maturity date of the previous option.
=OpCliquetPremium(CalcDate, StartDateArray, ExpiryDateArray, SpotPrice,
StrikePrice, Volatility, RiskFreeRateArray, ReturnArray, ExoticStucture,
RateStructure, CalcStructure)
CalcDate
StartDateArray
ExpiryDateArray
SpotPrice
StrikePrice
Calculation date
Array of start dates of each Forward-Start option
Array of expiry dates of each Forward-Start option
Market or spot price of the underlying instrument
Exercise or strike price of the option
4 August 2003
151
OpCliquetPremium
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
152
4 August 2003
Contents
OpCompoundDeriv
OpCompoundImpliedVol
OpCompoundPremium
4 August 2003
153
OpCompoundDeriv
OpCompoundDeriv
Purpose
Syntax
Arguments
Returns all derivatives (delta, gamma, rho, theta, and vega) of a Compound option in an array. This
function calculates the derivatives of European Compound options also known as options on
options. An option on option gives the option holder the right to sell or buy an option.
=OpCompoundDeriv(CalcDate, ExpiryDate, CmpExpiryDate, SpotPrice, StrikePrice,
CmpStrikePrice, Volatility, RiskFreeRateArray, ReturnArray, ExoticStructure,
RateStructure, CalcStructure, AdMode)
CalcDate
ExpiryDate
CmpExpiryDate
SpotPrice
StrikePrice
CmpStrikePrice
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
AdMode
Calculation date
Expiry date of the option
Expiry date of the Compound option
Market or spot price of the underlying instrument
Exercise or strike price of the option
Strike price of the Compound option
Anticipated volatility of the underlying instrument
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
OpCompoundImpliedVol
Purpose
154
Calculates the implied volatility of a Compound option. This function calculates the implied volatility
of European Compound options also known as options on options. An option on option gives the
option holder the right to sell or buy an option.
4 August 2003
Syntax
Arguments
CalcDate
ExpiryDate
CmpExpiryDate
SpotPrice
StrikePrice
CmpStrikePrice
Premium
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
Calculation date
Expiry date of the option
Expiry date of the Compound option
Market or spot price of the underlying instrument
Exercise or strike price of the option
Strike price of the Compound option
Premium of the option
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
OpCompoundPremium
Purpose
Syntax
Arguments
Calculates the premium of a Compound option. This function calculates the premium of European
Compound options also known as options on options. An option on option gives the option holder
the right to sell or buy an option.
=OpCompoundPremium(CalcDate, ExpiryDate, CmpExpiryDate, SpotPrice, StrikePrice,
CmpStrikePrice, Volatility, RiskFreeRateArray, ReturnArray, ExoticStucture,
RateStructure, CalcStructure)
CalcDate
ExpiryDate
CmpExpiryDate
SpotPrice
Calculation date
Expiry date of the option
Expiry date of the Compound option
Market or spot price of the underlying instrument
4 August 2003
155
OpCompoundPremium
StrikePrice
CmpdStrikePrice
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
156
4 August 2003
Contents
OpDoubleBarrierDeriv
OpDoubleBarrierImpliedVol
OpDoubleBarrierPremium
4 August 2003
157
OpDoubleBarrierDeriv
OpDoubleBarrierDeriv
Purpose
Syntax
Arguments
Returns in an array all derivatives (delta, gamma, rho, theta, vega) of a Double Barrier option.
Barrier options are options where the right to exercise depends on whether the underlying asset
price reaches a predefined barrier level during the lifetime of the option. Double Barrier options have
two barrier levels, one above and one below the current price of the underlying asset.
=OpDoubleBarrierDeriv(CalcDate, ExpiryDate, SpotPrice, StrikePrice,
LowerBarrierPrice, UpperBarrierPrice, Volatility, RiskFreeRateArray, ReturnArray,
ExoticStucture, RateStructure, CalcStructure, AdMode)
CalcDate
ExpiryDate
SpotPrice
StrikePrice
LowerBarrierPrice
UpperBarrierPrice
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
AdMode
Calculation date
Expiry date of the option (also date of the last fixing)
Market or spot price of the underlying instrument
Exercise or strike price of the option
Price of the lower barrier of the option
Price of the upper barrier of the option
Anticipated volatility of the underlying
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
OpDoubleBarrierImpliedVol
Purpose
158
Calculates the implied volatility of a Double Barrier option. Barrier options are options where the right
to exercise depends on whether the underlying asset price reaches a predefined barrier level during
the lifetime of the option. Double Barrier options have two barrier levels, one above and one below
the current price of the underlying asset.
4 August 2003
Syntax
Arguments
CalcDate
ExpiryDate
SpotPrice
StrikePrice
LowerBarrierPrice
UpperBarrierPrice
Premium
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
Calculation date
Expiry date of the option (also date of the last fixing)
Market or spot price of the underlying instrument
Strike price of the option
Price of the lower barrier of the option
Price of the upper barrier of the option
Premium of the option
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
OpDoubleBarrierPremium
Purpose
Syntax
Arguments
Calculates the premium of a Double Barrier option. Barrier options are options where the right to
exercise depends on whether the underlying asset price reaches a predefined barrier level during
the lifetime of the option. Double Barrier options have two barrier levels, one above and one below
the current price of the underlying asset.
=OpDoubleBarrierPremium(CalcDate, ExpiryDate, SpotPrice, StrikePrice,
LowerBarrierPrice, UpperBarrierPrice, Volatility, RiskFreeRateArray, ReturnArray,
ExoticStucture, RateStructure, CalcStructure)
CalcDate
ExpiryDate
SpotPrice
Calculation date
Expiry date of the option (also date of the last fixing)
Market or spot price of the underlying instrument
4 August 2003
159
OpDoubleBarrierPremium
StrikePrice
LowerBarrierPrice
UpperBarrierPrice
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
160
4 August 2003
Contents
OpExLookbackDeriv
OpExLookbackImpliedVol
OpExLookbackPremium
4 August 2003
161
OpExLookbackDeriv
OpExLookbackDeriv
Purpose
Syntax
Arguments
Returns all derivatives (delta, gamma, rho, theta, and vega) of a Lookback Strike option or Lookback
Spot option in an array. At maturity, this type of option pays either the difference between the
underlying spot price and the lowest (highest) price achieved during the life of the call (put), or the
difference between the highest (lowest) price achieved during the life of the call (put) and the strike
price.
=OpExLookbackDeriv(CalcDate, ExpiryDate, SpotPrice, StrikePrice, Min/Max,
VolatilityArray, RiskFreeRateArray, ReturnArray, ExoticStucture, RateStructure,
CalcStructure, AdMode)
StrikePrice
Calculation date
Expiry date of the option (also date of the last fixing)
Exercise or spot price of the underlying instrument
Strike price of the option, ignored for Lookback Strike options
Min/Max
CalcDate
ExpiryDate
SpotPrice
VolatilityArray
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
AdMode
162
Lowest price for a call or highest price for a put achieved so far for
Lookback Strike options
Highest price for a call or lowest price for a put achieved so far for
Lookback Spot options
4 August 2003
OpExLookbackImpliedVol
Purpose
Syntax
Arguments
Calculates the implied volatility of a Lookback Strike option or Lookback Spot option. At maturity, this
type of option pays either the difference between the underlying spot price and the lowest (highest)
price achieved during the life of the call (put), or the difference between the highest (lowest) price
achieved during the life of the call (put) and the strike price.
=OpExLookbackImpliedVol(CalcDate, ExpiryDate, SpotPrice, StrikePrice, Min/Max,
Premium, RiskFreeRateArray, ReturnArray, ExoticStucture, RateStructure,
CalcStructure)
StrikePrice
Calculation date
Expiry date of the option (also date of the last fixing)
Market or spot price of the underlying instrument
Exercise or strike of the option, ignored for Lookback Strike options
Min/Max
CalcDate
ExpiryDate
SpotPrice
Premium
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
Lowest price for a call or highest price for a put achieved so far for
Lookback Strike options
Highest price for a call or lowest price for a put achieved so far for
Lookback Spot options
OpExLookbackPremium
Purpose
Calculates the premium of a Lookback Strike option or Lookback Spot option. At maturity, this type of
option pays either the difference between the underlying spot price and the lowest (highest) price
achieved during the life of the call (put), or the difference between the highest (lowest) price
achieved during the life of the call (put) and the strike price.
4 August 2003
163
OpExLookbackPremium
Syntax
Arguments
StrikePrice
Calculation date
Expiry date of the option (also date of the last fixing)
Market or spot price of the underlying instrument
Exercise or strike of the option, ignored for Lookback Strike options
Min/Max
CalcDate
ExpiryDate
SpotPrice
VolatilityArray
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
164
Lowest price for a call or highest price for a put achieved so far for
Lookback Strike options
Highest price for a call or lowest price for a put achieved so far for
Lookback Spot options
4 August 2003
Contents
OpFxLinkedDeriv
OpFxLinkedImpliedVol
OpFxLinkedPremium
4 August 2003
165
OpFxLinkedDeriv
OpFxLinkedDeriv
Purpose
Syntax
Arguments
Returns all derivatives (delta, gamma, rho, theta, and vega) of a Quanto, Composite, or Equity
Linked Foreign Exchange option in an array. Quanto (quantity-adjusting) options are mainly used to
eliminate the foreign exchange risk when the underlying asset is denominated in a currency other
than the currency of the option, exchange rate being fixed to the calculation date. A Composite
option is an option on a foreign equity where the strike is denominated in domestic currency. A
Composite option has an exposure on the exchange risk. In an Equity Linked Foreign Exchange
option, the face value is linked to the forward price of a stock or equity index. This is an ideal option
for an investor who wants to speculate directly in a foreign equity market but wishes to place a floor
on the currency exposure.
=OpFxLinkedDeriv(CalcDate, ExpiryDate, ExchangeRate, SpotPrice, StrikePrice,
ERVolatility, Volatility, Correlation, RiskFreeRateArray, ForeignRateArray,
ReturnArray, ExoticStucture, RateStructure, CalcStructure, AdMode)
CalcDate
ExpiryDate
ExchangeRate
SpotPrice
StrikePrice
ERVolatility
Volatility
Correlation
RiskFreeRateArray
ForeignRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
AdMode
166
Calculation date
Expiry date of the option
Spot exchange rate specified in units of the domestic currency per unit
of the foreign currency
Market or spot price of the underlying instrument
Exercise or strike price of the option
Anticipated volatility of the exchange rate
Anticipated volatility of the underlying instrument
Correlation between asset and domestic exchange rate
Array of data depending on the rate model chosen
Yearly rate of the foreign market for an equivalent risk-free investment
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
4 August 2003
OpFxLinkedImpliedVol
Purpose
Returns:
Quanto (quantity-adjusting) options are mainly used to eliminate the foreign exchange risk when the
underlying asset is denominated in a currency other than the currency of the option, exchange rate
being fixed to the calculation date. A Composite option is an option on a foreign equity where the
strike is denominated in domestic currency. A Composite option has an exposure on the exchange
risk. In an Equity Linked Foreign Exchange option, the face value is linked to the forward price of a
stock or equity index. This is an ideal option for an investor who wants to speculate directly in a
foreign equity market but wishes to place a floor on the currency exposure.
Syntax
Arguments
StrikePrice
Calculation date
Expiry date of the option
Spot exchange rate specified in units of the domestic currency per unit
of the foreign currency
Market or spot price of the underlying instrument
Exercise or strike price of the option
Premium
ERVolatility
CalcDate
ExpiryDate
ExchangeRate
SpotPrice
Correlation
RiskFreeRateArray
ForeignRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
4 August 2003
167
OpFxLinkedPremium
OpFxLinkedPremium
Purpose
Syntax
Arguments
Calculates the premium of a Quanto, Composite, or Equity Linked Foreign Exchange option. Quanto
(quantity-adjusting) options are mainly used to eliminate the foreign exchange risk when the
underlying asset is denominated in a currency other than the currency of the option, exchange rate
being fixed to the calculation date. A Composite option is an option on a foreign equity where the
strike is denominated in domestic currency. A Composite option has an exposure on the exchange
risk. In an Equity Linked Foreign Exchange option, the face value is linked to the forward price of a
stock or equity index. This is an ideal option for an investor who wants to speculate directly in a
foreign equity market but wishes to place a floor on the currency exposure.
=OpFxLinkedPremium(CalcDate, ExpiryDate, ExchangeRate, SpotPrice, StrikePrice,
ERVolatility, Volatility, Correlation, RiskFreeRateArray, ForeignRateArray,
ReturnArray, ExoticStucture, RateStructure, CalcStructure)
CalcDate
ExpiryDate
ExchangeRate
SpotPrice
StrikePrice
ERVolatility
Volatility
Correlation
RiskFreeRateArray
ForeignRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
168
Calculation date
Expiry date of the option
Spot exchange rate specified in units of the domestic currency per unit
of the foreign currency
Market or spot price of the underlying instrument
Exercise or strike price of the option
Anticipated volatility of the exchange rate
Anticipated volatility of the underlying instrument
Correlation between asset and domestic exchange rate
Array of data depending on the rate model chosen
Yearly rate of the foreign market for an equivalent risk-free investment
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
4 August 2003
Contents
OpPowerDeriv
OpPowerImpliedVol
OpPowerPremium
4 August 2003
169
OpPowerDeriv
OpPowerDeriv
Purpose
Syntax
Arguments
Returns in an array all derivatives (delta, gamma, rho, theta, and vega) of an asymmetric Power
option where the payoff is expressed as:
=OpPowerDeriv(CalcDate, ExpiryDate, SpotPrice, StrikePrice, Alpha, Power,
Volatility, RiskFreeRateArray, ReturnArray, ExoticStucture, RateStructure,
CalcStructure, AdMode)
CalcDate
ExpiryDate
SpotPrice
StrikePrice
Alpha
Power
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
AdMode
Calculation date
Expiry date of the option
Spot price of the underlying stock (S)
Strike price of the option (X)
Polynomial coefficient ()
Power coefficient (v)
Anticipated volatility of the underlying instrument
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
OpPowerImpliedVol
Purpose
Calculates the implied volatility of an asymmetric Power option where the payoff is expressed as:
max ( S X, 0 )
170
4 August 2003
Syntax
Arguments
CalcDate
ExpiryDate
SpotPrice
StrikePrice
Alpha
Power
Premium
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
Calculation date
Expiry date of the option
Market or spot price of the underlying instrument (S)
Strike price of the option (X)
Polynomial coefficient ()
Power coefficient (v)
Market or spot price of the option
Array of data depending on the rate model chosen
Array of annualized dividend rates
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
OpPowerPremium
Purpose
Calculates the premium of an asymmetric Power option where the payoff is expressed as:
max ( S X, 0 )
Syntax
Arguments
CalcDate
ExpiryDate
Calculation date
Expiry date of the option
4 August 2003
171
OpPowerPremium
SpotPrice
StrikePrice
Alpha
Power
Volatility
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
172
4 August 2003
Contents
OpRainbowDeriv
OpRainbowPremium
4 August 2003
173
OpRainbowDeriv
OpRainbowDeriv
Purpose
Syntax
Arguments
Returns all derivatives (delta, gamma, rho, theta, and vega) of a Spread or a Two-Color Rainbow
option in an array. Rainbow options are options for which final payoff is determined by the highest
performance achieved at the expiration date by two or more underlying assets. Rainbow options can
be either American or European options.
=OpRainbowDeriv(CalcDate, ExpiryDate, SpotPriceArray, StrikePriceArray,
CorrelationArray, RiskFreeRateArray, ReturnArray, ExoticStucture, RateStructure,
CalcStructure, AdMode)
CalcDate
ExpiryDate
SpotPriceArray
StrikePriceArray
CorrelationArray
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
AdMode
174
Calculation date
Expiry date of the option
Spot prices of the underlying instruments
Strike price, and second strike price of a Dual-Strike option
Array containing the volatilities of the assets on the diagonal and the
correlation coefficient
Array of data depending on the rate model chosen:
constant risk free rate
zero-coupon curve
Array containing the annualized dividend rates of the underlying
instruments
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see RateStructure
on page 365)
Extended argument defining the calculation method (see CalcStructure
on page 262)
Extended argument customizing the return value (see AdMode on
page 237)
4 August 2003
OpRainbowPremium
Purpose
Syntax
Arguments
Calculates the premium of a Spread or a Two-Color Rainbow option. Rainbow options are options
for which final payoff is determined by the highest performance achieved at the expiration date by
two or more underlying assets. Rainbow options can be either American or European options.
=OpRainbowPremium(CalcDate, ExpiryDate, SpotPriceArray, StrikePriceArray,
CorrelationArray, RiskFreeRateArray, ReturnArray, ExoticStucture, RateStructure,
CalcStructure)
CalcDate
ExpiryDate
SpotPriceArray
StrikePriceArray
CorrelationArray
RiskFreeRateArray
ReturnArray
ExoticStructure
RateStructure
CalcStructure
Calculation date
Expiry date of the option
Spot prices of the underlying instruments
Strike of the option. Can be a table in the case of a Dual-Strike option
Array containing the volatilities of the assets on the diagonal and the
correlation coefficient
Array of data depending on the rate model chosen:
constant risk free rate
zero-coupon curve
Array containing the annualized dividend rates of the underlying
instruments
Extended argument defining the exotic option structure (see
ExoticStructure on page 309)
Extended argument defining the interest rate model (see
RateStructure on page 365)
Extended argument defining the calculation method (see
CalcStructure on page 262)
4 August 2003
175
OpRainbowPremium
176
4 August 2003
PART VIII:
REUTERS ADFIN
SWAPS
178
4 August 2003
C H A P T E R 2 9 I N T E R E S T R A T E S W A PS F U N C T I O N S
Contents
SwIrsCashFlows
SwIrsCpnDates
SwIrsPvbpCrv
SwIrsPx
SwIrsSolve
SwZcToIrs
4 August 2003
179
SwIrsCashFlows
SwIrsCashFlows
Purpose
Generates an array with the remaining cash flows of the interest rate swap.
Syntax
Arguments
CalcDate
ZcDates
ZcRates
StartDate
Maturity
FixedRate
CurFloatingRate
IrsStructure
SwMode
Calculation date
Array of zero-coupon dates
Array of zero-coupon rates or discount factors
Start date of the interest rate swap (effective date)
Maturity date of the interest rate swap (expressed as a date or a code
such as "1Y")
Rate of the swap fixed leg
Rate of the swap floating leg for the current calculation period
Extended argument defining the interest rate swap (see IrsStructure
on page 346)
Extended argument customizing the return value (see SwMode on
page 386)
SwIrsCpnDates
Purpose
Syntax
Arguments
CalcDate
StartDate
Maturity
IrsStructure
180
Calculation date
Start date of the interest rate swap (effective date)
Maturity date of the interest rate swap (expressed as a date or a code
such as "1Y")
Extended argument defining the interest rate swap (see IrsStructure
on page 346)
4 August 2003
SwMode
SwIrsPvbpCrv
Purpose
Syntax
Arguments
Calculates the price variation per basis point of a swap or one of its legs for each point of a
zero-coupon yield curve.
=SwIrsPvbpCrv(CalcDate, ZcDates, ZcRates, StartDate, Maturity, FixedRate,
CurFloatingRate, IrsStructure, SwMode)
CalcDate
ZcDates
ZcRates
StartDate
Maturity
FixedRate
CurFloatingRate
IrsStructure
SwMode
Calculation date
Array of zero-coupon dates
Array of zero-coupon rates or discount factors
Start date of the interest rate swap (effective date)
Maturity date of the interest rate swap (expressed as a date or a code
such as "1Y")
Rate of the swap fixed leg
Rate of the swap floating leg for the current calculation period
Extended argument defining the interest rate Swap (see IrsStructure
on page 346)
Extended argument customizing the return value (see SwMode on
page 386)
SwIrsPx
Purpose
Syntax
Arguments
Calculates the net present value of an interest rate swap or one of its legs.
=SwIrsPx(CalcDate, ZcDates, ZcRates, StartDate, Maturity, FixedRate,
CurFloatingRate, IrsStructure, SwMode)
CalcDate
ZcDates
Calculation date
Array of zero-coupon dates
4 August 2003
181
SwIrsSolve
ZcRates
StartDate
Maturity
FixedRate
CurFloatingRate
IrsStructure
SwMode
SwIrsSolve
Purpose
Calculates the fixed rate or the floating rate spread equivalent to a predefined net present value.
To distinguish between both cases, the expected result must be specified in SwMode using the RES
keyword ("RES:FIXED" or "RES:FLOAT").
Syntax
Arguments
CalcDate
ZcDates
ZcRates
StartDate
Maturity
FixedRate
CurFloatingRate
NetPresentValue
IrsStructure
SwMode
182
Calculation date
Array of zero-coupon dates
Array of zero-coupon rates or discount factors
Start date of the interest rate swap (effective date)
Maturity date of the interest rate swap (expressed as a date or a code such
as "1Y")
Rate of the swap fixed leg
Rate of the swap floating leg for the current calculation period
Present value of the swap or one of its legs
Extended argument defining the interest rate swap (see IrsStructure on
page 346)
Extended argument customizing the return value (see SwMode on page
386)
4 August 2003
SwZcToIrs
Purpose
Calculates the standard swap rates implied by the zero-coupon yield curve.
The maturities included in the array returned by the function can be defined using the MATRANGE
keyword in SwMode.
Note
Syntax
Arguments
CalcDate
ZcDates
ZcRates
IrsStructure
SwMode
Calculation date
Array of zero-coupon dates
Array of zero-coupon rates or discount factors
Extended argument defining the interest rate swap (see IrsStructure
on page 346)
Extended argument customizing the return value (see SwMode on
page 386)
4 August 2003
183
SwZcToIrs
184
4 August 2003
C H A P T E R 3 0 C U R R E N C Y S W A PS F U N C T I O N S
Contents
SwCsCashFlows
SwCsPx
SwCsSolve
SwSwpExtend
4 August 2003
185
SwCsCashFlows
SwCsCashFlows
Purpose
Syntax
Arguments
Generates an array with the remaining cash flows of the currency swap.
=SwCsCashFlows(CalcDate, StartDate, Maturity, PaidRate, CurPaidRate,
ReceivedRate, CurReceivedRate, ZcPaidArray, ZcReceivedArray, FxArray,
CsStructure, SwMode)
CalcDate
StartDate
Maturity
PaidRate
CurPaidRate
ReceivedRate
CurReceivedRate
ZcPaidArray
ZcReceivedArray
FxArray
CsStructure
SwMode
Calculation date
Start date of the currency swap (effective date)
Maturity date of the currency swap (expressed as a date or a code such as
"1Y")
Fixed rate if the paid leg is fixed, floating rate spread as a percentage if the
paid leg is floating
Floating rate of the paid leg for the current calculation period if applicable
Fixed rate if the received leg is fixed, floating rate spread as a percentage if
the received leg is floating
Floating rate of the received leg for the current calculation period if applicable
Array of zero-coupon dates and rates or discount factors for the paid leg
Array of zero-coupon dates and rates or discount factors for the received leg
Array of (N+1) cells x 2 cells (dates, rates) where N is the number of swap
point periods
The first line (row or column depending on the array orientation specified
with the LAY keyword) contains the spot date and the spot rate for the
cross-currency.
The other lines contain swap point period end dates and corresponding
swap point values for the cross-currency.
Extended argument defining the currency swap structure (see CsStructure
on page 280)
Extended argument customizing the return value (see SwMode on page
386)
SwCsPx
Purpose
186
Calculates the net present value of a currency swap or one of its legs.
4 August 2003
Syntax
Arguments
CalcDate
StartDate
Maturity
PaidRate
CurPaidRate
ReceivedRate
CurReceivedRate
ZcPaidArray
ZcReceivedArray
FxArray
CsStructure
SwMode
Calculation date
Start date of the currency swap (effective date)
Maturity date of the currency swap (expressed as a date or a code such as
"1Y")
Fixed rate if the paid leg is fixed, floating rate spread as a percentage if the
paid leg is floating
Floating rate of the paid leg for the current calculation period if applicable
Fixed rate if the received leg is fixed, floating rate spread as a percentage if
the received leg is floating
Floating rate of the received leg for the current calculation period if
applicable
Array of zero-coupon dates and rates or discount factors for the paid leg
Array of zero-coupon dates and rates or discount factors for the received leg
Array of (N+1) cells x 2 cells (dates, rates) where N is the number of swap
point periods
The first line (row or column depending on the array orientation specified
with the LAY keyword) contains the spot date and the spot rate for the
cross-currency.
The other lines contain swap point period end dates and corresponding
swap point values for the cross-currency.
Extended argument defining the currency swap structure (see CsStructure
on page 280)
Extended argument customizing the return value (see SwMode on page
386)
SwCsSolve
Purpose
Calculates the paid rate or the received rate spread for any leg equivalent to a predefined net
present value.
To specify for which leg the fixed rate or the floating rate spread is calculated, use the RES keyword
in SwMode ("RES:PAID" or "RES:RECEIVED").
4 August 2003
187
SwCsSolve
Syntax
Arguments
CalcDate
StartDate
Maturity
PaidRate
CurPaidRate
ReceivedRate
CurReceivedRate
ZcPaidArray
ZcReceivedArray
FxArray
NetPresentValue
CsStructure
SwMode
188
Calculation date
Start date of the currency swap (effective date)
Maturity date of the currency swap (expressed as a date or a code
such as "1Y")
Fixed rate iff the paid leg is fixed, floating rate spread as a percentage
if the paid leg is floating
Floating rate of the paid leg for the current calculation period if
applicable
Fixed rate if the received leg is fixed, floating rate spread as a
percentage if the received leg is floating
Floating rate of the received leg for the current calculation period if
applicable
Array of zero-coupon dates and rates or discount factors for the paid
leg
Array of zero-coupon dates and rates or discount factors for the
received leg
Array of (N+1) cells x 2 cells (dates, rates) where N is the number of
swap point periods
The first line (row or column depending on the array orientation
specified with the LAY keyword) contains the spot date and the
spot rate for the cross-currency
The other lines contain swap point period end dates and
corresponding swap point values for the cross-currency
Present value of the currency swap or one of its legs in the discount
currency
Extended argument defining the currency swap structure (see
CsStructure on page 280)
Extended argument customizing the return value (see SwMode on
page 386)
4 August 2003
SwSwpExtend
Purpose
Syntax
Arguments
Calculates the swap point at maturity date equivalent to a spread/fixed rate and to a predefined net
present value.
=SwSwpExtend(CalcDate, StartDate, Maturity, PaidRate, CurPaidRate, ReceivedRate,
CurReceivedRate, ZcPaidArray, ZcReceivedArray, FxArray, NetPresentValue,
CsStructure, SwMode)
CalcDate
StartDate
Maturity
PaidRate
CurPaidRate
ReceivedRate
CurReceivedRate
ZcPaidArray
ZcReceivedArray
FxArray
NetPresentValue
CsStructure
Calculation date
Start date of the currency swap (effective date)
Maturity date of the currency swap (expressed as a date or a code
such as "1Y")
Fixed rate if the paid leg is fixed, floating rate spread as a percentage
if the paid leg is floating
Floating rate of the paid leg for the current calculation period if
applicable
Fixed rate if the received leg is fixed, floating rate spread as a
percentage if the received leg is floating
Floating rate of the received leg for the current calculation period if
applicable
Array of zero-coupon dates and rates or discount factors for the paid
leg
Array of zero-coupon dates and rates or discount factors for the
received leg
Array of (N+1) cells x 2 cells (dates, rates) where N is the number of
swap point periods
The first line (row or column depending on the array orientation
specified with the LAY keyword) contains the spot date and the
spot rate for the cross-currency
The other lines contain swap point period end dates and
corresponding swap point values for the cross-currency
Present value of the currency swap or one of its legs in the discount
currency
Extended argument defining the currency swap structure (see
CsStructure on page 280)
4 August 2003
189
SwSwpExtend
SwMode
190
4 August 2003
PART IX:
REUTERS ADFIN
TERM STRUCTURE
192
4 August 2003
Contents
AdRate
AdRateConv
4 August 2003
193
AdRate
AdRate
Purpose
Calculates the discount factors for an array of dates, using one of the following term structure
models:
Syntax
Arguments
Vasicek-Fong model
standard bootstrapping model
basis-spline models
Black, Derman, and Toy model
Hull and White model
yield-to-maturity model
=AdRate(CalcDate, DateArray, RateArray, RateStructure, AdMode)
CalcDate
DateArray
RateArray
RateStructure
AdMode
AdRateConv
Purpose
Syntax
Arguments
StartDate
EndDate
RateMode
194
4 August 2003
Rate
Rate to be converted
4 August 2003
195
AdRateConv
196
4 August 2003
C H A P T E R 3 2 TE R M S T R U C T U R E F U N C T I O N S
Contents
AdCalibrate
AdFutCodes
AdFutDates
AdTermStructure
4 August 2003
197
AdCalibrate
AdCalibrate
Purpose
Syntax
Arguments
Calculates the model parameters (dates, rates and volatility curve or dates, rates, volatility plus
mean-reversion curve) from an array of instruments.
=AdCalibrate(InputArray, ZCArray, StartOutputArray, RateArray, CalcStructure,
AdMode)
InputArray
ZCArray
StartOutputArray
RateStructure
CalcStructure
AdMode
AdFutCodes
Purpose
Syntax
Arguments
CalcDate
StirFutStructure
YcMode
Calculation date
Extended argument defining the STIR futures contract
Extended argument customizing the return value (see YcMode on
page 389)
AdFutDates
Purpose
198
Calculates the start date and the end date of a STIR futures contract hedging period.
4 August 2003
Syntax
Arguments
StirFutStructure
MaturityCode
YcMode
AdTermStructure
Purpose
Depending on the model specified by the RM keyword, the function calculates a zero-coupon yield
curve from an array of instruments, using the:
Syntax
Arguments
Vasicek-Fong model
standard bootstrapping model
regression or smoothing basis-spline models
=AdTermStructure(InstrumentArray, RateStructure, AdMode)
InstrumentArray
RateStructure
AdMode
Array of instruments
Extended argument defining the structure of the interest rate structure (see
RateStructure on page 365)
Extended argument customizing the return value (see AdMode on page
237)
4 August 2003
199
AdTermStructure
200
4 August 2003
PART X:
REUTERS ADFIN
COMMON
202
4 August 2003
Contents
AdInterp
4 August 2003
203
AdInterp
AdInterp
Purpose
Syntax
204
4 August 2003
Contents
AdFormat
AdParse
AdRound
DfFormatDate
DfIDNDate
4 August 2003
205
AdFormat
AdFormat
Purpose
Syntax
Arguments
Converts a decimal number to a fraction or displays a bid/ask array as a string using the bid/ask
format.
=AdFormat(Data, BidDecimals, AskDigits, FormatMode)
Data
BidDecimals
AskDigits
FormatMode
AdParse
Purpose
Syntax
Arguments
=AdParse(DataString, ParseMode)
DataString
ParseMode
Data string
Extended argument defining the parsing mode (see ParseMode on
page 358)
AdRound
Purpose
Syntax
Arguments
206
Value
Number to be rounded
4 August 2003
Tick
RoundMode:
Rounding tick
Extended argument defining the type of the rounding (see
RoundMode on page 374)
DfFormatDate
Purpose
Syntax
Arguments
CalcDate
Calculation date
DfIDNDate
Purpose
Syntax
Arguments
Converts a date specified in the string format "DD MMM YY" or "DD MMM YYYY" to a serial number,
whatever the date settings of both the operating system and the spreadsheet application are.
=DfIDNDate(DateStr)
DateStr
4 August 2003
207
DfIDNDate
208
4 August 2003
Contents
AdDefAttribute
AdDefSet
AdDefStructure
AdReadParam
AdWriteParam
4 August 2003
209
AdDefAttribute
AdDefAttribute
Purpose
Syntax
Arguments
=AdDefAttribute(DefCategory, DefAttribute)
DefCategory
DefAttribute
AdDefSet
Purpose
Sets one or several default settings belonging to a same default settings category.
The default settings category or nature is defined in the argument DefCategory. Hence, all settings
grouped together in the DefStructure argument must belong to the same category.
Syntax
Arguments
=AdDefSet(DefCategory, DefStructure)
DefCategory
DefStructure
AdDefStructure
Purpose
Syntax
Arguments
210
DefCategory
4 August 2003
AdReadParam
Purpose
Syntax
Arguments
Section
Entry
Section name
Entry name
AdWriteParam
Purpose
Syntax
Arguments
Section
Entry
Value
Section name
Entry name
Value of entry as a string
4 August 2003
211
AdWriteParam
212
4 August 2003
Contents
AdHistoryUpdate
AdHistoryValue
AdStyleAttribute
AdStyleDelete
AdStyleName
AdStyleSet
AdStyleStructure
4 August 2003
213
AdHistoryUpdate
AdHistoryUpdate
Purpose
Syntax
Arguments
IndexName
DateArray
ValueArray
AdHistoryValue
Purpose
Syntax
Arguments
Retrieves the latest historical value available in the database for an index history style.
=AdHistoryValue(IndexName, StyleMode)
IndexName
StyleMode
AdStyleAttribute
Purpose
Syntax
Arguments
StyleTable
StyleCode
StyleAttribute
214
4 August 2003
AdStyleDelete
Purpose
Syntax
Arguments
StyleTable
StyleCode
AdStyleName
Purpose
Syntax
Arguments
StyleTable
StyleCode
AdStyleSet
Purpose
Syntax
Arguments
StyleTable
StyleCode
StyleName
StyleStructure
StyleMode
4 August 2003
215
AdStyleStructure
AdStyleStructure
Purpose
Syntax
Arguments
StyleTable
StyleCode
216
4 August 2003
Contents
DfAddMonths
DfAddPeriod
DfAddWD
DfAddYears
DfCountDays
DfCountNonWD
DfCountWD
DfCountYears
DfAdjustToWD
DfFindDateD
DfFindDateM
DfIsWD
DfLastWD
DfListHolidays
4 August 2003
217
DfAddMonths
DfAddMonths
Purpose
Syntax
Arguments
Calendars
CalcDate
NbMonths
DfMode
DfAddPeriod
Purpose
Syntax
Arguments
Adds a period (number of calendar days, working days, weeks, months or years) to a date.
=DfAddPeriod(Calendars, CalcDate, Period, DfMode)
Calendars
CalcDate
Period
DfMode
DfAddWD
Purpose
218
4 August 2003
Syntax
Arguments
Calendars
CalcDate
NbDays
DfMode
DfAddYears
Purpose
Syntax
Arguments
Calendars
CalcDate
NbYears
DfMode
DfCountDays
Purpose
Syntax
Arguments
Calculates the number of days between two dates according to the day count basis specified in
DfMode with the keyword DCB.
=DfCountDays(StartDate, EndDate, DfMode)
StartDate
EndDate
DfMode
4 August 2003
219
DfCountNonWD
DfCountNonWD
Purpose
Syntax
Arguments
Calendars
StartDate
EndDate
DfMode
DfCountWD
Purpose
Syntax
Arguments
Calendars
StartDate
EndDate
DfMode
DfCountYears
Purpose
Syntax
Arguments
Calculates the number of years between two dates according to the day count basis specified in
DfMode with the keyword DCB.
=DfCountYears(StartDate, EndDate, DfMode)
StartDate
EndDate
220
4 August 2003
DfMode
DfAdjustToWD
Purpose
Syntax
Arguments
Calendars
CalcDate
AdjMode
DfMode
DfFindDateD
Purpose
Syntax
Arguments
Number
Day
Direction
RefDate
4 August 2003
221
DfFindDateM
DfFindDateM
Purpose
Syntax
Arguments
Number
Day
Direction
RefMonth
Year
DfIsWD
Purpose
Syntax
Arguments
Calendars
CalcDate
DfMode
DfLastWD
Purpose
Syntax
Arguments
222
Calendars
4 August 2003
CalcDate
DfMode
Calculation date
# not currently used - leave blank # (see DfMode on page 308)
DfListHolidays
Purpose
Syntax
Arguments
Calendars:
StartDate
EndDate
DfMode
4 August 2003
223
DfListHolidays
224
4 August 2003
PART XI:
REUTERS 3000
DATA ENGINE
226
4 August 2003
C H A P T E R 3 8 D A TA E N G I N E F U N C T I O N S
Contents
DeHistory
DeList
DeLookup
DeQuery
DeUpdate
4 August 2003
227
DeHistory
DeHistory
Purpose
Syntax
one single instrument, from a specified table in Securities 3000 and Treasury 3000 databases
several instruments, from the DBU server
=DeHistory(Code, TableName, FieldList, DestinationCell, MacroName, Conditions,
DeMode)
Important! You must specify the data source, using the SOURCE keyword in the DeMode argument.
Arguments
Code
TableName
FieldList
DestinationCell
MacroName
Conditions
DeMode
DeList
Purpose
Note
Syntax
228
Retrieves a list of instrument constituents. The constituents can be from an index or from the
Reuters Securities 3000 database. The index is specified in the parameters.
This function can also retrieve lists of RICs, clearing codes, rating sources, and price sources for a
bond, from the Reuters Treasury 3000 database.
=DeList(Code, TableName, FieldList, DestinationCell, MacroName, Conditions,
DeMode)
4 August 2003
Arguments
Code
TableName
FieldList
DestinationCell
MacroName
Conditions
DeMode
DeLookup
Purpose
Syntax
Arguments
Retrieves issues and quotations associated with an organization name from the Securities 3000
database.
=DeLookup(LookupString, DestinationCell, MacroName, DeMode)
String containing the name or beginning of the name for the organization for
which to retrieve data.
DestinationCell Cell reference specifying the top-left corner of the destination cell.
MacroName
Identifies the Excel macro that is called when the result table is updated.
DeMode
Indicates the Data Engine source to consult in the request (the SOURCE
keyword), defines data retrieval parameters (update frequency, whether to
refresh), data filters/extrapolators (for historic data), the format of the results,
and specifies whether results are refreshed automatically. It has the form of a
structure string. Please refer to the following table to see the dependency of
DeMode keywords according to the function used.
LookupString
4 August 2003
229
DeQuery
DeQuery
Purpose
Syntax
Arguments
DeUpdate
Purpose
230
Retrieves a table of values from a named data source specified by the keyword SOURCE in the
DeMode argument. You can choose the default data source by selecting the Set as default source
check box in the Reference Data Engine Settings dialog. Changes to the default value are
taken into account at the next Data Engine session.
4 August 2003
The list of fields available for a given security is available in the Reuters Data Encyclopedia, at the
following URL: http://rde.session.rservices.com/3000xtra. To assist you in building your DeUpdate
request, you can also use the Treasury and Security assistants..
Syntax
Arguments
CodeList
FieldList
DestinationCell
MacroName
Conditions
DeMode
4 August 2003
231
DeUpdate
232
4 August 2003
PART XII:
REUTERS ADFIN
EXTENDED
ARGUMENTS
234
4 August 2003
E X T E N D E D A R G U M E N TS
APPENDIX A
Contents
Adfin Structures
AdMode
BdMode
BondFutStructure
BondStructure
CalcMethod
CalcStructure
CapFloorStructure
CdsStructure
ConvMode
ConvStructure
CreditStructure
CrossStructure
CsStructure
CurStructure
DefStructure
DfMode
ExoticStructure
FormatMode
FrnMode
FrnStructure
FxMode
HistoryMode
HistoryStructure
IlbMode
IlbStructure
IndexHistoryStructure
4 August 2003
235
236
InterpMode
IrsStructure
OpMode
OptionStructure
ParseMode
RateMode
RateStructure
RepoMode
RoundMode
RtMode
StirFutStructure
StyleMode
SwapStructure
SwMode
YcMode
4 August 2003
Adfin Structures
Use of Structure
Arguments with
Adfin Analytics
Most of the calculations in Reuters PowerPlus Pro rely on the definition of the instrument in terms of
a Structure or a Style.
A Structure, such as a BondStructure, is an extended argument, consisting of several keywords to
define attributes such as accrued interest calculation method, etc. A Style is a name given to a
particular instance of a Structure (in the case of instruments). Thus the BondStructure for a UK
Gilt-edged security should be ACC:AA CM:AA FRQ:2 XD:7WD EY:2 SETTLE:1WD CLDR:UKG_FI
RND:6. This may be used in bond calculations. This structure is also defined in the Style Database;
its Style Name is Gilt. It is interchangeable with the above Structure, and will produce identical
results in calculations.
The following table indicates how instruments and related data, such as calendars, index histories,
etc, may be defined using Structures and Styles. If an entity may be defined using a Structure, the
entry in the Structure column will be Yes, followed by the Structure Arguments to be used. If Styles
exist in the Style Database for the entity, its entry in the Style column will be Yes. Styles may be
viewed via the Style Management function: click Reuters Settings Style Management.
Extended
Arguments
Adfin arguments in Reuters PowerPlus Pro combine several attributes in a single parameter. As
many attributes as needed may be combined within the extended argument and in a random order.
Each attribute is referred to in the extended argument by a keyword.
An extended argument is a string made up of a series of parameters in a function, each one
consisting of a keyword followed by a colon (:) and the value of the parameter. The separator
between the parameters in the string should be a blank space ( ) as shown in the example below.
Keyword1:Value1 Keyword2:Value2 Keyword3:Value3
Reuters PowerPlus Pro provides two types of Extended arguments:
Structure arguments
Mode arguments
AdMode
AdMode is used as argument in Adfin Analytics functions to customize returned values.
AdMode is a string consisting of a series of parameters. Each of set parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
4 August 2003
237
AdMode
Structure
The following keywords used in AdMode are common to Adfin Analytics functions:
Keyword Explanation
238
LAY
RET
Return value parameter to shorten or lengthen the array of data returned by array
functions {Ai, Bi, or i (where i is integer)} (see the Notes section below)
RET:Ai with i from 1 to ArraySize to get the i first rows of the default array (only
values)
RET:Bi with i from 1 to ArraySize to get the i first rows of the default arrays (names
and their values)
RET:i with i from 1 to ArraySize to get the value of the ith row of a one dimension
array
Default value: RET:A
4 August 2003
4 August 2003
239
AdMode
Keyword Explanation
RES
RES:D or RES:DELTA to calculate the delta ratio (sensitivity of the premium to the change
240
4 August 2003
Keyword
Explanation
RES
Expected result {BPV, CONVEXITY, D, DELTA, FDELTA, FRHO, FTHETA, FVEGA, G, GAMMA, R,
RHO, T, THETA, V, VEGA}
RES:BPV to calculate the basis point value of caps and floors
RES:CONVEXITY to calculate the convexity of caps and floors (see the Notes section
below)
RES:D or RES:DELTA to calculate the delta ratio(sensitivity of the premium to the
change of the underlying price)
RES:G or RES:GAMMA to calculate the gamma ratio(sensitivity of the delta ratio to the
change of the underlying price)
RES:R or RES:RHO to calculate the rho ratio(sensitivity of the premium to the market
interest rates)
RES:T or RES:THETA to calculate the theta ratio(sensitivity of the premium to the
reduction of the option remaining life)
RES:V or RES:VEGA to calculate the vega ratio(sensitivity of the premium to the
underlying volatility)
RES:FDELTA to calculate the delta ratio in the foreign currency (for currency options)
RES:FRHO to calculate the rho ratio in the foreign currency (for currency options)
RES:FTHETA to calculate the theta ratio in the foreign currency (for currency options)
RES:FVEGA to calculate the vega ratio in the foreign currency (for currency options)
Default value: No expected result is defined
4 August 2003
241
AdMode
Example
242
Keyword
Explanation
RES
Expected result {DELTA, DELTA:i, D1, D2, GAMMA, GAMMA:i, GAMMA:i:j, G1, G2, RHO, R1,
R2, T, THETA, VEGA:i, V1, V2}
RES:DELTA to calculate the deltaof the option, except for Rainbow and exotic currency
options
RES:DELTA:i to calculate the delta of the i-th asset for multi asset options
RES:GAMMA to calculate the gamma of the option, except for Rainbow and exotic
currency options
RES:GAMMA:i to calculate the gamma of the i-th asset for multi asset options
RES:GAMMA:i:j to calculate the crossgamma of the i-th and j-th asset for basket
options
RES:RHO to calculate the rhoof the option
RES:THETA to calculate the thetaratio in domestic currency
RES:VEGA to calculate the vegaof the option, except for Rainbow options
RES:VEGA:i to calculate the vega of the i-th asset for multi asset options
RES:D1 or RES:DELTA:1 to calculate the delta ratio in domestic currency for exotic
currency options
RES:D2 or RES:DELTA:2 to calculate the delta ratio in foreign currency for exotic
currency options
RES:G1 or RES:GAMMA:1 to calculate the gamma ratio in domestic currency for exotic
currency options
RES:G2 or RES:GAMMA:2 to calculate the gamma ratio in foreign currency for exotic
currency options
RES:V1 or RES:VEGA:1 to calculate the vega ratio in domestic currency for exotic
currency options
RES:V2 or RES:VEGA:2 to calculate the vega ratio in foreign currency for exotic
currency options
RES:R1 to calculate the rho ratio in domestic currency for exotic currency options
RES:R2 to calculate the rho ratio in foreign currency for exotic currency options
Default value: No expected result is defined
LAY:H RET:B1 displays the name of the first parameter returned and the corresponding value below.
4 August 2003
BdMode
BdMode is used as argument in functions of the Adfin Bonds module to customize returned values.
Structure
Keyword
Explanation
IAC
Cash flows calculation split up into interest and principal {no value}
IAC to display interest cash flows and principal cash flows
Default value: Interest and principal added in cash flows calculation
LAY
RET
Return value parameter to shorten or lengthen the array of data returned by array
functions {Ai, Bi, i with i as integer}
RET:Ai with i from 1 to ArraySize to get the array of the i first elements (values only)
RET:Bi with i from 1 to ArraySize to get the array of the i first elements along with
their names (header and values)
RET:i with i from 1 to ArraySize to get the i-th element only
Default value: RET:A
BondFutStructure
BondFutStructure is used as argument in functions of the Adfin Bonds module to define the
structure of a bond futures contract.
BondFutStructure is a string consisting of a series of parameters. Each set of parameters consists
of a keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
4 August 2003
243
BondFutStructure
Structure
244
Keyword Explanation
AFTER
BEFORE
BOND
CDADJ
Conversion factor date adjustment {C{:M, Q}, F{:M, Q}, N, P{:M, Q}}
CDADJ:C:M to adjust to the closest month
CDADJ:C:Q to adjust to the closest quarter
CDADJ:F:M to adjust to the following month
CDADJ:F:Q to adjust to the following quarter
CDADJ:N for None
CDADJ:P:M to adjust to the preceding month
CDADJ:P:Q to adjust to the preceding quarter
Default value: CDADJ:N
CFD
CLDR
4 August 2003
Keyword Explanation
CRD
Contract reference date calculation method {1C, 10C, 15C, 20C, 2NDFRI, 3RDWED, NBB}
CRD:1C to set the date to the first calendar day of the delivery month
CRD:10C to set the date to the 10th calendar day of the delivery month
CRD:15C to set the first calendar day of the delivery month
CRD:20C to set the date to the 20th calendar day of the delivery month
CRD:2NDFRI to set the second Friday of the delivery month
CRD:3RDWED to set the date to the third Wednesday day of the delivery month
CRD:NZL to set the date to the third Wednesday after the ninth day of the contact month
(specific to the NZ Bank Bill Future Contracts)
Default value: No contract reference date calculation method is defined
CUR
DEC
Decimal precision for conversion factor {NO, RND:i, TRUNC:i with i as integer}
DEC:NO to use the calculated value without rounding or truncating
DEC:RND:i to round the calculated value to i decimals
DEC:TRUNC:i to trunc the calculated value to i decimals
Default value: DEC:NO
EDD
Delivery period end date calculation method {LAST, iWD with i as integer}
EDD:LAST to set the date to the last working day of the delivery month
EDD:iWD for i working days from the reference date
Default value: EDD:0WD
MDADJ
QM
4 August 2003
245
BondFutStructure
Keyword Explanation
RATE
RRTYPE
Repo rate type {00, A0, A0D, A25D, A5, A5D, AA, BFM, DISCA0, DISCA5, E0,
JAP, MMBA0, MMBA5, MMDA0, MMDA5, MMMA0, MMMA5, MMPA0, MMPA5, MOOS, TRE}
RRTYPE:00 for 30/360
RRTYPE:A0 for Actual/360
RRTYPE:A0D for Actual/360 (day-based)
RRTYPE:A25D for Actual/365.25 (day-based)
RRTYPE:A5 for Actual/365
RRTYPE:A5D for Actual/365 (day-based)
RRTYPE:AA for Actual/Actual
RRTYPE:BFM for Braess/Fangmeyer
RRTYPE:DISCA0 for discount Actual/360
RRTYPE:DISCA5 for discount Actual/365
RRTYPE:E0 for 30E/360 ISMA
RRTYPE:JAP for Japanese
RRTYPE:MMBA0 for money market bullet Actual/360
RRTYPE:MMBA5 for money market bullet Actual/365
RRTYPE:MMDA0 for money market direct discounting Actual/360
RRTYPE:MMDA5 for money market direct discounting Actual/365
RRTYPE:MMMA0 for money market medium term CD Actual/360
RRTYPE:MMMA5 for money market medium term CD Actual/365
RRTYPE:MMPA0 for money market proceeds Actual/360
RRTYPE:MMPA5 for money market proceeds Actual/365
RRTYPE:MOOS for Moosmller
RRTYPE:TRE for Treasuries
Default value: No rate type is defined
SDD
246
Delivery period start date calculation method {FIRST, iWD with i as integer}
SDD:FIRST to set the date to the first working day of the delivery month
SDD:iWD for i working days from the reference date
Default value: SDD:0WD
4 August 2003
Keyword Explanation
SIZE
BondStructure
BondStructure is used as argument in functions of the Adfin Bonds module to define the structure
of the bond.
BondStructure is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
4 August 2003
247
BondStructure
Structure
248
Keyword Explanation
ACC
Accrued interest calculation method {{00, A0, A5, AA, BB00, BBA5, BBW252, E0, IT, IT2,
JAP, MMA0, MMA5, MMNL5, NL0, NL5, W252} with {:SSD} optional for each value}
ACC:00 for 30/360
ACC:A0 for Actual/360
ACC:A5 for Actual/365
ACC:AA for Actual/Actual
ACC:BB00 for Brazilian bonds with 30/360
ACC:BBA5 for Brazilian bonds with Actual/365
ACC:BBW252 for Brazilian bonds with Actual Working days/252
ACC:IT for Italian (from last coupon date to settlement date in E0 + 1 day)
ACC:IT2 for Italian modified (from last coupon date to settlement date + 1 day in E0)
ACC:JAP for Japanese (A5 or A5 + 1 day for first coupon)
ACC:MMA0 for money market Actual/360
ACC:MMA5 for money market Actual/365
ACC:MMNL5 for money market Actual No Leap/365
ACC:NL0 for Actual No Leap/360
ACC:NL5 for Actual No Leap/365
ACC:W252 for Actual Working days/252
ACC:i:SSD for German Schuldscheindarlehen bonds where i is {00, A0, A5, AA, BB00,
BBA5, BBW252, E0, IT, IT2, JAP, MMA0, MMA5, MMNL5, NL0, NL5, W252}
Default value: ACC:AA
ALIMIT
Accrued interest adjustment method for Actual/360 and Actual/365 {CPN, NEXT, NO}
ALIMIT:CPN to limit the accrued interest to the regular coupon value
ALIMIT:NEXT to adjust the coupon subtracting the exceeding number of days
ALIMIT:NO to allow the accrued interest to exceed the regular coupon value
Default value: ALIMIT:NEXT
AMORT
4 August 2003
Keyword Explanation
ARND
Rounding mode of the accrued interest {NO} or {i (where i is numeric) : {UP, DOWN,
NEAR}}
ARND:NO if no rounding is requested
ARND:i:{UP, DOWN, NEAR} for rounding to the precision defined by i
Default value: ARND:NO if no rounding is requested
ARND:i:NEAR if i is specified
CALL
4 August 2003
249
BondStructure
Keyword Explanation
250
CCM
Coupon calculation method {BB00, BBA0, BBA5, BBAA, BBE0, MM00, MMA0, MMA5, MMAA,
MME0, MMNL0, MMNL5, 00D, A0D, A5D, E0D, 00, A0, A5, AA, E0} (see the Notes section
below)
CCM:BB00 for bond 30/360
CCM:BBA0 for bond Actual/360
CCM:BBA5 for bond Actual/365
CCM:BBAA for bond Actual/Actual
CCM:BBE0 for bond 30E/360 ISMA
CCM:MM00 for money market 00/360
CCM:MMA5 for money market Actual/365
CCM:MMA0 for money market Actual/360
CCM:MMAA for money market Actual/Actual
CCM:MME0 for money market 30E/360
CCM:MMNL0 for money market Actual No Leap/360
CCM:MMNL5 for money market Actual No Leap/365
CCM:00D for effective 30/360 (day-based)
CCM:A0D for effective Actual/360 (day-based)
CCM:A5D for effective Actual/365 (day-based)
CCM:E0D for effective 30E/360 (day-based)
CCM:00 for effective 30/360 (period-based)
CCM:A0 for effective Actual/360 (period-based)
CCM:A5 for effective Actual/365 (period-based)
CCM:AA for effective Actual/Actual (period-based)
CCM:E0 for effective 30E/360 (period-based)
Default value: CCM:BBAA
CFADJ
CLDR
4 August 2003
Keyword Explanation
CRND
DATED
DMC
Date moving convention used when an expiry date or a dividend date falls on a non
working day {F, FOL, M, MOD, N, NONE, P, PRE}
DMC:F or DMC:FOL for moving the date to the following working day
DMC:M or DMC:MOD for moving the date to the following working day unless it causes the
date to be pushed into the next month (in this latter case, the last working day of the
month is used)
DMC:N or DMC:NONE for no moving
DMC:P or DMC:PRE for moving the date to the preceding working day
Default value: The value of the DMC keyword of the "BOND" category
EMC
End-of-month convention used when the maturity date falls on the last day of a month
{D, DEF, L, LAST, S, SAME, L28}
EMC:D or EMC:DEF for the value in Default Settings
EMC:L or EMC:LAST for Last
EMC:S or EMC:SAME for Same
EMC:L28 to match Hong Kong bond requirements: They ignore the 29th of February for
cash flow payment. This particularity affects semi-annual bonds maturing on the 31st of
August. Coupons are paid every 31st of August and every 28th of February. In case of a
leap year the cash flow is still paid the 28th and not the 29th
Default value: EMC:LAST
FAD
FCV
4 August 2003
251
BondStructure
Keyword Explanation
FRCD
FRQ
Frequency of the coupon payments {i {28D, 91D, 182D, 364D, 1, 2, 4, 12}} (see the Notes
section below)
FRQ:28D to define a coupon payment every 28 days from the maturity date
FRQ:91D to define a coupon payment every 91 days from the maturity date
FRQ:182D to define a coupon payment every 182 days from the maturity date
FRQ:364D to define a coupon payment every 364 days from the maturity date
FRQ:1 to define an annual coupon payment from the maturity date
FRQ:2 to define a semi-annual coupon payment from the maturity date
FRQ:4 to define a quarterly coupon payment from the maturity date
FRQ:12 to define a monthly coupon payment from the maturity date
FRQ:DDMMMYY:i to define a frequency of i from date DDMMMYY
IC
252
4 August 2003
Keyword Explanation
IC
IC:L1 for long first coupon (first coupon date equal to second anniversary date)
IC:L1R for long first coupon with regular nominal value and starting accrued date equal
INTCAP
ISSUE
LOCK
Lockout period in settlement date calculations {iWD with i>0} (see the Notes section
below)
LOCK:iWD for i working days
LRCD
Last regular coupon date for odd last coupon {DDMMMYY, JGB}
LRCD:DDMMMYY where DDMMMYY is the last regular coupon date
LRCD:JGB to handle automatically odd last coupons for JGBs
MDADJ
NC
4 August 2003
253
BondStructure
Keyword Explanation
NOTIONAL Face value of the bond {i, expressed in the bond currency}
NOTIONAL:i indicates that the face value of the bond is equal to i
254
PPMT
PUT
PX
PXRND
Rounding mode of the output price {NO} or {i (where i is numeric): {UP, DOWN, NEAR}}
PXRND:NO if no rounding is requested.
PXRND:i:{UP, DOWN, NEAR} for rounding to the precision defined by i
Default value: PXRND:NO if no rounding is requested
PXRND:i:NEAR if i is specified
REFDATE
RP
4 August 2003
Keyword Explanation
RT
Reimbursement type {B, C{:i}, Sj{:i} where i is numeric (1=100%) and j from 1 to 8,
P}
RT:B for bullet or in fine
RT:C for constant payments
RT:C:i for constant payments equal to i except for the last cash flow which is adjusted
RT:Sj for j series
RT:Sj:i for j series and constant payments equal to i except for the last cash flow
which is adjusted
RT:P for perpetual bonds
SETTLE
Settlement date calculation rule {AUT, INTL, JAP, RSA, iD, iDF, iDM, iDN, iDP, iWD with i
from 1 to 9}
SETTLE:AUT for the Austrian settlement rule
SETTLE:INTL for the International settlement
SETTLE:JAP for the Japanese settlement rule
SETTLE:RSA for the South-African settlement
SETTLE:iD for i calendar days and the default date moving convention
SETTLE:iDF for i calendar days and the following date moving convention
SETTLE:iDM for i calendar days and the modified following date moving convention
SETTLE:iDN for i calendar days and no date moving convention
SETTLE:iDP for i calendar days and the preceding date moving convention
SETTLE:iWD for i working days
(the calendar used must also be specified using CLDR)
STEP
Coupon rate pattern for stepped coupon bonds {DDMMMYY:i (where i is numeric)}
STEP:DDMMMYY:i where i is the nominal coupon rate starting from the date DDMMMYY
TAX
Taxation for yield/price calculation {i:j where i and j are numeric (1=100%)}
TAX:i:j to specify a taxation of i on the coupons and j on the capital
TC
Tax credit when the redemption price is less than the taxed price {NO, YES}
(the taxation rate must also be specified using TAX)
TC:NO to ignore the tax credit
TC:YES to adjust the redemption price with the tax credit
4 August 2003
255
BondStructure
Keyword Explanation
Examples
TP
Price used for capital gain taxation when different from the actual bond price {i (where
i is numeric) (1=100%)}
(the taxation rate must also be specified using TAX)
TP:i for a price equal to i
XD
Ex-dividend calculation {no value, NO, YES, iD, iWD, AUT, DEN}
XD or XD:YES to force ex-dividend calculations (exclude the right to the next coupon)
XD:NO to force cum-dividend calculations (grant the right to the next coupon)
XD:iD for an ex-dividend period of i calendar days
XD:iWD for an ex-dividend period of i working days
XD:AUT for the Austrian ex-dividend period
XD:DEN for the Dane ex-dividend period
YLDRND
Rounding mode of the output yield {NO} i (where i is numeric) : {UP, DOWN, NEAR}}
YLDRND:NO if no rounding is requested.
YLDRND:i:{UP, DOWN, NEAR} for rounding to the precision defined by i
YM
ACC:A5 FRQ:2 XD:7WD CLDR:UKG SETTLE:1D is the structure stored for UK gilts in the bond
database.
ACC:AA RND:3 CLDR:FRA SETTLE:3WD is the structure stored for French OATs in the bond
database.
CALL:01Jan00:01Jan01:1.2 describes an American call option between 01-Jan-2000 and
256
4 August 2003
Reuters
PowerPlus Pro
4.0
To match results in PowerPlus Pro 4.0, you must use the following default configurations. All other
configurations are impossible.
Is NOTIONAL used?
YES
NO
NO
YES
NO
NO
YES
NO
NO
or S
YES
CalcMethod
CalcMethod is used as argument in functions of the Adfin Bonds module to define the calculation
method.
CalcMethod is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
4 August 2003
257
CalcMethod
Structure
Keyword Explanation
CF
258
Cash flow mode to choose between analytic pricing and cash flow {CLDR, NO, NULL, WE,
YES}
CF:CLDR for cash flow pricing using the calendar defined by the keyword CLDR (if no
calendar is defined, CLDR:WEEKEND is used)
CF:NO for analytic pricing (for example from the bond structure)
CF:NULL for cash flow pricing using the calendar NULL
CF:WE for cash flow pricing using the calendar WEEKEND
CF:YES for cash flow pricing using the calendar defined in Default Settings
Default value: Calculation with cash flows
4 August 2003
Keyword Explanation
CM
Yield calculation method {00, A0, A0D, A25D, A5, A5D, AA, BFM, DISCA0, DISCA5, E0, JAP,
MMBA0, MMBA5, MMDA0, MMDA5, MMMA0, MMMA5, MMPA0, MMPA5, MOOS, TRE, UDI, W252}
CM:00 for 30/360
CM:A0 for Actual/360
CM:A0D for Actual/360 (day-based)
CM:A25D for Actual/365.25 (day-based)
CM:A5 for Actual/365
CM:A5D for Actual/365 (day-based)
CM:AA for Actual/Actual
CM:BFM for Braess/Fangmeyer
CM:DISCA0 for discount Actual/360
CM:DISCA5 for discount Actual/365
CM:E0 for 30E/360 ISMA
CM:JAP for Japanese
CM:MMBA0 for money market bullet Actual/360 (formerly CM:MMA0)
CM:MMBA5 for money market bullet Actual/365 (formerly CM:MMA5)
CM:MMDA0 for money market direct discounting Actual/360
CM:MMDA5 for money market direct discounting Actual/365
CM:MMMA0 for money market medium term CD Actual/360
CM:MMMA5 for money market medium term CD Actual/365
CM:MMPA0 for money market proceeds Actual/360
CM:MMPA5 for money market proceeds Actual/365
CM:MOOS for Moosmller
CM:TRE for Treasuries
CM:UDI for Udibonos
CM:W252 for Actual Working days/252
Default value: No default value is defined
CMP
4 August 2003
259
CalcMethod
Keyword Explanation
260
DCB
Day count basis {00, A0, A0D, A25D, A5, A5D, AA, E0, W252}
DCB:00 for 30/360 (period-based calculation)
DCB:A0 for Actual/360 (period-based calculation)
DCB:A0D for Actual/360 (day-based calculation)
DCB:A25D for Actual/365.25 (day-based calculation)
DCB:A5 for Actual/365 (period-based calculation)
DCB:A5D for Actual/365 (day-based calculation)
DCB:AA for Actual/Actual (period-based calculation)
DCB:E0 for 30E/360 ISMA (period-based calculation)
DCB:W252 for Actual Working days/252
Default value: The value of the DCB keyword of the "RATEMODEL" category
EY
IM
4 August 2003
Keyword Explanation
LAY
LLP
Linear last period parameter {00{:i}, A0{:i}, A5{:i}, AA{:i}, E0{:i}, NO with i as
integer}
LLP:00 for 30/360 for the last period only
LLP:00:i for 30/360 for the i last periods
LLP:A0 for Actual/360 for the last period only
LLP:A0:i for Actual/360 for the i last periods
LLP:A5 for Actual/365 for the last period only
LLP:A5:i for Actual/365 for the i last periods
LLP:AA for Actual/Actual for the last period only
LLP:AA:i for Actual/Actual for the i last periods
LLP:E0 for 30E/360 for the last period only
LLP:E0:i for 30E/360 for the i last periods
LLP:NO for defining no special processing of the last period(s)
Default value: LLP:NO
ND
OBC
PX
4 August 2003
261
CalcStructure
Keyword Explanation
SHIFT
SPREAD
XD
Ex-dividend calculation {no value, NO, YES, iD, iWD, AUT, DEN}
XD or XD:YES to force ex-dividend calculations (exclude the right to the next coupon)
XD:NO to force cum-dividend calculations (grant the right to the next coupon)
XD:iD for an ex-dividend period of i calendar days
XD:iWD for an ex-dividend period of i working days
XD:AUT for the Austrian ex-dividend period
XD:DEN for the Dane ex-dividend period
Default value: Calculation on an ex-dividend basis for ex-dividend periods
YTM
ZCTYPE
CalcStructure
CalcStructure is used as argument in Adfin Analytics functions to define the calculation methods
262
4 August 2003
Structure
Keyword Explanation
ANP
CMT
CONV
COR
Correlation coefficient between the instantaneous stock rate and the absolute changes
of the interest rate {i, where i is numeric}
COR:i where i is the correlation coefficient
Default value: COR:0
DCP
DUR
FT
4 August 2003
263
CapFloorStructure
Keyword Explanation
NBBRANCH
NBFACTOR
Number of factors for the calculation method, if CMT:TREE or CMT:FD is used {1, 2}
NBFACTOR:1 if CMT:TREE or CMT:FD for one factor
NBFACTOR:2 if CMT:TREE for two factors
Default value: 1
PVBP
SOLVER
TITER
Number of discrete time steps {i, where i is numeric} (see the Notes section below)
TITER:i where i is the number of steps
Default value: 30 for one factor trees (NBFACTOR:1) and for finite differences method.
15 for two factors trees (NBFACTOR:2)
VOL
VOLAT
Starting volatility value for implied volatility calculations {i, where i is numeric}
VOLAT:i where i is the starting value
Default value: VOLAT:0.1
CapFloorStructure
CapFloorStructure is used as argument in functions of the Adfin Options module to define the
264
4 August 2003
Structure
All keywords of the BondStructure Argument are used in CapFloorStructure. The following
keywords have been added:
Keyword Explanation
CAP
Specifies that the instrument structure defines an interest rate cap {no value}
CAP to specify an interest rate cap
CCM
Specifies the type of the yearly rates (Strike and forward rate) {00, A0, A0D, A25D, A5,
A5D, AA, CONT, DAYA0, DAYA5, DISCA0, DISCA5, DF, E0, IAM, MMA0, MMA5, MMA0, MMAA, MME0,
MMNL0, MMNL5}
CCM:00 for 30/360
CCM:A0 for Actual/360
CCM:A0D for Actual/360 (daily compounding)
CCM:A25D for Actual/365.25 (daily compounding)
CCM:A5 for Actual/365
CCM:A5D for bond Actual/365 (daily compounding)
CCM:AA for Actual/Actual
CCM:CONT for continuous
CCM:DAYA0 for daily Actual/360
CCM:DAYA5 for daily Actual/365
CCM:DISCA0 for discount Actual/360
CCM:DISCA5 for discount Actual/365
CCM:DF for discount factor
CCM:E0 for 30E/360 ISMA
CCM:IAM for interest at maturity
CCM:MM00 for money market 00/360
CCM:MMA5 for money market Actual/365
CCM:MMA0 for money market Actual/360
CCM:MMAA for money market Actual/Actual
CCM:MME0 for money market 30E/360
CCM:MMNL0 for money market Actual No Leap/360
CCM:MMNL5 for money market Actual No Leap/365
Default value: CCM:MMA0
4 August 2003
265
CapFloorStructure
Keyword Explanation
266
CFADJ
CLDR
Calendar parameter for expiry date and dividend date adjustments {calendars}
CLDR:calendars to assign one or more calendars used for moving dividend dates if they
fall on non-working days
Default value: CLDR:NULL (no date adjustment is made)
COLLAR
CONVBIAS
Specifies whether the convexity bias is made or not {YES, NO} (see the Notes section
below)
CONVBIAS:YES to make the adjustment
CONVBIAS:NO not to make the adjustment
Default value: CONVBIAS:NO
DMC
Date moving convention used when an expiry date or a dividend date falls on a non
working day {F, FOL, M, MOD, N, NONE, P, PRE}
DMC:F or DMC:FOL for moving the date to the following working day
DMC:M or DMC:MOD for moving the date to the following working day unless it causes the
date to be pushed into the next month (in this latter case, the last working day of the
month is used)
DMC:N or DMC:NONE for no date moving
DMC:P or DMC:PRE for moving the date to the preceding working day
Default value: DMC:F
FAD
FIXING
Reset frequency of the forward rate of the option {i, where i is numeric} (see the Notes
section below)
FIXING:i to specify that the forward rate is reset i times during the lifetime of the option
Default value: FIXING:0
4 August 2003
Keyword Explanation
FLOOR
FRQ
KI
KO
PAYMENT
Payment time of the cash flow payoff {START, END} (see the Notes section below)
PAYMENT:START to specify that the payoff is received at the beginning of the associated
protection period
PAYMENT:END to specify that the payoff is received at the end of the associated
protection period
Default value: PAYMENT:END
REFDATE
RESET
Defines when the forward rate is reset {ADVANCE, ARREARS} (see the Notes section
below)
RESET:ADVANCE to specify that the forward rate is reset in advance
RESET:ARREARS to specify that the forward rate is reset in arrears
Default value: RESET:ADVANCE
4 August 2003
267
CdsStructure
CdsStructure
CdsStructure is used as argument in functions of the Adfin Credit module to define the structure of
a credit default swap.
CdsStructure is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
268
Keyword
Explanation
AMORT
AOD
Specifies whether the accrued is paid at the credit event date or not {YES, NO} (see the
Notes section below)
AOD:YES means that the accrued is paid at the credit event date
AOD:NO means that the accrued is not paid at the credit event date
Default value: AOD:NO
ARND
Rounding mode of the accrued interest {NO} or {i (where i is numeric) : {UP, DOWN,
NEAR}}
ARND:NO if no rounding is requested
ARND:i:{UP,DOWN,NEAR} for rounding to the precision defined by i
Default value: ARND:NO if no rounding is specified
ARND:i:NEAR if i is specified
4 August 2003
Keyword
Explanation
CCM
Coupon calculation method {BB00, BBA0, BBA5, BBAA, BBE0, MM00, MMA0, MMA5, MMAA,
MME0, MMNL0, MMNL5, 00D, A0D, A5D, E0D, 00, A0, A5, AA, E0}
CCM:BB00 for bond 30/360
CCM:BBA0 for bond Actual/360
CCM:BBA5 for bond Actual/365
CCM:BBAA for bond Actual/Actual
CCM:BBE0 for bond 30E/360 ISMA
CCM:MM00 for money market 00/360
CCM:MMA5 for money market Actual/365
CCM:MMA0 for money market Actual/360
CCM:MMAA for money market Actual/Actual
CCM:MME0 for money market 30E/360
CCM:MMNL0 for money market Actual No Leap/360
CCM:MMNL5 for money market Actual No Leap/365
CCM:00D for effective 30/360 (day-based)
CCM:A0D for effective Actual/360 (day-based)
CCM:A5D for effective Actual/365 (day-based)
CCM:E0D for effective 30E/360 (day-based)
CCM:00 for effective 30/360 (period-based)
CCM:A0 for effective Actual/360 (period-based)
CCM:A5 for effective Actual/365 (period-based)
CCM:AA for effective Actual/Actual (period-based)
CCM:E0 for effective 30E/360 (period-based)
Default value: CCM:BBAA
CDSTYPE
CFADJ
4 August 2003
269
CdsStructure
270
Keyword
Explanation
CLDR
CPLAG
Contingent payment delay {iWD, where i is numeric} (see the Notes section below)
CPLAG:iWD to define the number of days that separate the credit event time from the
contingent payment time
Default value: CPLAG:0WD
CRND
CUR
DATED
DMC
Date moving convention used when an expiry date or a dividend date falls on a non
working day {F, FOL, M, MOD, N, NONE, P, PRE}
DMC:F or DMC:FOL for moving the date to the following working day
DMC:M or DMC:MOD for moving the date to the following working day unless it causes the
date to be pushed into the next month (in this latter case, the last working day of the
month is used)
DMC:N or DMC:NONE for no moving date
DMC:P or DMC:PRE for moving the date to the preceding working day
Default value: The value of the DMC keyword of the "IRS" category
4 August 2003
Keyword
Explanation
EMC
End-of-month convention used when the maturity date falls on the last day of a month
{D, DEF, L, LAST, S, SAME, L28}
EMC:D or EMC:DEF for the value in Default Settings
EMC:L or EMC:LAST for last
EMC:S or EMC:SAME for same
EMC:L28 to match Hong Kong bond requirements: They ignore the 29th of February for
cash flow payment. This affects semi-annual bonds maturing on the 31st of August.
Coupons are paid every 31st of August and every 28th of February. In case of a leap
year the cash flow is still paid the 28th and not the 29th
Default value: The value of the EMC keyword of the "IRS" category
FRCD
FRQ
4 August 2003
271
CdsStructure
Keyword
Explanation
IC
Irregular first coupon type for asset swaps combined with bonds with an irregular first
coupon {L1, L1R, S1, S1P, S1R, NBC}
(the bond issue date must also be specified using DATED)
IC:L1 for long first coupon (first coupon date equal to second anniversary date)
IC:L1R for long first coupon with regular nominal value and starting accrued date equal
to first anniversary date (SPGB)
IC:S1 for short first coupon (first coupon date equal to first anniversary date)
IC:S1P for short first coupon with proportional value (BTAN)
IC:S1R for short first coupon with regular nominal value
IC:NBC for NBC first coupon
Default value: IC:S1
LBOTH
LFIXED
LFLOAT
LPAID
LRCD
Last regular coupon date for odd last coupon {DDMMMYY, JGB}
LRCD:DDMMMYY where DDMMMYY is the last regular coupon date
LRCD:JGB to handle odd last coupons for JGBs automatically
Default value: All coupons are regular so LRCD has no meaning
272
4 August 2003
Keyword
Explanation
LTYPE
MDADJ
NOTIONAL
PDELAY
REFDATE
RND
4 August 2003
273
ConvMode
Keyword
Explanation
RP
RT
Reimbursement type {B, C{:i}, Sj{:i} where i is numeric (1=100%) and j from 1 to 8}
RT:B for bullet or in fine
RT:C for constant payments
RT:C:i for constant payments equal to i except for the last cash flow which is adjusted
RT:Sj for j series
RT:Sj:i for j series and constant payments equal to i except for the last cash flow
which is adjusted
Default value: RT:B
ConvMode
ConvMode is used as argument in functions of the Adfin Bonds module to define the so-called
ConvStructure
ConvStructure is used as argument in functions of the Adfin Bonds module to define the structure
of a convertible bond.
ConvStructure is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
274
All keywords of the Argument are used in ConvStructure. The following keywords have been
added:
4 August 2003
Example
Keyword
Explanation
AOC
CONVRATIO
CROSS
DIVTYPE
Dividend type {CONT, DISC, FIXED, PROP} (see the Notes section below)
DIVTYPE:CONT for continuous dividends
DIVTYPE:DISC for discounted dividends
DIVTYPE:PROP for proportional dividends
Default value: DIVTYPE:CONT
HURDLE
IOTYPE
Specifies the format of function inputs and outputs {CASH, PERCENT} (see the Notes
section below)
IOTYPE:CASH determines that inputs and outputs are expressed in their current
currency.
IOTYPE:PERCENT determines that inputs and outputs are expressed as a percentage
of the face value.
Default value: IOTYPE:PERCENT is the default value for all other bonds
ends at 01JAN01, and the conversion ratio is equal to 1.2 between the two dates.
4 August 2003
275
CreditStructure
IOTYPE keyword
The IOTYPE keyword is used to describe the format of the following inputs and outputs in the Adfin
convertible functions
Functions
Inputs
Outputs
AdConvBdDeriv
Straight Value
AdConvCalcCpn
AdConvCashFlows
AdConvImpliedVol
AdConvPrice
AdConvYiel
CreditStructure
CreditStructure is used as argument in functions of the Adfin Credit module to define the structure
of a keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
276
Keyword
Explanation
APPROX
Specifies whether the calibration of the Cox, Ingersoll, and Ross model uses the
approximated formula or not {YES, NO} (see the Notes section below)
APPROX:YES to use the approximated formula in the calibration of the Cox, Ingersoll,
and Ross model
APPROX:NO to use the exact formula in the calibration of the Cox, Ingersoll, and Ross
model
Default value: APPROX:YES
4 August 2003
Keyword
Explanation
CREDITEVENT Specifies the rating, which corresponds to the credit event {i, where i is numeric} (see
IM
INSTTYPE
Credit model calibration {CDS, DF} (see the Notes section below)
INSTYPE:CDS to calibrate the model by using a credit default swap curve
INSTTYPE:DF to calibrate the model by using a credit zero-coupon curve
Default value: INSTTYPE:CDS
NBDAYS
Specifies the number of days per discrimination interval for pricing of American credit
default swaps {i, where i is numeric}
NBDAYS:i to specify that the discrimination interval is i days
Default value: NBDAYS:3
ND
OBC
4 August 2003
277
CrossStructure
Keyword
Explanation
RATING
Issuing firm rating, expressed as the column number in the transition matrix {j, where
i is numeric} (see the Notes section below)
RATING:i to indicate that the instrument rating is the one of the ith column
Default value: The default value is the highest rating of the transition matrix
RECOVERY
Recovery rate value, expressed as a percentage {i, where i is numeric} (see the
Notes section below)
RECOVERY:i to indicate that the recovery rate is i, expressed as a percentage
Default value: RECOVERY:0
RISKMODEL
CrossStructure
CrossStructure is used as argument in functions of the Adfin Forex & MM module. It defines the
underlying structure of a cross currency and is only used for the style table "CROSS".
CrossStructure is a string consisting of a series of parameters. Each set of parameters consists of
a keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
278
4 August 2003
Structure
Keyword
Explanation
CRDEC
FROM
QU
QM1
Quotation mode of the first currency versus the base currency when different from USD
{DIRECT, INDIRECT}
QM1:DIRECT for direct quotation
QM1:INDIRECT for indirect quotation
Default value: QM1:DIRECT
4 August 2003
279
CsStructure
Keyword
Explanation
QM2
Quotation mode of the second currency versus the base currency when different from
USD {DIRECT, INDIRECT}
QM2:DIRECT for direct quotation
QM2:INDIRECT for indirect quotation
Default value: QM2:DIRECT
SPDEC
SWPR
CsStructure
CsStructure is used as argument in functions of the Adfin Swaps module to define the structure of
a currency swap.
CsStructure is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
280
4 August 2003
Structure
Keyword
Explanation
AMORT
CCM
Coupon calculation method {BB00, BBA0, BBA5, BBAA, BBE0, MM00, MMA0, MMA5, MMAA,
MME0, MMNL0, MMNL5, 00D, A0D, A5D, E0D, 00, A0, A5, AA, E0}
CCM:BB00 for bond 30/360
CCM:BBA0 for bond Actual/360
CCM:BBA5 for bond Actual/365
CCM:BBAA for bond Actual/Actual
CCM:BBE0 for bond 30E/360 ISMA
CCM:MM00 for money market 00/360
CCM:MMA5 for money market Actual/365
CCM:MMA0 for money market Actual/360
CCM:MMAA for money market Actual/Actual
CCM:MME0 for money market 30E/360
CCM:MMNL0 for money market Actual No Leap/360
CCM:MMNL5 for money market Actual No Leap/365
CCM:00D for effective 30/360 (day-based)
CCM:A0D for effective Actual/360 (day-based)
CCM:A5D for effective Actual/365 (day-based)
CCM:E0D for effective 30E/360 (day-based)
CCM:00 for effective 30/360 (period-based)
CCM:A0 for effective Actual/360 (period-based)
CCM:A5 for effective Actual/365 (period-based)
CCM:AA for effective Actual/Actual (period-based)
CCM:E0 for effective 30E/360 (period-based)
Default value: CCM:BBE0 for the fixed leg, or CCM:MMA0 for the floating leg
CFADJ
4 August 2003
281
CsStructure
282
Keyword
Explanation
CLDR
CROSS
CUR
DATED
Dated date for asset swaps combined with bonds with an irregular first coupon
{DDMMMYY}
DATED:DDMMMYY where DDMMMYY is the accrual start date for irregular coupons
Default value: No dated date is defined
DMC
Date moving convention used when a calculated date falls on a non-working day {F,
FOL, M, MOD, N, NONE, P, PRE}
DMC:F or DMC:FOL for moving the date to the following working day
DMC:M or DMC:MOD for moving the date to the following working day unless it causes the
date to be pushed into the next month (in this latter case, the last working day of the
month is used)
DMC:N or DMC:NONE for no moving
DMC:P or DMC:PRE for moving the date to the preceding working day
Default value: The value of the DMC keyword of the "IRS" category
EMC
End-of-month convention used when a calculation date falls on the last day of a month
{L, LAST, S, SAME}
EMC:L or EMC:LAST for setting the calculated date to the last working day
EMC:S or EMC:SAME for setting the calculated date to the same day (in this latter case,
the date may be moved according to the date moving convention if it is a non-working
day)
Default value: The value of the EMC keyword of the "IRS" category
4 August 2003
Keyword
Explanation
FRQ
IC
Irregular first coupon type for asset swaps combined with bonds with an irregular first
coupon {L1, L1R, S1, S1P, S1R, NBC}
(the bond issue date must also be specified using DATED)
IC:L1 for long first coupon (first coupon date equal to second anniversary date)
IC:L1R for long first coupon with regular nominal value and starting accrued date equal
to first anniversary date (SPGB)
IC:S1 for short first coupon (first coupon date equal to first anniversary date)
IC:S1P for short first coupon with proportional value (BTAN)
IC:S1R for short first coupon with regular nominal value
IC:NBC for NBC fist coupon
Default value: IC:S1 (this default value does not affect the first fixed cash flow unless
the dated date is not equal to the CS start date)
LBOTH
LPAID
4 August 2003
283
CurStructure
Keyword
Explanation
NOTIONAL
PDELAY
PEX
CurStructure
CurStructure is used as argument in functions of the Adfin Forex & MM module. It defines the
underlying structure of a currency and is only used for the style table "CUR".
CurStructure is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
284
Keyword
Explanation
CLDR
4 August 2003
Keyword
Explanation
DTM
DTS
Number of working days from trade date to Forex spot date {0, 1, 2, 3, 4, 5}
DTS:0 for 0 working day
DTS:1 for 1 working day
DTS:2 for 2 working days
DTS:3 for 3 working days
DTS:4 for 4 working days
DTS:5 for 5 working days
Default value: No default value is defined
QM
YB
DefStructure
DefStructure is used as argument to define the default settings that apply within one Adfin default
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
4 August 2003
285
DefStructure
Structure for
BOND Category
Structure for
CLDR Category
286
The attributes listed below must be used with the DefCategory argument set to "BOND".
Keyword
Explanation
CFADJ
DMC
Date moving convention used when an expiry date or a dividend date falls on a non
working day {F, FOL, M, MOD, N, NONE, P, PRE}
DMC:F or DMC:FOL for moving the date to the following working day
DMC:M or DMC:MOD for moving the date to the following working day unless it causes the
date to be pushed into the next month (in this latter case, the last working day of the
month is used)
EMC
End-of-month convention used when the maturity date falls on the last day of a month
{D, DEF, L, LAST, S, SAME, L28}
EMC:D or EMC:DEF for the value in Default Settings
EMC:L or EMC:LAST for Last
EMC:S or EMC:SAME for Same
EMC:L28 to match Hong Kong bond requirements: They ignore the 29th of February for
cash flow payment. This particularity affects semi-annual bonds maturing on the 31st
of August. Coupons are paid every 31st of August and every 28th of February. In case
of a leap year the cash flow is still paid the 28th and not the 29th
PX
Price parameter{C, G}
PX:C for clean price
PX:G for gross price
The attributes listed below must be used with the DefCategory argument set to "CLDR".
Keyword
Explanation
YBACKWARD
Number of years before current year used for holiday calculation {i with i as integer}
YBACKWARD:i for calculating holidays from i years backward
YFORWARD
Number of years after current year used for holiday calculation {i with i as integer}
YFORWARD:i for calculating holidays up to i years forward
4 August 2003
Structure for
CROSS Category
The attributes listed below must be used with the DefCategory argument set to "CROSS".
Keyword
Explanation
CRDEC
QM1
Quotation mode of the first currency versus the base currency when different from
USD {DIRECT, INDIRECT}
QM1:DIRECT for direct quotation
QM1:INDIRECT for indirect quotation
QM2
Quotation mode of the second currency versus the base currency when different from
USD {DIRECT, INDIRECT}
QM2:DIRECT for direct quotation
QM2:INDIRECT for indirect quotation
QU
4 August 2003
287
DefStructure
288
Keyword
Explanation
SPDEC
SWPR
4 August 2003
Structure for
CUR Category
The attributes listed below must be used with the DefCategory argument set to "CUR".
Keyword
Explanation
DTM
DTS
Number of working days from trade date to Forex spot date {0, 1, 2, 3, 4, 5}
DTS:0 for 0 working day
DTS:1 for 1 working day
DTS:2 for 2 working days
DTS:3 for 3 working days
DTS:4 for 4 working days
DTS:5 for 5 working days
QM
YB
4 August 2003
289
DefStructure
Structure for
DATE Category
Structure for
FORMULA
Category
The attributes listed below must be used with the DefCategory argument set to "DATE".
Keyword
Explanation
DATEFMT
YPIVOT
Pivotal year between 19xx and 20xx for years specified with 2 digits {i with i from 0 to
100}
YPIVOT:i with i different from 100 for defining 31-Dec-(i-1) = 31-Dec-20(i-1) and
01-Jan-(i) = 01-jan-19(i)
YPIVOT:100 for defining a moving pivotal year equal to i = (current year + 50) i.e.
having 31-Dec-(i-1) = 31-Dec-20(i-1) and 01-Jan-(i) = 01-jan-19(i)
The attributes listed below must be used with the DefCategory argument set to "FORMULA".
Keyword
Explanation
CONV
DUR
earlier)
MATCORRECTED:YES for a period based maturity factor calculation
290
NORMAL
PVBP
VOL
4 August 2003
The attributes listed below must be used with the DefCategory argument set to "IDX".
Keyword
Explanation
AVG
PERIOD
RND
YB
The attributes listed below must be used with the DefCategory argument set to "IRS".
Keyword
Explanation
CFADJ
DMC
Date moving convention used when the calculated date falls on a non-working day {F,
FOL, M, MOD, N, NONE, P, PRE}
DMC:F or DMC:FOL for Following
DMC:M or DMC:MOD for Modified Following
DMC:N or DMC:NONE for None
DMC:P or DMC:PRE for Preceding
4 August 2003
291
DefStructure
Structure for
MMFUTURE
Category
Keyword
Explanation
EMC
End-of-month convention used when the calculation date falls on the last day of a
month {L, LAST, S, SAME}
EMC:L or EMC:LAST for Last
EMC:S or EMC:SAME for Same
PAID
The attributes listed below must be used with the DefCategory argument set to "MMFUTURE".
Keyword
Explanation
NFVP
PFVP
YB
Structure for
RATEMODEL
Category
292
The attributes listed below must be used with the DefCategory argument set to "RATEMODEL".
Keyword
Explanation
CLDRADJ
Cash flow date adjustment according to a calendar {NO, NULL, WE, CLDR}
CLDRADJ:NO for analytic pricing (i.e. from the bond structure)
CLDRADJ:NULL for cash flow pricing using the calendar NULL
CLDRADJ:WEEKEND for cash flow pricing using the calendar WEEKEND
CLDRADJ:CLDR for cash flow pricing using the calendar defined by the keyword CLDR (if
no calendar is defined, CLDRADJ:WEEKEND is used)
4 August 2003
Keyword
Explanation
DCB
Day count basis {00, A0, A0D, A25D, A5, A5D, AA, E0, JAP, NL0, NL5, W252}
DCB:00 for 30/360 (period-based calculation)
DCB:A0 for Actual/360 (period-based calculation)
DCB:A0D for Actual/360 (day-based calculation)
DCB:A25D for Actual/365.25 (day-based calculation)
DCB:A5 for Actual/365 (period-based calculation)
DCB:A5D for Actual/365 (day-based calculation)
DCB:AA for Actual/Actual (period-based calculation)
DCB:E0 for 30E/360 ISMA (period-based calculation)
DCB:JAP for Japanese (A5 or A5 + 1 day for first coupon)
DCB:NL0 for Actual No Leap/360
DCB:NL5 for Actual No Leap/365
DCB:W252 for Actual Working days/252
EY
Equivalent yield parameter {1, 12, 182D, 2, 28D, 364D, 4, 91D, M, Q, S, Y, FRQ}
EY:1 or EY:Y for yearly
EY:12 or EY:M for monthly
EY:182D for a compounding every 182 days
EY:2 or EY:S for semi-annual
EY:28D for a compounding every 28 days
EY:364D for a compounding every 364 days
EY:4 or EY:Q for quarterly
EY:91D for a compounding every 91 days
EY:FRQ for a compounding defined by the FRQ keyword in the BondStructure
IM
ND
4 August 2003
293
DefStructure
294
Keyword
Explanation
OBC
RATEFRQ
Compounding frequency parameter {1, 12, 28D, 182D, 2, 28D, 182D, 364D, 4, 91D, M, Q,
S, Y, ZERO, EY, FRQ}
RATEFRQ:1 or RATEFRQ:Y for yearly
RATEFRQ:12 or RATEFRQ:M for monthly
RATEFRQ:182D for a compounding every 182 days
RATEFRQ:2 or RATEFRQ:S for semi-annual
RATEFRQ:28D for a compounding every 28 days
RATEFRQ:182D for a compounding every 182 days
RATEFRQ:364D for a compounding every 364 days
RATEFRQ:4 or RATEFRQ:Q for quarterly
RATEFRQ:91D for a compounding every 91 days
RATEFRQ:ZERO no compounding
RATEFRQ:EY for compounding defined by the EY keyword
RATEFRQ:FRQ for compounding defined by the FRQ keyword in the BondStructure
RATETYPE
Yield type {CMP, CONT, DISC, MM, MMB, MMM, MMP, TRE, SIMPLEJAP, CMPJAP}
RATETYPE:CMP for Actual
RATETYPE:CONT for continuous yield/rate
RATETYPE:DISC for discounted yield/rate
RATETYPE:MM for Money Market yield/rate
RATETYPE:MMB for Money Market Bullet
RATETYPE:MMM for Money Market Medium
RATETYPE:MMP for Money Market Proceed
RATETYPE:MMR for Money Market Direct Discounting
RATETYPE:TRE for US bills Treasury
RATETYPE:SIMPLEJAP for simple yield/rate
RATETYPE:CMPJAP for compounded yield/rate
ZCTYPE
4 August 2003
Structure for
XLMODE
Category
The attributes listed below must be used with the DefCategory argument set to "XLMODE".
Keyword
Explanation
LAY
followed by a colon (":") and the value of the parameter. Spaces should be used to separate the
parameters in the string.
Structure
Keyword
Description
CTU
DT
Specifies the date type for time series data provided by the Equity and
Treasury sources:
DT:D retrieves only days with values
DT:AD retrieves data for every day
DT:WD retrieves only weekdays (for Price History data)
Default value: DT:D
HEADER
Returned header:
HEADER:YES specifies that headers are returned
HEADER:NO specifies that no header is returned
Default value: HEADER:NO
4 August 2003
295
Keyword
Description
IDFM
IDR
IDZ
Invalid Data Zero keyword determines whether zero values are invalid:
IDZ:YES means that zero values are invalid
IDZ:NO means that zero values are not invalid
Default value: IDZ:NO
LAY
NODATE
NODATE:YES
NODATE:NO
Default value: NODATE:NO
296
4 August 2003
Keyword
Description
NULL
PRIORITY
RECALL
REFRESH
RET
4 August 2003
297
Keyword
Description
SOURCE
SORT
TIMEOUT
TITLE
Specifies whether results include full column names rather than the
abbreviated code names that appear when HEADER is used:
TITLE:YES
TITLE:NO
TRIM:YES
TRIM:NO
298
4 August 2003
followed by a colon (":") and the value of the parameter. Spaces should be used to separate the
parameters in the string.
Structure
Keyword
Description
CTU
CTU (Cells To Update) specifies which cells to update when the Update
action is triggered with DeUpdate on page 230:
CTU:ALL means that all cells will be updated
CTU:CHANGED means that only changed cells will be updated
Default value: CTU:CHANGED
HEADER
Returned header:
HEADER:YES to specify that headers are returned
HEADER:NO to specify that no header is returned
Default value: HEADER:NO
LAY
NULL
Specifies how to handle empty rows in a time list returned with the
DeHistory on page 228:
NULL:SKIP erases any empty rows of data
NULL:REPEAT replaces an empty row with the previous one
NULL:NA replaces any NULL data with #N/A
NULL:NAND replaces any NULL data with #N/A ND
NULL:NIL puts a zero in the cell for any NULL data
Default value: NULL:SKIP
4 August 2003
299
Keyword
Description
PRIORITY
REFRESH
RET
SOURCE
TIMEOUT
TITLE
If TITLE (or TI) is present in the DeMode argument string, results include
full column names rather than the abbreviated code names that appear
when HEADER is specified:
TITLE:YES
TITLE:NO
300
4 August 2003
Keyword
Description
TRIM
TRIM:YES
TRIM:NO
followed by a colon (":") and the value of the parameter. Spaces should be used to separate the
parameters in the string.
Structure
Keyword
Description
CTU
CTU (Cells To Update) specifies which cells to update when the Update
action is triggered with DeUpdate on page 230:
CTU:ALL means that all cells will be updated
CTU:CHANGED means that only changed cells will be updated
Default value: CTU:CHANGED
HEADER
Returned header:
HEADER:YES to specify that headers are returned
HEADER:NO to specify that no header is returned
Default value: HEADER:NO
LAY
4 August 2003
301
Keyword
Description
NULL
Specifies how to handle empty rows in a time list returned with the
DeHistory on page 228:
NULL:SKIP erases any empty rows of data
NULL:REPEAT replaces an empty row with the previous one
NULL:NA replaces any NULL data with #N/A
NULL:NAND replaces any NULL data with #N/A ND
NULL:NIL puts a zero in the cell for any NULL data
Default value: NULL:SKIP
PRIORITY
REFRESH
302
RET
SOURCE
4 August 2003
Keyword
Description
TIMEOUT
TITLE
If TITLE (or TI) is present in the DeMode argument string, results include
full column names rather than the abbreviated code names that appear
when HEADER is specified:
TITLE:YES
TITLE:NO
TRIM:YES
TRIM:NO
followed by a colon (":") and the value of the parameter. Spaces should be used to separate the
parameters in the string.
Structure
Keyword
Description
CTU
CTU (Cells To Update) specifies which cells to update when the Update
4 August 2003
303
Keyword
Description
HEADER
Returned header
HEADER:YES to specify that headers are returned
HEADER:NO to specify that no header is returned
Default value: HEADER:NO
LAY
NULL
Specifies how to handle empty rows in a time list returned with the
DeHistory on page 228:
NULL:SKIP erases any empty rows of data
NULL:REPEAT replaces an empty row with the previous one
NULL:NA replaces any NULL data with #N/A
NULL:NAND replaces any NULL data with #N/A ND
NULL:NIL puts a zero in the cell for any NULL data
Default value: NULL:SKIP
PRIORITY
REFRESH
304
4 August 2003
Keyword
Description
SOURCE
TITLE
If TITLE (or TI) is present in the DeMode argument string, results include
full column names rather than the abbreviated code names that appear
when HEADER is specified:
TITLE:YES
TITLE:NO
Default value: No TITLE
TRIM
TRIM:YES
TRIM:NO
followed by a colon (":") and the value of the parameter. Spaces should be used to separate the
parameters in the string.
4 August 2003
305
Structure
Keyword
Description
CTU
CTU (Cells To Update) specifies which cells to update when the Update
Returned header
HEADER:YES to specify that headers are returned
HEADER:NO to specify that no header is returned
Default value: HEADER:NO
LAY
NULL
Specifies how to handle empty rows in a time list returned with the
DeHistory on page 228:
NULL:SKIP erases any empty rows of data
NULL:REPEAT replaces an empty row with the previous one
NULL:NA replaces any NULL data with #N/A.
NULL:NAND replaces any NULL data with #N/A ND
NULL:NIL puts a zero in the cell for any NULL data
Default value: NULL:SKIP
PRIORITY
REFRESH
306
4 August 2003
Keyword
Description
RET
SOURCE
SPLIT
Specifies an array in which to place the text string retrieved from the
ADFIN_STRUCTURE FieldList argument with DeUpdate on page 230:
SPLIT:n (n as an integer), with n specifies the number of cells.
The results can be longer than 255 byte characters in length, that is the
current limit for return strings This keyword defines exactly how many
pieces can be made from a string by using spaces. DeUpdate will
generate a return table and each piece of the string will be placed in a
separate cell in the same direction as field values for an instrument.
Returns an error message if the specified array is too small.
Default value: SPLIT:0
Note: Despite the apparent resemblance with cell addressing, the SPLIT
keyword only specifies the dimension of the array, not a location on a
spreadsheet.
TIMEOUT
TITLE
If TITLE (or TI) is present in the DeMode argument string, results include
full column names rather than the abbreviated code names that appear
when HEADER is specified:
TITLE:YES
TITLE:NO
4 August 2003
307
DfMode
Keyword
Description
TRIM
TRIM:YES
TRIM:NO
UWC
DfMode
DfMode is used as argument in functions of the Adfin Common module to customize returned values.
DfMode is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
308
Keyword
Explanation
DCB
Day count basis {00, A0, A0D, A25D, A5, A5D, AA, E0}
DCB:00 for 30/360
DCB:A0 for Actual/360
DCB:A0D for Actual/360 (day-based)
DCB:A25D for Actual/365.25 (day-based)
DCB:A5 for Actual/365
DCB:A5D for Actual/365 (day-based)
DCB:AA for Actual/Actual
DCB:E0 for 30E/360 ISMA
Default value: DCB:AA
4 August 2003
Example
Keyword
Explanation
DMC
Date moving convention used when the calculated date falls on a non-working day {F,
FOL, M, MOD, N, NONE, P, PRE}
DMC:F or DMC:FOL for Following
DMC:M or DMC:MOD for Modified Following
DMC:N or DMC:NONE for None
DMC:P or DMC:PRE for Preceding
Default value: DMC:F
EMC
End-of-month convention used when the calculation date falls on the last day of a
month {L, LAST, S, SAME}
EMC:L or EMC:LAST for Last
EMC:S or EMC:SAME for Same
Default value: EMC:L
LAY
RET
Return value parameter to shorten the array of data returned by array functions {Ai, Bi,
i with i as integer}
RET:Ai with i from 1 to ArraySize to get the array of the i first elements (values only)
RET:Bi with i from 1 to ArraySize to get the array of the i first elements along with
their names (header and values)
RET:i with i from 1 to ArraySize to get the i-th element only.
DMC:P calculates dates using the preceding day date moving convention.
ExoticStructure
ExoticStructure is used as argument in functions of the Adfin Options module to define the
of a keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
4 August 2003
309
ExoticStructure
Structure
310
Keyword
Explanation
ASIAN
AVE
BINARY
CALL
DCB
Day count basis {00, A0, A0D, A25D, A5, A5D, AA, E0, IT, JAP, NL0, NL5, W252} (see the
Notes section below)
DCB:00 for 30/360 (period-based calculation)
DCB:A0 for Actual/360 (period-based calculation)
DCB:A0D for Actual/360 (day-based calculation)
DCB:A25D for Actual/365.25 (day-based calculation)
DCB:A5 for Actual/365 (period-based calculation)
DCB:A5D for Actual/365 (day-based calculation)
DCB:AA for Actual/Actual (period-based calculation)
DCB:E0 for 30E/360 ISMA (period-based calculation)
DCB:IT for Italian (from last coupon date to settlement date in E0 + 1 day)
DCB:JAP for Japanese (A5 or A5 + 1 day for first coupon)
DCB:NL0 for Actual No Leap/360
DCB:NL5 for Actual No Leap/365
DCB:W252 for Actual Working days/252
Default value: DCB:AA
4 August 2003
Keyword
Explanation
DIVTYPE
EXM
Exercise mode {A, AMER, AMERICAN, DDMMMYY{:DDMMMYY{:i}}, E, EUR, EURO} (see the
Notes section below)
EXM:A, EXM:AMER, or EXM:AMERICAN to specify an exotic option with an American mode
EXM:DDMMMYY or EXM:DDMMMYY:DDMMMYY to specify an exotic option with a Bermudan
mode
EXM:DDMMMYY:DDMMMYY:i to specify a Composite or Quanto option with variable strike
price i
EXM:E, EXM:EUR, or EXM:EURO to specify an exotic option with a European mode\
Default value: EXM:EURO
FXLINK
Type of foreign exchange linked option {COMPO, ELFX, QUANTO} (see the Notes section
below)
FXLINK:COMPO to specify a Composite option
FXLINK:ELFX to specify an Equity Linked Foreign Exchange option
FXLINK:QUANTO to specify a Quanto option
Default value: No default foreign exchanged linked option type is defined, mandatory
keyword
KI
Knock in barrier flag {no value} (see the Notes section below)
KI to specify a knock in or double knock in Barrier option
Default value: No barrier is defined
KIKO
KO
Knockout barrier flag {no value} (see the Notes section below)
KO to specify a knockout or double knockout Barrier option
Default value: No barrier is defined
KOKI
4 August 2003
311
ExoticStructure
312
Keyword
Explanation
LADDER
LOOK
PUT
RAIN
Type of a Rainbow option {MAX, MIN, SPREAD, DUAL, BEST} (see the Notes section
below)
RAIN:MAX to specify a best of two assets option
RAIN:MIN to specify a worst of two assets option
RAIN:SPREAD to specify a Spread option
RAIN:DUAL to specify a Dual-Strike option
RAIN:DUAL to specify a Best Of option
Default value: No default Rainbow option type is defined, mandatory keyword
RATEFRQ
Compounding frequency parameter {1, 12, 28D, 182D, 2, 28D, 182D, 364D, 4, 91D, M, Q,
S, Y, ZERO} (see the Notes section below)
RATEFRQ:1 or RATEFRQ:Y for yearly
RATEFRQ:12 or RATEFRQ:M for monthly
RATEFRQ:182D for a compounding every 182 days
RATEFRQ:2 or RATEFRQ:S for semi-annual
RATEFRQ:28D for a compounding every 28 days
RATEFRQ:182D for a compounding every 182 days
RATEFRQ:364D for a compounding every 364 days
RATEFRQ:4 or RATEFRQ:Q for quarterly
RATEFRQ:91D for a compounding every 91 days
RATEFRQ:ZERO no compounding
Default value: RATEFRQ:YEARLY or RATEFRQ:1
4 August 2003
Keyword
Explanation
RATETYPE
Yield type {CONT, DISC, MM, MMB, MMM, MMP, TRE, SIMPLEJAP, CMPJAP} (see the Notes
section below)
RATETYPE:CONT for continuous yield/rate
RATETYPE:DISC for discounted yield/rate
RATETYPE:MM for Money Market yield/rate
RATETYPE:MMB for Money Market Bullet
RATETYPE:MMM for Money Market Medium
RATETYPE:MMP for Money Market Proceed
RATETYPE:MMR for Money Market Direct Discounting
RATETYPE:TRE for US bills Treasury
RATETYPE:SIMPLEJAP for simple yield/rate
RATETYPE:CMPJAP for compounded yield/rate
Default value: RATETYPE:CONT
REBATE
Rebate amount for Barrier and double Barrier options {i, i:j (where i and j are
numeric)}
REBATE:i to indicate that the option holder receives the cash amount i if the Barrier
option is cancelled
REBATE:i:j to indicate that the option holder receives the cash amount i if the
down-barrier is hit and the cash amount j if the up-barrier is hit
Default value: REBATE:0
TOUCH
UI
4 August 2003
313
ExoticStructure
Notes
Keyword
Explanation
UO
WIN
Start date or end date of Window Barrier options {END:DDMMMYY, START:DDMMMYY} (see
the Notes section below)
WIN:END:DDMMMYY where DDMMMYY is the end date for an early-end Window Barrier
WIN:START:DDMMMYY where DDMMMYY is the start date for Forward-Start Window Barrier
Default value: No default Window type is defined for Window Barrier options
Topic
Recommendation
ExoticStructure option
type
314
Barrier options
WIN
You can specify WIN either as a serial number, or by using the DDMMMYY
format.
You cannot use EXM:{A, AMER, AMERICAN} with a Basket option with
more than two assets.
CMT:FORM
FXLINK:EFLX
If the exercise period lasts only one day, you must specify the same
date DDMMMYY in the keyword EXM:DDMMMYY:DDMMMYY:i.
4 August 2003
Topic
Recommendation
SOLVER in the
CalcStructure
CMT:FORM
FormatMode
FormatMode is used as argument in functions of the Adfin Common module to define the formatting
mode.
FormatMode is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
Keyword
Explanation
ADAA
BACTRL
Bid > Ask control {ASK, BID, ERR, INV, MID, NO}
BACTRL:ASK to set the Bid rate to the Ask value
BACTRL:BID to set the Ask rate to the Bid value
BACTRL:ERR to generate an error message
BACTRL:INV to set the Bid rate to the Ask value and the Ask rate to the Bid value
BACTRL:MID to set the Bid and Ask rates to the Mid value
BACTRL:NO to keep the original Bid and Ask rates
Default value: BACTRL:MID
BASEP
Separator between the Bid rate and the Ask rate {any character(s), "^" standing for a
space}
BASEP:- to use for instance the separator "-"
Default value: BASEP:^/^
4 August 2003
315
FormatMode
Keyword
Explanation
BAWARN
DATA
FD
Examples
FSEP
Separator between the integer component and the fractional component {any
character(s), "^" standing for a space}
FSEP:- to use for instance the separator "-"
Default value: FSEP:^
FSHOW
SCALE
Scaling factor between the real and the displayed rates {i with i as integer}
SCALE:i to multiply the Bid and Ask rates by 10E+i
Default value: SCALE:1
FD:32 FSHOW converts a decimal number into 32s and display the fraction denominator /32
after the integer and fractional components
BASEP:^-^ BACTRL:ERR uses " - " as Bid/Ask separator and displays an error message if the
Bid rate is greater than the Ask rate.
316
4 August 2003
FrnMode
FrnMode is used as argument in functions of the Adfin Bonds module to define the attributes of the
zero-coupon yield curves used in input.
FrnMode is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
Keyword
Explanation
DCB
Day count basis used for zero-coupon calculations {00, A0, A0D, A25D, A5, A5D, AA, E0}
DCB:00 for 30/360 (period-based calculation)
DCB:A0 for Actual/360 (period-based calculation)
DCB:A0D for Actual/360 (day-based calculation)
DCB:A25D for Actual/365.25 (day-based calculation)
DCB:A5 for Actual/365 (period-based calculation)
DCB:A5D for Actual/365 (day-based calculation)
DCB:AA for Actual/Actual (period-based calculation)
DCB:E0 for 30E/360 ISMA (period-based calculation)
Default value: The value of the DCB keyword of the "RATEMODEL" category
FROM
Type of the input rate for FrnMargin {ASM, ATM, DM, PXA, PXC, PXG, SM, YS, YTM}
FROM:ASM for the adjusted simple margin
FROM:ATM for the adjusted total margin
FROM:DM for the discounted margin
FROM:PXA for the adjusted price
FROM:PXC for the clean price
FROM:PXG for the gross price
FROM:SM for the simple margin
FROM:YS for the yield to maturity spread
FROM:YTM for the yield to maturity
Default value: No default input price type is defined, mandatory keyword
IAC
Cash flows calculation split up into interest and principal {no value}
IAC to display interest cash flows and principal cash flows into two separate columns
Default value: nterest and principal added in cash flows calculation
4 August 2003
317
FrnMode
318
Keyword
Explanation
IM
LAY
ND
OBC
RET
Return value parameter to shorten the array of data returned by array functions {Ai,
Bi, i with i as integer}
RET:Ai with i from 1 to ArraySize to get the array of the i first elements (values only)
RET:Bi with i from 1 to ArraySize to get the array of the i first elements along with
their names (header and values)
RET:i with i from 1 to ArraySize to get the i-th element only
4 August 2003
Keyword
Explanation
TO
Type of the output rate for FrnMargin {ASM, ATM, DM, PXA, PXC, PXG, SM, YS, YTM}
TO:ASM for the adjusted simple margin
TO:ATM for the adjusted total margin
TO:DM for the discounted margin
TO:PXA for the adjusted price
TO:PXC for the clean price
TO:PXG for the gross price
TO:SM for the simple margin
TO:YS for the yield to maturity spread
TO:YTM for the yield to maturity
Default value: No default output price type is defined, mandatory keyword
YTM
ZCTYPE
4 August 2003
319
FrnStructure
Note
Topic
Recommendation
FROM and TO
YS
The FROM and TO keywords specify the data type of the Px argument of
the FrnMargin function. When it takes the value YS (yield to maturity
spread ), the user must know that the input yield is always expressed
in the FRN frequency.
The LAY:H keyword, which describes the result array orientation in the
FrnMode argument, is mandatory when used in the FrnCashFlows
function.
FrnMode
FrnStructure
FROM and TO is used as argument in functions of the Adfin Bonds module to define the structure of a
floating-rate note.
FROM and TO is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
320
4 August 2003
Structure
Keyword
Explanation
FROM and
TO
Accrued interest calculation method {{00, A0, A5, AA, E0, MMA0, MMA5} with {:SSD}
optional for each value }
ACC:00 for 30/360
ACC:A0 for Actual/360
ACC:A5 for Actual/365
ACC:AA for Actual/Actual
ACC:E0 for 30E/360
ACC:MMA0 for money market Actual/360
ACC:MMA5 for money market Actual/365
ACC:i:SSD for German Schuldscheindarlehen bonds where i is {00, A0, A5, AA, E0,
MMA0, MMA5}
Default value: ACC:00
ALIMIT
Accrued interest adjustment method for Actual/360 and Actual/365 {CPN, NEXT, NO}
ALIMIT:CPN to limit the accrued interest to the regular coupon value
ALIMIT:NEXT to adjust the coupon subtracting the exceeding number of days
ALIMIT:NO to allow the accrued interest to exceed the regular coupon value
Default value: ALIMIT:NEXT
AMORT
ARND
Rounding mode of the accrued interest {NO} or {i (where i is numeric) : {UP, DOWN,
NEAR}}
ARND:NO if no rounding is requested
ARND:i:{UP, DOWN, NEAR} for rounding to the precision defined by i
Default value: ARND:NO if no rounding is requested
ARND:i:NEAR if i is specified
CALL
CAP
4 August 2003
321
FrnStructure
322
Keyword
Explanation
CCM
Coupon calculation method {BB00, BBA0, BBA5, BBAA, BBE0, MM00, MMA0, MMA5, MMAA,
MME0, MMNL0, MMNL5, v, A0D, A5D, E0D, 00, A0, A5, AA, E0}
CCM:BB00 for bond 30/360
CCM:BBA0 for bond Actual/360
CCM:BBA5 for bond Actual/365
CCM:BBAA for bond Actual/Actual
CCM:BBE0 for bond 30E/360 ISMA
CCM:MM00 for money market 00/360
CCM:MMA5 for money market Actual/365
CCM:MMA0 for money market Actual/360
CCM:MMAA for money market Actual/Actual
CCM:MME0 for money market 30E/360
CCM:MMNL0 for money market Actual No Leap/360
CCM:MMNL5 for money market Actual No Leap/365
CCM:00D for effective 30/360 (day-based)
CCM:A0D for effective Actual/360 (day-based)
CCM:A5D for effective Actual/365 (day-based)
CCM:E0D for effective 30E/360 (day-based)
CCM:00 for effective 30/360 (period-based)
CCM:A0 for effective Actual/360 (period-based)
CCM:A5 for effective Actual/365 (period-based)
CCM:AA for effective Actual/Actual (period-based)
CCM:E0 for effective 30E/360 (period-based)
Default value: CCM:MMA0
CFADJ
4 August 2003
Keyword
Explanation
CLDR
Calendar parameter for coupon date adjustments {calendars} (see the Notes section
below)
CLDR:calendars to assign one or more calendars used for moving coupon dates if they
fall on non-working days
Default value: CLDR:NULL (no date adjustment is made)
CRND
DATED
DMC
Date moving convention used when a calculated date falls on a non-working day {F,
FOL, M, MOD, N, NONE, P, PRE}
DMC:F or DMC:FOL for moving the date to the following working day
DMC:M or DMC:MOD for moving the date to the following working day unless it causes the
date to be pushed into the next month (in this latter case, the last working day of the
month is used)
DMC:N or DMC:NONE for no moving date (also requires CLDR:NULL)
DMC:P or DMC:PRE for moving the date to the preceding working day
Default value: DMC:F
EMC
End-of-month convention used when a calculation date falls on the last day of a month
{L, LAST, S, SAME}
EMC:L or EMC:LAST for setting the calculated date to the last working day
Default value: EMC:L
4 August 2003
323
FrnStructure
324
Keyword
Explanation
EY
Equivalent yield parameter {1, 12, 182D, 2, 28D, 364D, 4, 91D, M, Q, S, Y, FRQ}
EY:1 or EY:Y for yearly
EY:12 or EY:M for monthly
EY:182D for compounding every 182 days
EY:2 or EY:S for semi-annual
EY:28D for compounding every 28 days
EY:364D for compounding every 364 days
EY:4 or EY:Q for quarterly
EY:91D for compounding every 91 days
EY:FRQ for compounding defined by the FRQ keyword in the BondStructure
Default value: The value of FRQ (of FrnStructure)
FAD
FCV
FLOOR
FRCD
4 August 2003
Keyword
Explanation
FRQ
IC
IDX
INTCAP
ISSUE
4 August 2003
325
FrnStructure
326
Keyword
Explanation
LOCK
Lockout period in settlement date calculations {iWD with i>0} (see the Notes section
below)
LOCK:iWD for i working days
Default value: No lockout period calculation rule defined
LRCD
Last regular coupon date for odd last coupon {DDMMMYY, JGB}
LRCD:DDMMMYY where DDMMMYY is the last regular coupon date
LRCD:JGB to handle automatically odd last coupons for JGBs
Default value: All coupons are regular so LRCD has no meaning
MDADJ
NC
NOTIONAL
PDELAY
PPMT
4 August 2003
Keyword
Explanation
PUT
PXRND
Rounding mode of the output price {NO} or {i (where i is numeric): {UP, DOWN, NEAR}}
PXRND:NO if no rounding is requested.
PXRND:i:{UP,DOWN,NEAR} for rounding to the precision defined by i
Default value: PXRND:NO if no rounding is requested
PXRND:i:NEAR if i is specified
QM
REFDATE
REPO
RP
RT
Reimbursement type {B, C{:i}, Sj{:i} where i is numeric (1=100%) and j from 1 to 8}
RT:B for bullet or in fine
RT:C for constant payments
RT:C:i for constant payments equal to i except for the last cash flow which is adjusted
RT:Sj for j series
RT:Sj:i for j series and constant payments equal to i except for the last cash flow
which is adjusted
Default value: RT:B
4 August 2003
327
FrnStructure
328
Keyword
Explanation
SETTLE
Settlement datecalculation rule {AUT, INTL, JAP, RSA, iD, iDF, iDM, iDN, iDP, iWD with i
from 1 to 9}
SETTLE:AUT for the Austrian settlement rule
SETTLE:INTL for the International settlement rule
SETTLE:JAP for the Japanese settlement rule
SETTLE:RSA for the South-African settlement rule
SETTLE:iD for i calendar days and the default date moving convention
SETTLE:iDF for i calendar days and the following date moving convention
SETTLE:iDM for i calendar days and the modified following date moving convention
SETTLE:iDN for i calendar days and no date moving convention
SETTLE:iDP for i calendar days and the preceding date moving convention
SETTLE:iWD for i working days
(the calendar used must also be specified using CLDR)
Default value: No settlement date calculation rule defined
XD
Ex-dividend calculation {no value, NO, YES, iD, iWD, AUT, DEN}
XD or XD:YES to force ex-dividend calculations (exclude the right to the next coupon)
XD:NO to force cum-dividend calculations (grant the right to the next coupon)
XD:iD for an ex-dividend period of i calendar days
XD:iWD for an ex-dividend period of i working days
XD:AUT for the Austrian ex-dividend period
XD:DEN for the Dane ex-dividend period
Default value: XD:0
YLDRND
Rounding mode of the output yield {NO} i (where i is numeric) : {UP, DOWN, NEAR}}
YLDRND:NO if no rounding is requested.
YLDRND:i:{UP,DOWN,NEAR} for rounding to the precision defined by i
Default value: YLDRND:NO
YLDRND:i:NEAR if i is specified
4 August 2003
Notes
Topic
Recommendation
CALL and PUT keywords either specify dates as serial numbers, or use
the DDMMMYY or default format.
yield to maturity and yield to The yield to maturity and yield to maturity spread methods do not
maturity spread
support the CLDR keyword since they are period-based and assume
that all coupon periods have the same length.
LOCK:iWD has a upper limit, which is the number of days between the
settlement date and the next coupon date of the bond. This limit
depends on the properties of the bond. If you specify a LOCK value
greater than this limit, Adfin Analytics interprets it as the upper limit
and does not return an error message.
LOCK:iWD
FxMode
FxMode is used as argument in functions of the Adfin Forex & MM module to customize returned
values.
FxMode is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
FxMode is generally optional.
Structure
Keyword
Explanation
BACTRL
Bid > Ask control {ASK, BID, ERR, INV, MID, NO}
BACTRL:ASK to set the Bid rate to the Ask value
BACTRL:BID to set the Ask rate to the Bid value
BACTRL:ERR to generate an error message
BACTRL:INV to set the Bid rate to the Ask value and the Ask rate to the Bid value
BACTRL:MID to set the Bid and Ask rates to the Mid value
BACTRL:NO to keep the original Bid and Ask rates
Default value: BACTRL:MID
4 August 2003
329
FxMode
330
Keyword
Explanation
DEC
Decimal precision parameter for cross rates and swap points {no value, i with i as
integer}
DEC to use the values defined in the cross currency database (or the default values for
unlisted cross currencies)
DEC:i with i from 0 to 9 to force the precision to a given number of decimals
Default value: No precision is defined (the raw value is used)
FROM
IGNR
LAY
QM1
Quotation mode of the first currency versus the base currency when different from
USD {DIRECT, INDIRECT}
QM1:DIRECT for direct quotation
QM1:INDIRECT for indirect quotation
Default value: QM1:DIRECT
QM2
Quotation mode of the second currency versus the base currency when different from
USD {DIRECT, INDIRECT}
QM2:DIRECT for direct quotation
QM2:INDIRECT for indirect quotation
Default value: QM2:DIRECT
4 August 2003
Keyword
Explanation
RES
RET
Return value parameter to shorten the data returned by array functions {Ai, i with i as
integer}
RET:Ai with i from 1 to ArraySize to get the i first elements
RET:i with i from 1 to ArraySize to get the i-th element only
Default value: No expected result is defined
HistoryMode
The HistoryMode argument is used in the RtHistory and RtHistoryInfo functions to customize
the return array.
HistoryMode is a string made up of a series of parameters, each one consisting of a keyword
possibly followed by a colon (":") and the value of the parameter. Spaces should be used to separate
the parameters in the string.
Structure
Keyword
Explanation
HEADER
4 August 2003
331
HistoryMode
Keyword
Explanation
LAY
NULL
Specifies the processing of null values for history dates in RtHistory {NA, REPEAT,
SKIP}
NULL:NA to display N/A ND for null fields
NULL:REPEAT to repeat the first preceding data with no null field (if existing)
NULL:SKIP to skip the dates with any null field]
Notes
RES
RET
SORT
List sorting order of the time series for RtHistory {ASC, DESC}
SORT:ASC for ascending, i.e. oldest first
SORT:DESC for descending, i.e. most recent first
Default value: SORT:DESC
ZERO
Topic
Recommendation
NULL keyword NULL keyword only defines how dates with null data are handled. Dates before the
time series start date or after the time series end date are always ignored.
332
4 August 2003
Topic
Recommendation
EVENTS
When you define the number of data points to retrieve in the HistoryStructure
argument using the EVENTS keyword, dates with null data are counted with NULL:NA
and NULL:REPEAT, and ignored with NULL:SKIP.
keyword
HistoryStructure
The HistoryStructure argument is used in the RtHistory function to define the range of dates
between which historical data are retrieved.
HistoryStructure is a string made up of a series of parameters, each one consisting of a keyword
possibly followed by a colon (":") and the value of the parameter. Spaces should be used to separate
the parameters in the string.
the start date and the end date between which data points are retrieved
the end date and the number of data points retrieved from the date backward in time
the start date and the number of data points retrieved from the date forward in time
With all the above methods, the number of dates actually returned depends on the retrieval
frequency. You may choose to retrieve all available dates, i.e. daily data, or select a monthly or
yearly frequency.
Structure
Keyword
Explanation
END
EVENTS
4 August 2003
333
HistoryStructure
Keyword
Explanation
FRQ
Supported Date
Formats
NBEVENTS
START
Dates specified with any other format are misinterpreted, which can lead to an error in the function.
Notes
Topic
Recommendation
START
If you do not specify the START keyword or the END keyword, data is
retrieved backwards from the current date.
334
If the data available for the time series does not cover the start date, the
earliest data point is used as the start of the retrieved series. Similarly, if the
available data do not extend up to the end date, the most recent data point
is used as the end.
4 August 2003
Topic
Recommendation
FRQ
FRQ enables you to support all data frequencies supported in the historical
datafeed.
Use EVENTS:i
NULL:SKIP instead of
NBEVENTS:i
NULL:SKIP
IlbMode
IlbMode is used as argument in functions of the Adfin Bonds module to define the calculation mode.
IlbMode is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
Keyword
Explanation
CF
CMP
4 August 2003
335
IlbMode
336
Keyword
Explanation
EY
IAY
ICF
LAY
PX
4 August 2003
Keyword
Explanation
YCM
Yield calculation method {00, A0, A0D, A25D, A5, A5D, AA, E0}
YCM:00 for 30/360
YCM:A0 for Actual/360
YCM:A0D for Actual/360 (day-based)
YCM:A25D for Actual/365.25 (day-based)
YCM:A5 for Actual/365
YCM:A5D for Actual/365 (day-based)
YCM:AA for Actual/Actual
YCM:E0 for 30E/360 ISMA
Default value: YCM:AA
RET
Return value parameter to shorten or lengthen the array of data returned by array
functions {Ai, Bi, i with i as integer}
RET:Ai with i from 1 to ArraySize to get the array of the i first elements (values only)
RET:Bi with i from 1 to ArraySize to get the array of the i first elements along with
their names (header and values)
RET:i with i from 1 to ArraySize to get the i-th element only
IlbStructure
IlbStructure is used as argument in functions of the Adfin Bonds module to define the structure of
an index-linked bond.
IlbStructure is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
4 August 2003
337
IlbStructure
Structure
338
Keyword
Explanation
ACC
Accrued interest calculation method {{00, A0, A5, AA, E0, IT, IT2, JAP, MMA0, MMA5,
MMNL5, NL0, NL5, W252} with {:SSD} optional for each value }
ACC:00 for 30/360
ACC:A0 for Actual/360
ACC:A5 for Actual/365
ACC:AA for Actual/Actual
ACC:E0 for 30E/360
ACC:IT for Italian (from last coupon date to settlement date in E0 + 1 day)
ACC:IT2 for Italian modified (from last coupon date to settlement date + 1 day in E0)
ACC:JAP for Japanese (A5 or A5 + 1 day for first coupon)
ACC:MMA0 for money market Actual/360
ACC:MMA5 for money market Actual/365
ACC:MMNL5 for money market Actual No Leap/365
ACC:NL0 for Actual No Leap/360
ACC:NL5 for Actual No Leap/365
ACC:W252 for Actual Working days/252
ACC:i:SSD for German Schuldscheindarlehen bonds where i is {00, A0, A5, AA, E0, IT,
IT2, JAP, MMA0, MMA5, MMNL5, NL0, NL5, W252}
Default value: ACC:AA
ARND
Rounding mode of the accrued interest {NO} or {i (where i is numeric) : {UP, DOWN,
NEAR}}
ARND:NO if no rounding is requested
ARND:i:{UP,DOWN,NEAR} for rounding to the precision defined by i
Default value: ARND:NO if no rounding is requested
ARND:i:NEAR if i is specified
BRI
4 August 2003
Keyword
Explanation
CCM
Coupon calculation method {BB00, BBA0, BBA5, BBAA, BBE0, MM00, MMA0, MMA5, MMAA,
MME0, MMNL0, MMNL5, 00D, A0D, A5D, E0D, 00, A0, A5, AA, E0}
CCM:BB00 for bond 30/360
CCM:BBA0 for bond Actual/360
CCM:BBA5 for bond Actual/365
CCM:BBAA for bond Actual/Actual
CCM:BBE0 for bond 30E/360 ISMA
CCM:MM00 for money market 00/360
CCM:MMA5 for money market Actual/365
CCM:MMA0 for money market Actual/360
CCM:MMAA for money market Actual/Actual
CCM:MME0 for money market 30E/360
CCM:MMNL0 for money market Actual No Leap/360
CCM:MMNL5 for money market Actual No Leap/365
CCM:00D for effective 30/360 (day-based)
CCM:A0D for effective Actual/360 (day-based)
CCM:A5D for effective Actual/365 (day-based)
CCM:E0D for effective 30E/360 (day-based)
CCM:00 for effective 30/360 (period-based)
CCM:A0 for effective Actual/360 (period-based)
CCM:A5 for effective Actual/365 (period-based)
CCM:AA for effective Actual/Actual (period-based)
CCM:E0 for effective 30E/360 (period-based)
CFADJ
CLDR
CRND
Coupon rounding tick size {NO} or {i (where i is numeric) : {UP, DOWN, NEAR}}
CRND:NO if no rounding is requested.
CRND:i:{UP,DOWN,NEAR} for rounding to the precision defined by i
Default value: CRND:NO
4 August 2003
339
IlbStructure
340
Keyword
Explanation
DATED
EMC
FRCD
First Regular Coupon Date for odd first coupon {DDMMMYY} (see the Notes section
below)
FRCD:DDMMMYY where DDMMMYY is the first regular coupon date
Default value: No first regular coupon date is defined
FRQ
Frequency of the coupon payments {i {28D, 91D, 182D,364D, 1, 2, 4, 12}} (see the
Notes section below)
FRQ:28D to define a coupon payment every 28 days from the maturity date
FRQ:91D to define a coupon payment every 91 days from the maturity date
FRQ:182D to define a coupon payment every 182 days from the maturity date
FRQ:364D to define a coupon payment every 364 days from the maturity date
FRQ:1 to define an annual coupon payment from the maturity date
FRQ:2 to define a semi-annual coupon payment from the maturity date
FRQ:4 to define a quarterly coupon payment from the maturity date
FRQ:12 to define a monthly coupon payment from the maturity date
FRQ:DDMMMYY:i to define a frequency of i from date DDMMMYY
Default value: FRQ:1
4 August 2003
Keyword
Explanation
IC
Irregular first coupon {L1, L1R, S1, S1P, S1R, NBC} (see the Notes section below)
(the bond issue date must also be specified using ISSUE or DATED)
IC:L1 for long first coupon (first coupon date equal to the second anniversary date)
IC:L1R for long first coupon with regular nominal value and starting accrued date
equal to the first anniversary date (SPGB)
IC:S1 for short first coupon (first coupon date equal to the first anniversary date)
IC:S1P for short first coupon with proportional value (BTAN)
IC:S1R for short first coupon with regular nominal value
IC:NBC for NBC first coupon
Default value: IC:S1
ICF
ICM
Daily inflation reference and coupon calculation method {AUS , INTERP, PREVIOUS}
ICM:AUS for Australian index-linked bonds
ICM:INTERP for Canadian, French, Swedish and US index-linked bonds
ICM:PREVIOUS for UK index-linked bonds
Default value: ICM:INTERP
IDX
INTCAP
4 August 2003
341
IlbStructure
342
Keyword
Explanation
IRND
ISSUE
LBM
LRCD
Last regular coupon date for odd last coupon {DDMMMYY, JGB}
LRCD:DDMMMYY where DDMMMYY is the last regular coupon date
LRCD:JGB to automatically handle odd last coupons for JGBs
Default value: All coupons are regular so LRCD has no meaning
NC
MDADJ
NOTIONAL
PRG
4 August 2003
Reuters
PowerPlus Pro
4.0
Keyword
Explanation
PXRND
Rounding mode of the output price {NO} or {i (where i is numeric) : {UP, DOWN, NEAR}}
PXRND:NO if no rounding is requested.
PXRND:i:{UP,DOWN,NEAR} for rounding to the precision defined by i
Default value: PXRND:NO if no rounding is requested
PXRND:i:NEAR if i is specified
REFDATE
RP
XD
Ex-dividend calculation {no value, NO, YES, iD, iWD, AUT, DEN}
XD or XD:YES to force ex-dividend calculations (exclude the right to the next coupon)
XD:NO to force cum-dividend calculations (grant the right to the next coupon)
XD:iD for an ex-dividend period of i calendar days
XD:iWD for an ex-dividend period of i working days
XD:AUT for the Austrian ex-dividend period
XD:DEN for the Dane ex-dividend period
Default value: XD:0
To match results in Reuters PowerPlus Pro 4.0, you must use the following default configurations
Is NOTIONAL used?
YES
NO
NO
YES
NO
NO
YES
NO
NO
C or S
YES
4 August 2003
343
IndexHistoryStructure
IndexHistoryStructure
IndexHistoryStructure is used as argument in the AdStyleSet function of the Adfin Common
module. It defines the underlying structure of index history styles.
IndexHistoryStructure is a string consisting of a series of parameters. Each set of parameters
consists of a keyword, a colon (:), and the value of the keyword. The parameter sets are separated
by a blank space. However, certain keywords are used on their own and do not require a value. A
keyword can also have several values, all separated by colons.
Structure
Default Value
344
Keyword
Explanation
AVG
PERIOD
RND
RIC
YB
4 August 2003
InterpMode
InterpMode is used as argument in functions of the Adfin Common module to define the
interpolation mode.
InterpMode is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
Keyword
Explanation
IM
LAY
ND
OBC
4 August 2003
345
IrsStructure
IrsStructure
IrsStructure is used as argument in functions of the Adfin Swaps module to define the structure of
Structure
346
Keyword
Explanation
ACC
Accrued interest calculation method {{00, A0, A5, AA, BB00, BBA5, BBW252, E0, IT, IT2,
JAP, MMA0, MMA5, MMNL5, NL0, NL5, W252} with {:SSD} optional for each value}
ACC:00 for 30/360
ACC:A0 for Actual/360
ACC:A5 for Actual/365
ACC:AA for Actual/Actual
ACC:BB00 for Brazilian 30/360
ACC:BBA5 for Brazilian Actual/365
ACC:BBW252 for Brazilian Actual Working days/252
ACC:E0 for 30E/360
ACC:IT for Italian (from last coupon date to settlement date in E0 + 1 day)
ACC:IT2 for Italian modified (from last coupon date to settlement date + 1 day in E0)
ACC:JAP for Japanese (A5 or A5 + 1 day for first coupon)
ACC:MMA0 for money market Actual/360
ACC:MMA5 for money market Actual/365
ACC:MMNL5 for money market Actual No Leap/365
ACC:NL0 for Actual No Leap/360
ACC:NL5 for Actual No Leap/365
ACC:W252 for Actual Working days/252
ACC:i:SSD for German Schuldscheindarlehen asset swaps where i is {00, A0, A5, AA,
BB00, BBA5, BBW252, E0, IT, IT2, JAP, MMA0, MMA5, MMNL5, NL0, NL5, W252}
Default value: ACC:AA
AMORT
4 August 2003
Keyword
Explanation
ARND
Rounding mode of the accrued interest {NO} or {i (where i is numeric) : {UP, DOWN,
NEAR}}
ARND:NO if no rounding is requested
ARND:i:{UP,DOWN,NEAR} for rounding to the precision defined by i
Default value: ARND:NO if no rounding is specified
ARND:i:NEAR if i is specified
CCM
Coupon calculation method {BB00, BBA0, BBA5, BBAA, BBE0, MM00, MMA0, MMA5, MMAA,
MME0, MMNL0, MMNL5, 00D, A0D, A5D, E0D, 00, A0, A5, AA, E0}
CCM:BB00 for bond 30/360
CCM:BBA0 for bond Actual/360
CCM:BBA5 for bond Actual/365
CCM:BBAA for bond Actual/Actual
CCM:BBE0 for bond 30E/360 ISMA
CCM:MM00 for money market 00/360
CCM:MMA5 for money market Actual/365
CCM:MMA0 for money market Actual/360
CCM:MMAA for money market Actual/Actual
CCM:MME0 for money market 30E/360
CCM:MMNL0 for money market Actual No Leap/360
CCM:MMNL5 for money market Actual No Leap/365
CCM:00D for effective 30/360 (day-based)
CCM:A0D for effective Actual/360 (day-based)
CCM:A5D for effective Actual/365 (day-based)
CCM:E0D for effective 30E/360 (day-based)
CCM:00 for effective 30/360 (period-based)
CCM:A0 for effective Actual/360 (period-based)
CCM:A5 for effective Actual/365 (period-based)
CCM:AA for effective Actual/Actual (period-based)
CCM:E0 for effective 30E/360 (period-based)
Default value: CCM:BBE0 for the fixed leg, or CCM:MMA0 for the floating leg
CFADJ
4 August 2003
347
IrsStructure
348
Keyword
Explanation
CLDR
CRND
DATED
Dated date for asset swaps combined with bonds with an irregular first coupon
{DDMMMYY}
DATED:DDMMMYY where DDMMMYY is the accrual start date for irregular coupons)
Default value: The dated date for the fixed leg is the start date of the swap
DMC
Date moving convention used when a calculated date falls on a non-working day {F,
FOL, M, MOD, N, NONE, P, PRE}
DMC:F or DMC:FOL for moving the date to the following working day
DMC:M or DMC:MOD for moving the date to the following working day unless it causes
the date to be pushed into the next month (in this latter case, the last working day of
the month is used)
DMC:N or DMC:NONE for no moving
DMC:P or DMC:PRE for moving the date to the preceding working day
Default value: The value of the DMC keyword of the "IRS" category
EMC
End-of-month convention used when a calculation date falls on the last day of a
month {L, LAST, S, SAME}
EMC:L or EMC:LAST for setting the calculated date to the last working day
EMC:S or EMC:SAME for setting the calculated date to the same day (in this latter case,
the date may be moved according to the date moving convention if it is a non-working
day)
Default value: The value of the EMC keyword of the "IRS" category
FAD
FCV
4 August 2003
Keyword
Explanation
FRCD
FRQ
IC
IDX
LBOTH
LFIXED
4 August 2003
349
IrsStructure
350
Keyword
Explanation
LFLOAT
LRCD
Last regular coupon date for odd last coupon {DDMMMYY, JGB}
LRCD:DDMMMYY where DDMMMYY is the last regular coupon date
LRCD:JGB to handle automatically odd last coupons for JGBs
Default value: All coupons are regular so LRCD has no meaning
MDADJ
NOTIONAL
PAID
PDELAY
PPMT
4 August 2003
Keyword
Explanation
REFDATE
RP
RT
Reimbursement type {B, C{:i}, Sj{:i} where i is numeric (1=100%) and j from 1 to 8,
P}
RT:B for bullet or in fine
RT:C for constant payments
RT:C:i for constant payments equal to i except for the last cash flow which is
adjusted
RT:Sj for j series
RT:Sj:i for j series and constant payments equal to i except for the last cash flow
which is adjusted
Default value: RT:B
SPREAD
Spread {DDMMMYY:i}
SPREAD:DDMMMYY:i for a spread of i applicable to the floating rate as of DDMMMYY
Ex-dividend calculation {no value, NO, YES, iD, iWD, AUT, DEN}
XD or XD:YES to force ex-dividend calculations (exclude the right to the next coupon)
XD:NO to force cum-dividend calculations (grant the right to the next coupon)
XD:iD for an ex-dividend period of i calendar days
XD:iWD for an ex-dividend period of i working days
XD:AUT for the Austrian ex-dividend period
XD:DEN for the Dane ex-dividend period
Default value: XD:0
OpMode
OpMode is used as argument in functions of the Adfin Options module to customize returned values.
4 August 2003
351
OpMode
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
352
Keyword
Explanation
FRQ
HVM
LAY
Layout parameter for the input array(s) orientation {H, HOR, V, VER}
LAY:H or LAY:HOR for horizontal orientation
LAY:V or LAY:VER for vertical orientation
Default value: LAY:V
4 August 2003
Examples
Keyword
Explanation
RES
Expected result {D, DELTA, FDELTA, FRHO, FTHETA, FVEGA, G, GAMMA, R, RHO, T, THETA, V,
VEGA}
RES:D or RES:DELTA to calculate the delta ratio (sensitivity of the premium to the
change of the underlying price)
RES:G or RES:GAMMA to calculate the gamma ratio (sensitivity of the delta ratio to the
change of the underlying price)
RES:FDELTA to calculate the delta ratio in the foreign currency (for currency options)
RES:FRHO to calculate the rho ratio in the foreign currency (for currency options)
RES:FTHETA to calculate the theta ratio in the foreign currency (for currency options)
RES:FVEGA to calculate the vega ratio in the foreign currency (for currency options)
RES:R or RES:RHO to calculate the rho ratio (sensitivity of the premium to the market
interest rates)
RES:T or RES:THETA to calculate the theta ratio (sensitivity of the premium to the
reduction of the option remaining life)
RES:V or RES:VEGA to calculate the vega ratio (sensitivity of the premium to the
underlying volatility)
Default value: No default value is defined
RET
Return value parameter to shorten or lengthen the array of data returned by array
functions {Ai, Bi, i with i as integer}
RET:Ai with i from 1 to ArraySize to get the array of the i first elements (values only)
RET:Bi with i from 1 to ArraySize to get the array of the i first elements along with
their names (header and values)
RET:i with i from 1 to ArraySize to get the i-th element only
Default value: No default value is defined
YB
"FRQ:W HVM:HL" Calculates the historical volatility from weekly high and low prices.
"LAY:H" Allows the use of a horizontal array for an array input parameter.
4 August 2003
353
OptionStructure
OptionStructure
OptionStructure is used as argument in functions of the Adfin Options module to define the
of a keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
Keyword
Explanation
CALL
CAP
CLDR
Calendar parameter for expiry date and dividend date adjustments {calendars}
CLDR:calendars to assign one or more calendars used for moving dividend dates if
they fall on non-working days (see DMC and example below)
Default value: No dividend adjustment is made (calendar NULL)
Default value: 1
354
4 August 2003
Keyword
Explanation
DCB
Day count basis {00, A0, A0D, A25D, A5, A5D, AA, E0, JAP, NL0, NL5, W252} (see the Notes
section below)
DCB:00 for 30/360 (period-based calculation)
DCB:A0 for Actual/360 (period-based calculation)
DCB:A0D for Actual/360 (day-based calculation)
DCB:A25D for Actual/365.25 (day-based calculation)
DCB:A5 for Actual/365 (period-based calculation)
DCB:A5D for Actual/365 (day-based calculation)
DCB:AA for Actual/Actual (period-based calculation)
DCB:E0 for 30E/360 (period-based calculation)
DCB:JAP for Japanese (A5 or A5 + 1 day for first coupon)
DCB:NL0 for Actual No Leap/360
DCB:NL5 for Actual No Leap/365
DCB:W252 for Actual Working days/252
Default value: No
DELIV
DILUTION
DIV
4 August 2003
355
OptionStructure
Keyword
Explanation
DIVTYPE
Dividend type {CONT, DISC, FIXED, PROP} (see the Notes section below)
DIVTYPE:CONT for continuous dividends
DIVTYPE:DISC for discounted dividends
DIVTYPE:FIXED for fixed dividends
DIVTYPE:PROP for proportional dividends
Default value: DIVTYPE:CONT
DMC
Date moving convention used when an expiry date or a dividend date falls on a
non-working day {F, FOL, M, MOD, N, NONE, P, PRE}
DMC:F or DMC:FOL to move the date to the following working day
DMC:M or DMC:MOD to move the date to the following working day unless it causes the
date to be pushed into the next month (in this latter case, the last working day of the
month is used)
DMC:N or DMC:NONE for no moving
DMC:P or DMC:PRE for moving the date to the preceding working day
Default value: DMC:NO
EXM
Exercise mode {A, AMER, AMERICAN, :DDMMMYY{:DDMMMYY{:i}} E, EUR, EURO} (see the
Notes section below)
EXM:A, EXM:AMER, or EXM:AMERICAN to specify a Vanilla option with an American mode
EXM:DDMMMYY or EXM:DDMMMYY:DDMMMYY to specify a Vanilla option with a Bermudan
mode
EXM:DDMMMYY:DDMMMYY:i to specify a Vanilla option or warrant with variable strike
price i
EXM:E, EXM:EUR, or EXM:EURO to specify a European option
Default value: EXM:EURO
NBSTOCK
356
4 August 2003
Keyword
Explanation
RATEFRQ
Compounding frequency parameter {1, 12, 28D, 182D, 2, 28D, 182D, 364D, 4, 91D, M, Q,
S, Y, ZERO} (see the Notes section below)
RATEFRQ:1 or RATEFRQ:Y for yearly
RATEFRQ:12 or RATEFRQ:M for monthly
RATEFRQ:182D for compounding every 182 days
RATEFRQ:2 or RATEFRQ:S for semi-annual
RATEFRQ:28D for compounding every 28 days
RATEFRQ:182D for compounding every 182 days
RATEFRQ:364D for compounding every 364 days
RATEFRQ:4 or RATEFRQ:Q for quarterly
RATEFRQ:91D for compounding every 91 days
RATEFRQ:ZERO no compounding
Default value: RATEFRQ:YEARLY or RATEFRQ:1
RATETYPE
Yield type {CONT, DISC, MM, MMB, MMM, MMP, TRE, SIMPLEJAP, CMPJAP} (see the Notes
section below)
RATETYPE:CONT for continuous yield/rate
RATETYPE:DISC for discounted yield/rate
RATETYPE:MM for Money Market yield/rate
RATETYPE:MMB for Money Market Bullet
RATETYPE:MMM for Money Market Medium
RATETYPE:MMP for Money Market Proceed
RATETYPE:MMR for Money Market Direct Discounting
RATETYPE:TRE for US bills Treasury
RATETYPE:SIMPLEJAP for simple yield/rate
RATETYPE:CMPJAP for compounded yield/rate
Default value: RATETYPE:CONT
SPOT
4 August 2003
357
ParseMode
Keyword
Explanation
UI
Underlying asset type {COM, CUR, FUT, SEC} (see the Notes section below)
UI:COM for an option on commodities
UI:CUR for an option on currencies
UI:FUT for an option on futures
UI:SEC for an option on securities (indexes, stocks, bonds)
Default value: UI:SEC
ParseMode
ParseMode is used as argument in functions of the Adfin Common module to define the parsing
mode.
ParseMode is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
358
Keyword
Explanation
FD
LAY
LEN
4 August 2003
Example
Keyword
Explanation
Parsing data format when using PDT:FXSWP {AB, AUTO, BA, ONE}
PDF:AB to control that the data is displayed using the Ask/Bid format
PDF:AUTO to adapt the Bid/Ask formatted data to have Bid<Ask
PDF:BA to control that the data is displayed using the Bid/Ask format
PDF:ONE to control that there is a unique data
Default value: PDF:AUTO
PDT
POS
PDF:AB PDT:FXSWP defines the data to parse as a currency swap point displayed in the Ask/Bid
format.
RateMode
RateMode is used as argument in functions of the Adfin TermStructure module to customize returned
values.
RateMode is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
4 August 2003
359
RateMode
Structure
360
Keyword
Explanation
BWB
FROM
Type of the input rate for AdRateConv {00, A0, A0D, A25D, A5, A5D, AA, CONT, DAYA0,
DAYA5, DISCA0, DISCA5, DF, E0, IAM, MMA0, MMA5}
FROM:00 for 30/360
FROM:A0 for Actual/360
FROM:A0D for Actual/360 (daily compounding)
FROM:A25D for Actual/365.25 (daily compounding)
FROM:A5 for Actual/365
FROM:A5D for Actual/365 (daily compounding)
FROM:AA for Actual/Actual
FROM:CONT for continuous
FROM:DAYA0 for daily Actual/360
FROM:DAYA5 for daily Actual/365
FROM:DISCA0 for discount Actual/360
FROM:DISCA5 for discount Actual/365
FROM:DF for discount factor
FROM:E0 for 30E/360 ISMA
FROM:IAM for interest at maturity
FROM:MMA0 for money market Actual/360
FROM:MMA5 for money market Actual/365
Default value: No default value is defined, mandatory keyword
LAY
OFFSET
4 August 2003
Keyword
Explanation
R1
Type of the first rate for AdDepToFra or AdDepToFraBA {00, A0, A0D, A25D, A5, A5D, AA,
CONT, DAYA0, DAYA5, DISCA0, DISCA5, DF, E0,IAM, MMA0, MMA5}
R1:00 for 30/360
R1:A0 for Actual/360
R1:A0D for Actual/360 (daily compounding)
R1:A25D for Actual/365.25 (daily compounding)
R1:A5 for Actual/365
R1:A5D for Actual/365 (daily compounding)
R1:AA for Actual/Actual
R1:CONT for continuous
R1:DAYA0 for daily Actual/360
R1:DAYA5 for daily Actual/365
R1:DISCA0 for discount Actual/360
R1:DISCA5 for discount Actual/365
R1:DF for discount factor
R1:E0 for 30E/360 ISMA
R1:IAM for interest at maturity
R1:MMA0 for money market Actual/360
R1:MMA5 for money market Actual/365
Default value: No default value is defined
4 August 2003
361
RateMode
362
Keyword
Explanation
R2
Type of the calculated rate for AdDepToFra or AdDepToFraBA {00, A0, A0D, A25D, A5,
A5D, AA, CONT, DAYA0, DAYA5, DISCA0, DISCA5, DF, E0, IAM, MMA0, MMA5}
R2:00 for 30/360
R2:A0 for Actual/360
R2:A0D for Actual/360 (daily compounding)
R2:A25D for Actual/365.25 (daily compounding)
R2:A5 for Actual/365
R2:A5D for Actual/365 (daily compounding)
R2:AA for Actual/Actual
R2:CONT for continuous
R2:DAYA0 for daily Actual/360
R2:DAYA5 for daily Actual/365
R2:DISCA0 for discount Actual/360
R2:DISCA5 for discount Actual/365
R2:DF for discount factor
R2:E0 for 30E/360 ISMA
R2:IAM for interest at maturity
R2:MMA0 for money market Actual/360
R2:MMA5 for money market Actual/365
Default value: No default value is defined
4 August 2003
Keyword
Explanation
R3
Type of the second rate for AdDepToFra or AdDepToFraBA {00, A0, A0D, A25D, A5, A5D,
AA, CONT, DAYA0, DAYA5, DISCA0, DISCA5, DF, E0, IAM, MMA0, MMA5}
R3:00 for 30/360
R3:A0 for Actual/360
R3:A0D for Actual/360 (daily compounding)
R3:A25D for Actual/365.25 (daily compounding)
R3:A5 for Actual/365
R3:A5D for Actual/365 (daily compounding)
R3:AA for Actual/Actual
R3:CONT for continuous
R3:DAYA0 for daily Actual/360
R3:DAYA5 for daily Actual/365
R3:DISCA0 for discount Actual/360
R3:DISCA5 for discount Actual/365
R3:DF for discount factor
R3:E0 for 30E/360 ISMA
R3:IAM for interest at maturity
R3:MMA0 for money market Actual/360
R3:MMA5 for money market Actual/365
Default value: No default value is defined
4 August 2003
363
RateMode
364
Keyword
Explanation
RATES
Type of all rates for AdDepToFra or AdDepToFraBA {00, A0, A0D, A25D, A5, A5D, AA, CONT,
DAYA0, DAYA5, DISCA0, DISCA5, DF, E0, IAM, MMA0, MMA5}
RATES:00 for 30/360
RATES:A0 for Actual/360
RATES:A0D for Actual/360 (daily compounding)
RATES:A25D for Actual/365.25 (daily compounding)
RATES:A5 for Actual/365
RATES:A5D for Actual/365 (daily compounding)
RATES:AA for Actual/Actual
RATES:CONT for continuous
RATES:DAYA0 for daily Actual/360
RATES:DAYA5 for daily Actual/365
RATES:DISCA0 for discount Actual/360
RATES:DISCA5 for discount Actual/365
RATES:DF for discount factor
RATES:E0 for 30E/360 ISMA
RATES:IAM for interest at maturity
RATES:MMA0 for money market Actual/360
RATES:MMA5 for money market Actual/365
Default value: No default value is defined
4 August 2003
Keyword
Explanation
TO
Type of the output rate for AdRateConv {00, A0, A0D, A25D, A5, A5D, AA, CONT, DAYA0,
DAYA5, DISCA0, DISCA5, DF, E0, IAM, MMA0, MMA5}
TO:00 for 30/360
TO:A0 for Actual/360
TO:A0D for Actual/360 (daily compounding)
TO:A25D for Actual/365.25 (daily compounding)
TO:A5 for Actual/365
TO:A5D for Actual/365 (daily compounding)
TO:AA for Actual/Actual
TO:CONT for continuous
TO:DAYA0 for daily Actual/360
TO:DAYA5 for daily Actual/365
TO:DISCA0 for discount Actual/360
TO:DISCA5 for discount Actual/365
TO:DF for discount factor
TO:E0 for 30E/360 ISMA
TO:IAM for interest at maturity
TO:MMA0 for money market Actual/360
TO:MMA5 for money market Actual/365
Default value: No default value is defined, mandatory keyword
RateStructure
RateMode is used as argument in Adfin Analytics functions to define the rate model for pricing
instruments.
RateMode is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
4 August 2003
365
RateStructure
Structure
Keyword
Explanation
CLDRADJ
Cash flow date adjustment according to a calendar {NO, NULL, WE, CLDR}
CLDRADJ:NO for analytic pricing (i.e. from the bond structure)
CLDRADJ:NULL for cash flow pricing using the calendar NULL
CLDRADJ:WEEKEND for cash flow pricing using the calendar WEEKEND
CLDRADJ:CLDR for cash flow pricing using the calendar defined by the keyword CLDR (if
no calendar is defined, CLDRADJ:WEEKEND is used)
Default value: The value of the CLDRADJ keyword of the "RATEMODEL" category
CURVESHIFT Specifies the shift value {i, where i is a float expressed as real value} (see the Notes
section below)
CURVESHIFT:i means that a shift of i applies to the yield curve
366
Day count basis {00, 05, A0, A0D, A25D, A5, A5D, AA, E0, JAP, NL0, NL5, W252} (see the
Notes section below)
DCB:00 for 30/360 (period-based calculation)
DCB:05 for 30/365 (period-base calculation)
DCB:A0 for Actual/360 (period-based calculation)
DCB:A0D for Actual/360 (day-based calculation)
DCB:A25D for Actual/365.25 (day-based calculation)
DCB:A5 for Actual/365 (period-based calculation)
DCB:A5D for Actual/365 (day-based calculation)
DCB:AA for Actual/Actual (period-based calculation)
DCB:E0 for 30E/360 (period-based calculation)
DCB:JAP for Japanese (A5 or A5 + 1 day for first coupon)
DCB:NL0 for Actual No Leap/360
DCB:NL5 for Actual No Leap/365
DCB:W252 for Actual Working days/252
Default value: The value of the DCB keyword of the "RATEMODEL" category
4 August 2003
Keyword
Explanation
EY
Equivalent yield parameter {1, 12, 180D5, 182D, 2, 28D, 364D, 4, 91D, M, Q, S, Y, FRQ}
EY:1 or EY:Y for yearly
EY:12 or EY:M for monthly
EY:180D5 for compounding every 180 days on a 365 year basis
EY:182D for compounding every 182 days
EY:2 or EY:S for semi-annual
EY:28D for compounding every 28 days
EY:364D for compounding every 364 days
EY:4 or EY:Q for quarterly
EY:91D for compounding every 91 days
EY:FRQ for compounding defined by the FRQ keyword in the BondStructure
Default value: The value of the EY keyword of the "RATEMODEL" category
IM
IMVOL
4 August 2003
367
RateStructure
368
Keyword
Explanation
LLP
Linear last periods parameter {00{:i}, A0{:i}, A5{:i}, AA{:i}, E0{:i}, NO, with i as
integer OR as EY {Y, M, 182D, S, 28D, 364D, Q, 91D}}
LLP:00 for 30/360 for the last period only
LLP:00:i for 30/360 for the i last periods
LLP:00:{Y, M, 182D, S, 28D, 364D, Q, 91D} for 30/360 for a last period of the specified
length
LLP:A0 for Actual/360 for the last period only
LLP:A0:i for Actual/360 for the i last periods
LLP:A0:{Y, M, 182D, S, 28D, 364D, Q, 91D} for Actual/360 for a last period of the
specified length
LLP:A5 for Actual/365 for the last period only
LLP:A5:i for Actual/365 for the i last periods
LLP:A5:{Y, M, 182D, S, 28D, 364D, Q, 91D} for Actual/360 for a last period of the
specified length
LLP:AA for Actual/Actual for the last period only
LLP:AA:i for Actual/Actual for the i last periods
LLP:AA:{Y, M, 182D, S, 28D, 364D, Q, 91D} for Actual/Actual for a last period of the
specified length
LLP:E0 for 30E/360 for the last period only
LLP:E0:i for 30E/360 for the i last periods
LLP:E0:{Y, M, 182D, S, 28D, 364D, Q, 91D} for 30E/360 a last period of the specified
length
LLP:NO for defining no special processing of the last period(s)
Default value: LLP:NO
MDWA
Specifies the type of minimization of residual errors in the Vasicek-Fong model and
basis-spline model, using AdTermStructure {YES, NO}
MDWA:YES to minimize errors between model and market prices weighted by the
inverse of the bond volatility
MDWA:NO to minimize errors between model and market prices
Default value: MDWA:NO
NBKNOT
Number of knots you can choose to build the yield curve when using the basis-spline
models (i with i as an integer)
NBKNOT:i, where 2<= i <= number of distinct input maturities
Default value: NBKNOT:(N/3)+2, where N is the number of distinct input maturities
4 August 2003
Keyword
Explanation
ND
OBC
RATEFRQ
Compounding frequency parameter {1, 12, 28D, 2, 28D, 180D5, 182D, 364D, 4, 91D, M,
Q, S, Y, ZERO, EY, FRQ} (see the Notes section below)
RATEFRQ:1 or RATEFRQ:Y for yearly
RATEFRQ:12 or RATEFRQ:M for monthly
RATEFRQ:2 or RATEFRQ:S for semi-annual
RATEFRQ:28D for compounding every 28 days
RATEFRQ:180D5 for compounding every 180 days on a 365 year basis
RATEFRQ:182D for compounding every 182 days
RATEFRQ:364D for compounding every 364 days
RATEFRQ:4 or RATEFRQ:Q for quarterly
RATEFRQ:91D for compounding every 91 days
RATEFRQ:ZERO no compounding
RATEFRQ:EY for compounding defined by the EY keyword
RATEFRQ:FRQ for compounding defined by the FRQ keyword in the BondStructure
Default value: The value of the RATEFRQ keyword of the "RATEMODEL" category
4 August 2003
369
RateStructure
370
Keyword
Explanation
RATETYPE
Yield type {CMP, CONT, DISC, MM, MMB, MMM, MMP, TRE, SIMPLEJAP, CMPJAP} (see the Notes
section below)
RATETYPE:CMP for Actual
RATETYPE:CONT for continuous yield/rate
RATETYPE:DISC for discounted yield/rate
RATETYPE:MM for Money Market yield/rate
RATETYPE:MMB specified when using the Money Market Bullet pricing method
RATETYPE:MMM specified when using the Money Market Medium pricing method
RATETYPE:MMP specified when using the Money Market Proceeds pricing method
RATETYPE:MMR specified when using the Money Market Direct Discounting pricing
method
RATETYPE:TRE for US Bills Treasury
RATETYPE:SIMPLEJAP for simple yield/rate
RATETYPE:CMPJAP for compounded yield/rate
Default value: RATETYPE:CMP
RM
Rate model {YC, YTA, YTB, YTW, YTM, HW, VF, BDT, BS, BSPLINE} (see the Notes section
below)
RM:YC for Yield Curve
RM:YTA to adapt the calculation of the yield to the bond structure
RM:YTB for Yield To Best
RM:YTW for Yield To Worst
RM:YTM for Yield To Maturity
RM:HW for Hull and White model
RM:VF for Vasicek-Fong model
RM:BDT for Black, Derman, and Toy model
RM:BS for Black and Scholes model
RM:BSPLINE for basis-spline models
Default value: RM:YTA
SMOOTH
4 August 2003
Keyword
Explanation
VFALPHA
Alpha coefficient you can specify in the Vasicek-Fong model using AdTermStructure
{i (where i is a float)}
VFALPHA:i to specify the coefficient value
Default value: No default value
VOLTYPE
Volatility type used in the dynamic model {ZC, SR} (see the Notes section below)
VOLTYPE:ZC for Zero Coupon yield volatility
VOLTYPE:SR for short rates volatility
Default value: VOLTYPE:SR
ZCTYPE
RepoMode
RepoMode is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
Keyword
Explanation
CF
Specifies the repo cash flows adjustment {CLDR, NO, YES, WE}
CF:CLDR to correct cash flow dates using holidays from the calendar defined with
CLDR (if no calendar is defined, CLDR:WEEKEND is used)
CF:NO to perform the calculation using the bond structure only
CF:YES and CF:WE to correct cash flow dates using weekends
Default value: No default value is defined
4 August 2003
371
RepoMode
372
Keyword
Explanation
CIR
Intermediary coupons reinvestment rate {i:00, i:A0, i:A0D, i:A25D, i:A5, i:A5D,
i:AA, i:BFM, i:E0, i:MMBA0, i:MMBA5, i:MMMA0, i:MMMA5, i:MMPA0, i:MMPA5, where
i is numeric (1=100%)}
CIR:i:00 for a bond 30/360 rate equal to i
CIR:i:A0 for a bond Actual/360 rate equal to i
CIR:i:A0D for a bond Actual/360 (day-based) rate equal to i
CIR:i:A25D for a bond Actual/365.25 (day-based) rate equal to i
CIR:i:A5 for a bond Actual/365 rate equal to i
CIR:i:A5D for a bond Actual/365 (day-based) rate equal to i
CIR:i:AA for a bond Actual/Actual rate equal to i
CIR:i:BFM for a Braess/Fangmeyer rate equal to i
CIR:i:E0 for a bond 30E/360 ISMA rate equal to i
CIR:i:MMBA0 for a money market bullet Actual/360 rate equal to i
CIR:i:MMBA5 for a money market bullet Actual/365 rate equal to i
CIR:i:MMMA0 for a money market medium term CD Actual/360 rate equal to i
CIR:i:MMMA5 for a money market medium term CD Actual/365 rate equal to i
CIR:i:MMPA0 for a money market proceeds Actual/360 rate equal to i
CIR:i:MMPA5 for a money market proceeds Actual/365 rate equal to i
Default value: Intermediary coupons are reinvested at the repo rate
CLDR
FV
NPV
4 August 2003
Keyword
Explanation
RES
RPFV
RPNPV
RR
Repo rate type {00, A0, A0D, A25D, A5, A5D, AA, E0, MMBA0, MMBA5, MMMA0, MMMA5,
MMPA0, MMPA5}
RR:00 for bond 30/360
RR:A0 for bond Actual/360
RR:A0D for bond Actual/360 (day-based)
RR:A25D for bond Actual/365.25 (day-based)
RR:A5 for bond Actual/365
RR:A5D for bond Actual/365 (day-based)
RR:AA for bond Actual/Actual
RR:E0 for bond 30E/360 ISMA
RR:MMBA0 for money market bullet Actual/360
RR:MMBA5 for money market bullet Actual/365
RR:MMMA0 for money market medium term CD Actual/360
RR:MMMA5 for money market medium term CD Actual/365
RR:MMPA0 for money market proceeds Actual/360
RR:MMPA5 for money market proceeds Actual/365
Default value: No default value is defined
XDFV
4 August 2003
373
RoundMode
Keyword
Explanation
XDNPV
RoundMode
RoundMode is used as argument in functions of the Adfin Common module to define the rounding
mode.
RoundMode is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
Keyword
Explanation
DOWN
NEAR
UP
RtMode
The RtMode argument is used in Adfin Real Time to define how real time data is retrieved or
contributed.
RtMode is a string made up of a series of parameters, each one consisting of a keyword, an optional
colon (":"), and the value of the parameter. Spaces are used to separate the parameters in the string.
374
4 August 2003
Structure
Keyword
Explanation
CTU
FORMAT
Specifies the format applied to numeric data contributed to a page or a field {i} or
{i:j with i and j as integer}
FORMAT:i for a string of i characters
FORMAT:i:j for a string of i characters and a decimal precision of j digits (1 <= i
<= 325 and 0 <= j <= 15)
Default value: No format is applied
FRQ
Defines the maximum update frequency {iH, iM, iS, with i as integer}
FRQ:iH for i hours
FRQ:iM for i minutes
FRQ:iS for i seconds (minimum is 1S)
Default value: FRQ:30S for RtUpdate
No default value for RtContribute and RtSeries
FTC
Defines the field values to contribute simultaneously {ALL, CHANGED, i-j,k with i,
j and k as integer}
FTC:ALL to contribute all fields each time the function is recalculated
FTC:CHANGED to contribute only the fields that have changed since the last time the
function was recalculated
FTC:i-j,k to contribute fields numbered from i to j and k as well as the field that
changed when the function is recalculated
Default value: FTC:ALL
IGNE
Specifies whether empty records retrieved by #RtChain are ignored {NO, YES}
IGNE:NO to display empty records
IGNE:YES to skip empty records
Default value: IGNE:NO
4 August 2003
375
RtMode
376
Keyword
Explanation
LAY
LIFETIME
Specifies the contribution lifetime for local contributions {ALWAYS, iH, iM, iS, with i
as integer}
LIFETIME:ALWAYS for no limitation
LIFETIME:iH for i hours
LIFETIME:iM for i minutes
LIFETIME:iS for i seconds
Default value: The value defined as Local Contribution Lifetime in Settings
LIVE
Specifies whether the data is maintained in real time, following initial retrieval with
RtUpdate function {NO, YES}
LIVE:NO to get a single snapshot of the data
LIVE:YES to maintain subscriptions open and receive further updates
Default value: LIVE:NO
ONTIME
Specifies the date and time of the snap event {HHMM, DDMMMYY:HHMM}
ONTIME:HHMM indicates that the snap occurs on any date at the time HH:MM
ONTIME:DDMMMYY:HHMM indicates that the snap occurs on the date DDMMMYY at the
time HHMM
Default value: No default value is defined
POS
Specifies the position of the first contributed character for IDN row contribution {i
with i as integer}
POS:i to write the value to the row starting at position i
Default value: POS:1
RET
Specifies the size of the return array of #RtChain and RtSeries {Ai with i as
integer}
RET:Ai to get an array of i rows
Default value: No array size is defined (the output of #RtChain may be
corrupted or may overwrite other data)
4 August 2003
Keyword
Explanation
SCOPE
SKIP
Specifies which records retrieved by #RtChain are ignored {i-j,k with i, j and k
as integer}
SKIP:i-j, k to ignore the records numbered from i to j and k, generally used to
avoid displaying the first ones, which do not describe actual instruments
Default value: No record is skipped
SORT
List sorting order of the time series for RtHistory and RtSeries {ASC, DESC}
SORT:ASC means that the oldest is the first of the list
SORT:DESC means that the most recent is the first of the list
Default value: SORT:DESC
START
TRIM
Specifies the space trimming for string data retrieved by RtGet and RtUpdate
{BOTH, LEFT, RIGHT}
TRIM:BOTH to remove spaces at the beginning and at the end of the text string
TRIM:LEFT to only remove spaces at the beginning of the text string
4 August 2003
377
StirFutStructure
Keyword
TYPE
Explanation
Specifies the type of data retrieved with RtGet and RtUpdate {DATE, LOCAL,
NUM, STRING, TIME}
TYPE:DATE for date
TYPE:LOCAL for data in your local format
TYPE:NUM for numeric
TYPE:STRING for string
TYPE:TIME for time
Default value: The default value depends on the real time platform. In most cases
Adfin Real Time returns the data in the proper type automatically
UPDATE
Defines the condition to trigger the update event {ALWAYS, CHANGED, SNAP,
STOP}
UPDATE:ALWAYS: With RtUpdate: to update the data and/or run the macro
StirFutStructure
StirFutStructure is used as argument in functions of the Adfin Common module to define the
378
4 August 2003
Structure
Keyword
Explanation
CLDR
CRD
CUR
DTM
NBMC
NBMONTH
NBQC
4 August 2003
379
StyleMode
StyleMode
StyleMode is used as argument in functions of the Adfin Common odule to define how a new style is
created or modified. It is also used to retrieve the latest value of an index history style.
StyleMode is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
Keyword
Explanation
LAY
Layout parameter for the input array orientation {H, HOR, V, VER}
LAY:H or LAY:HOR for horizontal orientation
LAY:V or LAY:VER for vertical orientation
Default value: LAY
RET
Return value parameter to shorten or lengthen the array of data returned by array
functions {Ai, i with i as integer}
RET:Ai with i from 1 to ArraySize to get the array of the i first elements (values
only)
RET:i with i from 1 to ArraySize to get the i-th element only
SwapStructure
SwapStructure is used as argument in the AdSwaptionDeriv and AdSwaptionPremium functions to
define the structure of a swap.
SwapStructure is a string consisting of a series of parameters. Each set of parameters consists of a
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
380
4 August 2003
Structure
Keyword
Explanation
ACC
Accrued interest calculation method {{00, A0, A5, AA, BB00, BBA5, BBW252, E0, IT, IT2,
JAP, MMA0, MMA5, MMNL5, NL0, NL5, W252}
ACC:00 for 30/360
ACC:A0 for Actual/360
ACC:A5 for Actual/365
ACC:AA for Actual/Actual
ACC:BB00 for Brazilian 30/360
ACC:BBA5 for Brazilian Actual/365
ACC:BBW252 for Brazilian Actual Working days/252
ACC:E0 for 30E/360
ACC:IT for Italian (from last coupon date to settlement date in E0 + 1 day)
ACC:IT2 for Italian modified (from last coupon date to settlement date + 1 day in E0)
ACC:JAP for Japanese (A5 or A5 + 1 day for first coupon)
ACC:MMA0 for money market Actual/360
ACC:MMA5 for money market Actual/365
ACC:MMNL5 for money market Actual No Leap/365
ACC:NL0 for Actual No Leap/360
ACC:NL5 for Actual No Leap/365
ACC:W252 for Actual Working days/252
Default value: ACC:AA
AMORT
ARND
Rounding mode of the accrued interest {NO} or {i (where i is numeric) : {UP, DOWN,
NEAR}}
ARND:NO if no rounding is requested
ARND:i:{UP,DOWN,NEAR} for rounding to the precision defined by i
Default value: ARND:NO if no rounding is specified
ARND:i:NEAR if i is specified
4 August 2003
381
SwapStructure
382
Keyword
Explanation
CCM
Coupon calculation method {BB00, BBA0, BBA5, BBAA, BBE0, MM00, MMA0, MMA5, MMAA,
MME0, MMNL0, MMNL5, 00D, A0D, A5D, E0D, 00, A0, A5, AA, E0} (see the Notes section
below)
CCM:BB00 for bond 30/360
CCM:BBA0 for bond Actual/360
CCM:BBA5 for bond Actual/365
CCM:BBAA for bond Actual/Actual
CCM:BBE0 for bond 30E/360 ISMA
CCM:MM00 for money market 00/360
CCM:MMA5 for money market Actual/365
CCM:MMA0 for money market Actual/360
CCM:MMAA for money market Actual/Actual
CCM:MME0 for money market 30E/360
CCM:MMNL0 for money market Actual No Leap/360
CCM:MMNL5 for money market Actual No Leap/365
CCM:00D for effective 30/360 (day-based)
CCM:A0D for effective Actual/360 (day-based)
CCM:A5D for effective Actual/365 (day-based)
CCM:E0D for effective 30E/360 (day-based)
CCM:00 for effective 30/360 (period-based)
CCM:A0 for effective Actual/360 (period-based)
CCM:A5 for effective Actual/365 (period-based)
CCM:AA for effective Actual/Actual (period-based)
CCM:E0 for effective 30E/360 (period-based)
Default value: CCM:BBAA
CFADJ
CLDR
4 August 2003
Keyword
Explanation
CRND
DATED
DMC
Date moving convention used when an expiry date or a dividend date falls on a non
working day {F, FOL, M, MOD, N, NONE, P, PRE}
DMC:F or DMC:FOL for moving the date to the following working day
DMC:M or DMC:MOD for moving the date to the following working day unless it causes
the date to be pushed into the next month (in this latter case, the last working day of
the month is used)
DMC:N or DMC:NONE for no moving date
DMC:P or DMC:PRE for moving the date to the preceding working day
Default value: The value of the DMC keyword of the "IRS" category
EMC
End-of-month convention used when the maturity date falls on the last day of a month
{D, DEF, L, LAST, S, SAME, L28}
EMC:D or EMC:DEF for the value in Default Settings
EMC:L or EMC:LAST for last
EMC:S or EMC:SAME for same
EMC:L28 to match Hong Kong bond requirements: They ignore the 29th of February
for cash flow payment. This affects semi-annual bonds maturing on the 31st of
August. Coupons are paid every 31st of August and every 28th of February. In case of
a leap year the cash flow is still paid the 28th and not the 29th
Default value: The value of the EMC keyword of the "IRS" category
FAD
FCV
4 August 2003
383
SwapStructure
384
Keyword
Explanation
FRCD
FRQ
Frequency of the coupon payments {i {28D, 91D, 182D,364D, 1, 2, 4, 12}} (see the
Notes section below)
FRQ:28D to define a coupon payment every 28 days from the maturity date
FRQ:91D to define a coupon payment every 91 days from the maturity date
FRQ:182D to define a coupon payment every 182 days from the maturity date
FRQ:364D to define a coupon payment every 364 days from the maturity date
FRQ:1 to define an annual coupon payment from the maturity date
FRQ:2 to define a semi-annual coupon payment from the maturity date
FRQ:4 to define a quarterly coupon payment from the maturity date
FRQ:12 to define a monthly coupon payment from the maturity date
FRQ:DDMMMYY:i to define a frequency of i from date DDMMMYY
Default value: FRQ:1
IC
Irregular first coupon type for asset swaps combined with bonds with an irregular first
coupon {L1, L1R, S1, S1P, S1R, NBC}
(the bond issue date must also be specified using DATED)
IC:L1 for long first coupon (first coupon date equal to second anniversary date)
IC:L1R for long first coupon with regular nominal value and starting accrued date
equal to first anniversary date (SPGB)
IC:S1 for short first coupon (first coupon date equal to first anniversary date)
IC:S1P for short first coupon with proportional value (BTAN)
IC:S1R for short first coupon with regular nominal value
IC:NBC for NBC fist coupon
Default value: IC:S1
IDX
LBOTH
4 August 2003
Keyword
Explanation
LPAID
LRCD
Last regular coupon date for odd last coupon {DDMMMYY, JGB}
LRCD:DDMMMYY where DDMMMYY is the last regular coupon date
LRCD:JGB to handle odd last coupons for JGBs automatically
Default value: All coupons are regular so LRCD has no meaning
LRECEIVED
LTYPE
MDADJ
NOTIONAL
PDELAY
PPMT
4 August 2003
385
SwMode
Keyword
Explanation
REFDATE
RND
RP
RT
Reimbursement type {B, C{:i}, Sj{:i} where i is numeric (1=100%) and j from 1 to 8}
RT:B for bullet or in fine
RT:C for constant payments
RT:C:i for constant payments equal to i except for the last cash flow which is
adjusted
RT:Sj for j series
RT:Sj:i for j series and constant payments equal to i except for the last cash flow
which is adjusted
Default value: RT:B
SPREAD
SwMode
SwMode is used as argument in functions of the Adfin Swaps module to define:
386
4 August 2003
the attributes of the zero-coupon yield curves used or calculated in Adfin Swaps (keywords
CURVESHIFT, DCB, IM, LAY, ND, OBC, SHIFT, and ZCTYPE)
the types of some input arguments and to select or customize returned values (keywords
MATRANGE, PXT, RES and RET)
how the prices are specified in input and output for currency swaps (keyword DC)
keyword, a colon (:), and the value of the keyword. The parameter sets are separated by a blank
space. However, certain keywords are used on their own and do not require a value. A keyword can
also have several values, all separated by colons.
Structure
Keyword
Explanation
CURVESHIFT Specifies the shift value {i, where i is a float expressed as real value} (see the Notes
section below)
CURVESHIFT:i means that a parallel shift of i applies to the yield curve
Default value: No shift is defined
DC
DCB
Day count basisused for zero-coupon calculations {00, A0, A0D, A25D, A5, A5D, AA, E0}
DCB:00 for 30/360 (period-based calculation)
DCB:A0 for Actual/360 (period-based calculation)
DCB:A0D for Actual/360 (day-based calculation)
DCB:A25D for Actual/365.25 (day-based calculation)
DCB:A5 for Actual/365 (period-based calculation)
DCB:A5D for Actual/365 (day-based calculation)
DCB:AA for Actual/Actual (period-based calculation)
DCB:E0 for 30E/360 ISMA (period-based calculation)
Default value: The value of the DCB keyword of the "RATEMODEL" category
IM
4 August 2003
387
SwMode
388
Keyword
Explanation
LAY
MATRANGE
Range parameter describing the maturities included in an input swap rate curve
{iY,jY, iY-jY with i and j as integer}
MATRANGE:iY,jY to specify a curve with maturities of i years and j years
MATRANGE:iY-jY to specify a curve with maturities ranging from i years to j years
Default value: MATRANGE: 1,2,3,6,9, or undefined
ND
OBC
PXT
RES
4 August 2003
Keyword
Explanation
RET
Return value parameter to shorten or lengthen the array of data returned by array
functions {Ai{:ABCDE}, i with i as integer}
RET:Ai with i from 1 to ArraySize to get the i first rows of the default array
RET:Ai:ABCDE with i from 1 to ArraySize to get the i first rows of an array containing
the selected columns (see supported configurations)
Default value: No
SHIFT
ZCTYPE
YcMode
YcMode is used as argument functions of the Adfin TermStructure module to customize
returned values.
YcMode is a string consisting of a series of parameters. Each set of parameters consists of
a keyword, a colon (:), and the value of the keyword. The parameter sets are separated by
a blank space. However, certain keywords are used on their own and do not require a
value. A keyword can also have several values, all separated by colons.
Structure
Keyword
Explanation
BWB
4 August 2003
389
YcMode
Keyword
Explanation
DCB
Day count basis {00, A0, A0D, A25D, A5, A5D, AA, E0}
DCB:00 for 30/360 (period-based calculation)
DCB:A0 for Actual/360 (period-based calculation)
DCB:A0D for Actual/360 (day-based calculation)
DCB:A25D for Actual/365.25 (day-based calculation)
DCB:A5 for Actual/365 (period-based calculation)
DCB:A5D for Actual/365 (day-based calculation)
DCB:AA for Actual/Actual (period-based calculation)
DCB:E0 for 30E/360 ISMA (period-based calculation)
Default value: DCB:AA
DCP
IM
390
LAY
ND
NFVP
4 August 2003
Keyword
Explanation
OBC
ODD
OFFSET
PFVP
RET
Return value parameter to shorten the data returned by array functions {Ai, i with i
as integer}
RET:Ai with i from 1 to ArraySize to get the i first elements
RET:i with i from 1 to ArraySize to get the i-th element only
Default value: BWB
ROLL
SPREAD
4 August 2003
391
YcMode
392
Keyword
Explanation
ZCTYPE
4 August 2003