tmfactor

Time factors of arbitrary dates

Syntax

TMFactors = tmfactor(Settle,Maturity)

Description

TMFactors = tmfactor(Settle,Maturity) determines the time factors from a vector of Settlement dates to a vector of Maturity dates.

Examples

Find Time Factors of Settle and Maturity Dates

Find the TFactors for Settle and Maturity dates.

TFactors = tmfactor('1-Jan-2015','1-Jan-2016')

TFactors = 
2

Find the TFactors for Settle and Maturity dates using a datetimes.

TFactors = tmfactor(datetime(2015,1,1),datetime(2016,1,1))

TFactors = 
2

Input Arguments

Settle — Settlement date

datetime array | string array | date character vector

Settlement date, specified as a scalar or a NINST-by-1 vector using a datetime array, string array, or date character vectors.

Note

Settle must be earlier than Maturity.

To support existing code, tmfactor also accepts serial date numbers as inputs, but they are not recommended.

Data Types: char | string | datetime

Maturity — Maturity date

datetime array | string array | date character vector

Maturity date, specified as a scalar or a NINST-by-1 vector using a datetime array, string array, or date character vectors.

Data Types: char | string | datetime

Output Arguments

TMFactors — Time factors from a vector of Settle dates to a vector of Maturity dates

scalar numeric

Time factors from a vector of Settle dates to a vector of Maturity dates, returned as a scalar numeric.

Version History

Introduced before R2006a

R2022b: Serial date numbers not recommended

Although tmfactor 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.