Rates
We should first discuss Rates, which are reexported from FinanceCore.jl
Rates are types that wrap scalar values to provide information about how to determine discount and accumulation factors. These allow for explicit handling of rate compounding conventions which, if not explicit, is often a source of errors in practice.
There are two Frequency types:
Yields.Periodic(m)for rates that compoundmtimes per period (e.g.mtimes per year if working with annual rates).Yields.Continuous()for continuously compounding rates.
Examples
Continuous(0.05) # 5% continuously compounded
Periodic(0.05,2) # 5% compounded twice per periodThese are both subtypes of the parent Rate type and are instantiated as:
Rate(0.05,Continuous()) # 5% continuously compounded
Rate(0.05,Periodic(2)) # 5% compounded twice per periodBroadcast over a vector to create Rates with the given compounding:
Periodic.([0.02,0.03,0.04],2)
Continuous.([0.02,0.03,0.04]) Rates can also be constructed by specifying the CompoundingFrequency and then passing a scalar rate:
Periodic(1)(0.05)
Continuous()(0.05)Conversion
Convert rates between different types with convert. E.g.:
r = Rate(0.01,Periodic(12)) # rate that compounds 12 times per rate period (ie monthly)
convert(Yields.Periodic(1),r) # convert monthly rate to annual effective
convert(Yields.Continuous(),r) # convert monthly rate to continuousTo get the scalar value out of the Rate, use FinanceModels.rate(r):
julia> r = Rate(0.01,Periodic(12));
julia> rate(r)
0.01
Arithmetic
Adding, subtracting, multiplying, dividing, and comparing rates is supported.