optfloatbyhw
Price options on floating-rate notes for Hull-White interest-rate tree
Syntax
Description
[
prices options on floating-rate notes from a Hull-White interest rate tree.
Price
,PriceTree
]
= optfloatbyhw(HWTree
,OptSpec
,Strike
,ExerciseDates
,AmericanOpt
,Spread
,Settle
,Maturity
)optfloatbyhw
computes prices of options on vanilla floating-rate notes.
Note
Alternatively, you can use the FloatBondOption
object to price floating-rate bond option instruments. For more information, see Get Started with Workflows Using Object-Based Framework for Pricing Financial Instruments.
[
adds optional name-value pair arguments. Price
,PriceTree
]
= optfloatbyhw(___,Name,Value
)
Examples
Compute the Price of American and European Call Options on a Floating-Rate Note
Define the interest-rate term structure.
Rates = [0.03;0.034;0.038;0.04]; ValuationDate = datetime(2012,1,1); StartDates = ValuationDate; EndDates = [datetime(2013,1,1) ; datetime(2014,1,1) ; datetime(2015,1,1) ; datetime(2016,1,1)]; Compounding = 1;
Create the RateSpec
.
RateSpec = intenvset('ValuationDate', ValuationDate, 'StartDates', StartDates,... 'EndDates', EndDates, 'Rates', Rates, 'Compounding', Compounding)
RateSpec = struct with fields:
FinObj: 'RateSpec'
Compounding: 1
Disc: [4x1 double]
Rates: [4x1 double]
EndTimes: [4x1 double]
StartTimes: [4x1 double]
EndDates: [4x1 double]
StartDates: 734869
ValuationDate: 734869
Basis: 0
EndMonthRule: 1
Build the HW tree using the following:
VolDates = [datetime(2013,1,1) ; datetime(2014,1,1) ; datetime(2015,1,1) ; datetime(2016,1,1)]; VolCurve = 0.01; AlphaDates = datetime(2016,1,1); AlphaCurve = 0.1; HWVolSpec = hwvolspec(RateSpec.ValuationDate, VolDates, VolCurve,... AlphaDates, AlphaCurve); HWTimeSpec = hwtimespec(RateSpec.ValuationDate, VolDates, Compounding); HWT = hwtree(HWVolSpec, RateSpec, HWTimeSpec)
HWT = struct with fields:
FinObj: 'HWFwdTree'
VolSpec: [1x1 struct]
TimeSpec: [1x1 struct]
RateSpec: [1x1 struct]
tObs: [0 1 2 3]
dObs: [734869 735235 735600 735965]
CFlowT: {[4x1 double] [3x1 double] [2x1 double] [4]}
Probs: {[3x1 double] [3x3 double] [3x5 double]}
Connect: {[2] [2 3 4] [2 3 4 5 6]}
FwdTree: {[1.0300] [1.0562 1.0381 1.0202] [1.0831 1.0645 1.0462 1.0283 1.0106] [1.1022 1.0833 1.0647 1.0464 1.0284 1.0108 0.9934]}
The floater instrument has a spread of 10, a period of one year, and matures on Jan-1-2016.
Spread = 10; Settle = datetime(2012,1,1); Maturity = datetime(2016,1,1); Period = 1;
Define the option for the floating-rate note.
OptSpec = {'call'};
Strike = 95;
ExerciseDates = datetime(2016,1,1);
AmericanOpt = [0;1];
Compute the price of the call options.
Price= optfloatbyhw(HWT, OptSpec, Strike, ExerciseDates,AmericanOpt,...
Spread, Settle, Maturity)
Price = 2×1
4.2740
5.3655
Input Arguments
HWTree
— Interest-rate tree structure
binomial tree structure
Interest-rate tree specified as a structure by using hwtree
.
Data Types: struct
OptSpec
— Definition of option
character vector | cell array of character vectors
Definition of option as 'call'
or 'put'
specified
as a NINST
-by-1
cell array of
character vectors for 'call'
or 'put'
.
Data Types: cell
| char
Strike
— Option strike price values
nonnegative integer | vector of nonnegative integers
Option strike price values specified nonnegative integers using
as NINST
-by-NSTRIKES
vector
of strike price values.
Data Types: double
ExerciseDates
— Exercise date for option (European, Bermuda, or American)
datetime array | string array | date character vector
Exercise date for option (European, Bermuda, or American) specified as a
NINST
-by-NSTRIKES
or
NINST
-by-2
vector using a datetime array, string
array, or date character vectors.
To support existing code, optfloatbyhw
also
accepts serial date numbers as inputs, but they are not recommended.
If a European or Bermuda option, the
ExerciseDates
is a1
-by-1
(European) or1
-by-NSTRIKES
(Bermuda) vector of exercise dates. For a European option, there is only oneExerciseDate
on the option expiry date.If an American option, then
ExerciseDates
is a1
-by-2
vector of exercise date boundaries. The option exercises on any date between or including the pair of dates on that row. If there is only one non-NaN
date, or ifExerciseDates
is1
-by-1
, the option exercises between theSettle
date and the single listedExerciseDate
.
AmericanOpt
— Option type
scalar | vector of positive integers[0,1]
Option type specified as NINST
-by-1
positive
integer scalar flags with values:
0
— European/Bermuda1
— American
Data Types: double
Spread
— Number of basis points over the reference rate
nonnegative integer | vector of nonnegative integers
Number of basis points over the reference rate specified as
a vector of nonnegative integers for the number of instruments (NINST
)-by-1
).
Data Types: double
Settle
— Settlement dates of floating-rate note
ValuationDate
of HW tree (default) | datetime array | string array | date character vector
Settlement dates of floating-rate note specified as a
NINST
-by-1
vector using a datetime array, string
array, or date character vectors.
Note
The Settle
date for every floating-rate note is set to the
ValuationDate
of the HW tree. The floating-rate note argument
Settle
is ignored.
To support existing code, optfloatbyhw
also
accepts serial date numbers as inputs, but they are not recommended.
Maturity
— Floating-rate note maturity date
datetime array | string array | date character vector
Floating-rate note maturity date specified as a
NINST
-by-1
vector using a datetime array, string
array, or date character vectors.
To support existing code, optfloatbyhw
also
accepts serial date numbers as inputs, but they are not recommended.
Name-Value Arguments
Specify optional pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Name-value arguments must appear after other arguments, but the order of the
pairs does not matter.
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
Example: [Price,PriceTree]=optfloatbyhw(HWTree,OptSpec,Strike,ExerciseDates,AmericanOpt,Spread,Settle,Maturity,'FloatReset',4,'Basis',7)
FloatReset
— Frequency of payments per year
1
(default) | positive integer from the set[1,2,3,4,6,12]
| vector of positive integers from the set
[1,2,3,4,6,12]
Frequency of payments per year, specified as the comma-separated pair consisting
of 'FloatReset'
and positive integers for the values
[1,2,3,4,6,12]
in a
NINST
-by-1
vector.
Note
Payments on floating-rate notes (FRNs) are determined by the effective interest-rate between reset dates. If the reset period for an FRN spans more than one tree level, calculating the payment becomes impossible due to the recombining nature of the tree. That is, the tree path connecting the two consecutive reset dates cannot be uniquely determined because there will be more than one possible path for connecting the two payment dates.
Data Types: double
Basis
— Day-count basis of the instrument
0
(actual/actual) (default) | positive integers of the set [1...13]
| vector of positive integers of the set [1...13]
Day-count basis of the instrument, specified as the comma-separated pair consisting of
'Basis'
and a positive integer using a
NINST
-by-1
vector. The
Basis
value represents the basis used when annualizing the input
forward-rate tree.
0 = actual/actual
1 = 30/360 (SIA)
2 = actual/360
3 = actual/365
4 = 30/360 (PSA)
5 = 30/360 (ISDA)
6 = 30/360 (European)
7 = actual/365 (Japanese)
8 = actual/actual (ICMA)
9 = actual/360 (ICMA)
10 = actual/365 (ICMA)
11 = 30/360E (ICMA)
12 = actual/365 (ISDA)
13 = BUS/252
For more information, see Basis.
Data Types: double
Principal
— Principal values
100
(default) | vector of nonnegative values | cell array of nonnegative values
Principal values, specified as the comma-separated pair consisting of
'Principal'
and nonnegative values using a
NINST
-by-1
vector or
NINST
-by-1
cell array of notional principal
amounts. When using a NINST
-by-1
cell array,
each element is a NumDates
-by-2
cell array where
the first column is dates and the second column is associated principal amount. The
date indicates the last day that the principal value is valid.
Data Types: double
| cell
Options
— Structure containing derivatives pricing options
structure
Structure containing derivatives pricing options, specified as the comma-separated pair
consisting of 'Options'
and a structure obtained from using
derivset
.
Data Types: struct
EndMonthRule
— End-of-month rule flag
1
(in effect) (default) | nonnegative integer [0,1]
End-of-month rule flag, specified as the comma-separated pair consisting of
'EndMonthRule'
and a nonnegative integer [0
,
1
] using a NINST
-by-1
vector. This rule applies only when Maturity
is an end-of-month
date for a month having 30 or fewer days.
0
= Ignore rule, meaning that a bond coupon payment date is always the same numerical day of the month.1
= Set rule on, meaning that a bond coupon payment date is always the last actual day of the month.
Data Types: double
Output Arguments
Price
— Expected prices of the floating-rate note option at time 0
scalar | vector
Expected prices of the floating-rate note option at time 0 is
returned as a scalar or an NINST
-by-1
vector.
PriceTree
— Structure of trees containing vectors of option prices at each node
tree structure
Structure of trees containing vectors of instrument prices and accrued interest and a vector of observation times for each node returned as:
PriceTree.PTree
contains the clean prices.PriceTree.AITree
contains the accrued interest.PriceTree.tObs
contains the observation times.PriceTree.Connect
contains the connectivity vectors. Each element in the cell array describes how nodes in that level connect to the next. For a given tree level, there areNumNodes
elements in the vector, and they contain the index of the node at the next level that the middle branch connects to. Subtracting 1 from that value indicates where the up-branch connects to, and adding 1 indicated where the down branch connects to.PriceTree.Probs
contains the probability arrays. Each element of the cell array contains the up, middle, and down transition probabilities for each node of the level.
More About
Floating-Rate Note Options
A floating-rate note option is a put or call option on a floating-rate note.
Financial Instruments Toolbox™ supports three types of put and call options on floating-rate notes:
American option — An option that you exercise any time until its expiration date.
European option — An option that you exercise only on its expiration date.
Bermuda option — A Bermuda option resembles a hybrid of American and European options; you can only exercise it on predetermined dates, usually monthly.
For more information, see Floating-Rate Note Options.
Version History
Introduced in R2013aR2022b: Serial date numbers not recommended
Although optfloatbyhw
supports serial date numbers,
datetime
values are recommended instead. The
datetime
data type provides flexible date and time
formats, storage out to nanosecond precision, and properties to account for time
zones and daylight saving time.
To convert serial date numbers or text to datetime
values, use the datetime
function. For example:
t = datetime(738427.656845093,"ConvertFrom","datenum"); y = year(t)
y = 2021
There are no plans to remove support for serial date number inputs.
See Also
hwtree
| cfbyhw
| capbyhw
| swapbyhw
| floorbyhw
| floatbyhw
| bondbyhw
| instoptfloat
| FloatBondOption
Topics
- Pricing Using Interest-Rate Tree Models
- Calibrating Hull-White Model Using Market Data
- Floating-Rate Note Options
- Understanding Interest-Rate Tree Models
- Pricing Options Structure
- Supported Interest-Rate Instrument Functions
- Mapping Financial Instruments Toolbox Functions for Interest-Rate Instrument Objects
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)