instcap (Financial Derivatives Toolbox)

Construct cap instrument

Syntax

InstSet = instcap(InstSet, Strike, Settle, Maturity, Reset, Basis, 
Principal)
[FieldList, ClassList, TypeString] = instcap

Arguments

InstSet
Instrument variable. This argument is specified only when adding cap instruments to an existing instrument set. See instget for more information on the InstSet variable.

Strike
Rate at which the cap is exercised, as a decimal number.

Settle
Settlement date. Serial date number representing the settlement date of the cap.

Maturity
Serial date number representing the maturity date of the cap.

Reset
(Optional) NINST-by-1 vector representing the frequency of payments per year. Default = 1.

Basis
(Optional) NINST-by-1 vector representing the basis used when annualizing the input forward rate tree. Default = 0 (actual/actual).

Principal
(Optional) The notional principal amount. Default = 100.

`InstSet`	Instrument variable. This argument is specified only when adding cap instruments to an existing instrument set. See `instget` for more information on the `InstSet` variable.
`Strike`	Rate at which the cap is exercised, as a decimal number.
`Settle`	Settlement date. Serial date number representing the settlement date of the cap.
`Maturity`	Serial date number representing the maturity date of the cap.
`Reset`	(Optional) `NINST`-by-`1` vector representing the frequency of payments per year. Default = `1`.
`Basis`	(Optional) `NINST`-by-`1` vector representing the basis used when annualizing the input forward rate tree. Default = `0` (actual/actual).
`Principal`	(Optional) The notional principal amount. Default = `100`.

Description

InstSet = instcap(InstSet, Strike, Settle, Maturity, Reset, Basis, Principal) creates a new instrument set containing cap instruments or adds cap instruments to an existing instrument set.

[FieldList, ClassList, TypeString] = instcap displays the classes.

FieldList is a number of fields (NFIELDS)-by-1 cell array of strings listing the name of each data field for this instrument type.

ClassList is an NFIELDS-by-1 cell array of strings listing the data class of each field. The class determines how arguments are parsed. Valid strings are 'dble', 'date', and 'char'.

TypeString is a string specifying the type of instrument added. For a cap instrument, TypeString = 'Cap'.

instbond instcf