R/risk_neutral_rates.R

Defines functions rate_increase rate_decrease rate_constant

Documented in rate_constant rate_decrease rate_increase

#' Constant rate function
#'
#' @param x spatial input
#' @param t temporal input
#' @param rate risk-free rate of return
#'
#' @description {Consant rate function for discounting.}
#' @return numeric
#' @export rate_constant
rate_constant <- function(x, t, rate)
{
  rate
}

#' time-scaled rate function
#'
#' @param x spatial input
#' @param t temporal input
#' @param rate risk-free rate of return
#' @param maturity the time-horizon
#'
#' @description {Time decreasing risk-free rate.}
#' @return numeric
#' @export rate_decrease
rate_decrease <- function(x, t, rate, maturity)
{
  rate*(maturity-t)
}

#' time-scaled rate function (increasing)
#'
#' @param x spatial input
#' @param t temporal input
#' @param rate risk-free rate of return
#'
#' @description {Time decreasing risk-free rate.}
#' @return numeric
#' @export rate_increase
rate_increase <- function(x, t, rate)
{
  rate*t
}
shill1729/FeynmanKacSolver documentation built on May 19, 2020, 8:23 p.m.