floorbybk
Price floor instrument from Black-Karasinski interest-rate tree
Syntax
Description
[
computes the price of a floor instrument from a Black-Karasinski interest-rate tree.
Price
,PriceTree
]
= floorbybk(BKTree
,Strike
,Settle
,Maturity
)floorbybk
computes prices of vanilla floors and amortizing floors.
Note
Alternatively, you can use the Floor
object to price floor
instruments. For more information, see Get Started with Workflows Using Object-Based Framework for Pricing Financial Instruments.
Examples
Price a 3% Floor Instrument Using a Black-Karasinski Interest-Rate Tree
Load the file deriv.mat
, which provides BKTree
. The BKTree
structure contains the time and interest rate information needed to price the floor instrument.
load deriv.mat;
Set the required values. Other arguments will use defaults.
Strike = 0.03; Settle = datetime(2004,1,1); Maturity = datetime(2007,1,1);
Use floorbybk
to compute the price of the floor instrument.
Price = floorbybk(BKTree, Strike, Settle, Maturity)
Price = 0.2061
Compute the Price of an Amortizing and Vanilla Floors Using the BK Model
Load deriv.mat
to specify the BKTree
and then define the floor instrument.
load deriv.mat; Settle = datetime(2004,1,1); Maturity = datetime(2008,1,1); Strike = 0.045; Reset = 1; Principal ={{datetime(2005,1,1) 100;datetime(2006,1,1) 60;datetime(2007,1,1) 30;datetime(2008,1,1) 30};... 100};
Price the amortizing and vanilla floors.
Basis = 1; Price = floorbybk(BKTree, Strike, Settle, Maturity, Reset, Basis, Principal)
Price = 2×1
2.2000
2.5564
Input Arguments
BKTree
— Interest-rate tree structure
structure
Interest-rate tree structure, specified by using bktree
.
Data Types: struct
Strike
— Rate at which cap is exercised
decimal
Rate at which cap is exercised, specified as a NINST
-by-1
vector
of decimal values.
Data Types: double
Settle
— Settlement date for floor
datetime array | string array | date character vector
Settlement date for the floor, specified as a NINST
-by-1
vector using a datetime array, string array, or date character vectors. The
Settle
date for every floor is set to the
ValuationDate
of the BK tree. The floor argument
Settle
is ignored.
To support existing code, floorbybk
also
accepts serial date numbers as inputs, but they are not recommended.
Maturity
— Maturity date for floor
datetime array | string array | date character vector
Maturity date for the floor, specified as a NINST
-by-1
vector using a datetime array, string array, or date character vectors.
To support existing code, floorbybk
also
accepts serial date numbers as inputs, but they are not recommended.
Reset
— Reset frequency payment per year
1
(default) | numeric
(Optional) Reset frequency payment per year, specified as a
NINST
-by-1
vector.
Data Types: double
Basis
— Day-count basis of instrument
0
(actual/actual) (default) | integer from 0
to 13
(Optional) Day-count basis representing the basis used when annualizing the input
forward rate, specified as a NINST
-by-1
vector
of integers.
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
— Notional principal amount
100
(default) | numeric
(Optional) Notional principal amount, specified as a
NINST
-by-1
of notional principal amounts, or a
NINST
-by-1
cell array, where 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.
Use Principal
to pass a schedule to compute the price for an
amortizing floor.
Data Types: double
| cell
Options
— Derivatives pricing options structure
structure
(Optional) Derivatives pricing options structure, specified using derivset
.
Data Types: struct
Output Arguments
Price
— Expected price of floor at time 0
vector
Expected price of the floor at time 0, returned as a NINST
-by-1
vector.
PriceTree
— Tree structure with values of floor at each node
vector
Tree structure with values of the floor at each node, returned as a MATLAB® structure of trees containing vectors of instrument prices and a vector of observation times for each node:
PriceTree.PTree
contains floor prices.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
Floor
A floor is a contract that includes a guarantee setting the minimum interest rate to be received by the holder, based on an otherwise floating interest rate.
The payoff for a floor is:
Version History
Introduced before R2006aR2022b: Serial date numbers not recommended
Although floorbybk
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.
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)