R/Oblig_yield_to_maturity.R

In qguibert/SimBEL: Un package de calcul du best estimate epargne sous Solvabilite 2

#----------------------------------------------------------------------------------------------------------------------------------------------------
#          yield_to_maturity
#----------------------------------------------------------------------------------------------------------------------------------------------------
##' Calcule les yield to maturity de chaque composante d'un portefeuille obligataire.
##'
##' \code{yield_to_maturity} est une methode permettant de calculer les yield to maturity de chaque composante d'un portefeuille obligataire.
##' @name yield_to_maturity
##' @docType methods
##' @param x objet de la classe \code{\link{Oblig}} (decrivant le portefeuile obligataire).
##' @return Un vecteur dont chaque element correspond au yield to maturity des obligations du portefeuille obligataire.
##' Ce vecteur a autant d'elements que le portefeuille obligataire a de lignes.
##' @author Prim'Act
##' @export
##' @include Oblig_class.R

setGeneric(name = "yield_to_maturity", def = function(x) {
    standardGeneric("yield_to_maturity")
})
setMethod(
    f = "yield_to_maturity",
    signature = "Oblig",
    definition = function(x) {
        # Donnees
        ptf_oblig <- x@ptf_oblig
        nom_table <- names(ptf_oblig)
        mat_res <- which(nom_table == "mat_res")
        zsp <- which(nom_table == "zspread")
        val_mar <- which(nom_table == "val_marche")

        # Tests
        if (nrow(ptf_oblig) == 0) stop("[Oblig : yield_to_maturity] : Portefeuille vide")

        # Calcul et extraction de donnees
        coupon <- calc_coupon(x)
        nominal <- calc_nominal(x)
        maturite <- .subset2(ptf_oblig, mat_res)
        zspread <- .subset2(ptf_oblig, zsp)
        vm <- .subset2(ptf_oblig, val_mar)
        m <- max(maturite)

        # Calcul des YtM pour chaque ligne obligataire du portefeuille
        # On resoud a chaque fois la fonction VM(YtM)-VA=0
        ytm <- unlist(lapply(1:length(coupon), function(i) {
            multiroot(
                function(y) {
                    return(sum(echeancier(coupon[i], maturite[i], zspread[i], nominal[i], rep(y, m))) - vm[i])
                },
                start = 0,
                maxiter = 300
            )$root
        }))

        # Output
        return(ytm)
    }
)