Skip to content

Commit

Permalink
Improve VolSurface() documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
imanuelcostigan committed Sep 7, 2019
1 parent 2d92077 commit 7eb992c
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions R/vol-surface-class.R
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
#' VolSurface class
#'
#' The `VolSurface` class is designed to capture the information about volatilities.
#' Checks whether the data members are of the correct type.
#' The `VolSurface` class is designed to capture implied volatility information
#' along with information about how to interpolate an implied volatility between nodes.
#'
#' @param vol_quotes object of class [VolQuotes()] containing the volatility
#' data.
#' @param interpolation Interplation method, given as an object of class
#' interpolation [Interpolation()]. At this time only the
#' [LinearCubicTimeVarInterpolation()] is supported.
#' [LinearCubicTimeVarInterpolation()] is supported. This is a two-dimensional
#' interpolator that uses linear interpolation in the time dimension and cubic
#' splines in the smile dimension with the values interpolated being the
#' square of the implied volatilities. Return values are implied volatilies
#' @return a `VolSurface` object
#' @seealso [interpolate.VolSurface], [build_vol_surface()]
#' @examples
Expand Down

0 comments on commit 7eb992c

Please sign in to comment.