R/RevaloEngine_finance_tmg.R

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

#----------------------------------------------------------------------------------------------------------------------------------------------------
#           finance_tmg
#----------------------------------------------------------------------------------------------------------------------------------------------------
##' Calcule la contribution de la PPB au financement des taux minimums garantis.
##'
##' \code{finance_tmg} est une methode permettant d'evaluer le contribution de la PPB
##' au financement des taux minimums garantis (TMG) sur prestations et sur stock.
##' @name finance_tmg
##' @docType methods
##' @param bes_tmg_prest un vecteur \code{numeric} comprenant
##'  par produit le besoin de finance des TMG sur prestations.
##' @param bes_tmg_stock un vecteur \code{numeric} comprenant
##'  par produit le besoin de finance des TMG sur le stock.
##' @param ppb est un objet de la classe \code{\link{Ppb}} qui renvoie l'etat courant de la PPB.
##' @details Dans cette methode, il est considere que le PPB peut venir financer les TMG sur prestations et sur stock.
##' Par convention, la PPB finance d'abord les TMG sur prestations, puis sur stock.
##' @return \code{contrib_tmg_prest} la valeur de la contribution au financement des TMG sur prestations.
##' @return \code{contrib_tmg_stock} la valeur de la contribution au financement des TMG sur stock.
##' @return \code{ppb} l'objet \code{ppb} mis a jour.
##' @author Prim'Act
##' @export
##' @include Ppb_class.R


setGeneric(name = "finance_tmg", def = function(bes_tmg_prest, bes_tmg_stock, ppb) {
    standardGeneric("finance_tmg")
})
setMethod(
    f = "finance_tmg",
    signature = c(bes_tmg_prest = "numeric", bes_tmg_stock = "numeric", ppb = "Ppb"),
    definition = function(bes_tmg_prest, bes_tmg_stock, ppb) {
        # Controle
        if (prod(bes_tmg_prest < 0)) {
            stop("[RevaloEngine-finance_tmg] : les besoins de financements par produit doivent etre positifs.")
        }
        if (prod(bes_tmg_stock < 0)) {
            stop("[RevaloEngine-finance_tmg] : les besoins de financements par produit doivent etre positifs.")
        }


        # Calcul du besoin en TMG du portefeuille pour les prestations et le stock
        bes_tmg_prest_port <- sum(bes_tmg_prest)
        bes_tmg_stock_port <- sum(bes_tmg_stock)


        ### Etape 1 : financement des TMG sur prestations

        # Operation de reprise sur PPB
        op_ppb <- calc_reprise_ppb(ppb, bes_tmg_prest_port)
        # Mise a jour de la PPB
        ppb <- op_ppb[["ppb"]]
        reprise <- op_ppb[["reprise"]]

        # Contribution par la PPB pour le financement des TMG sur prestations
        contrib_tmg_prest <- reprise


        ### Etape 2 : financement des TMG sur stock

        # Operation de reprise sur PPB
        op_ppb <- calc_reprise_ppb(ppb, bes_tmg_stock_port)
        # Mise a jour de la PPB
        ppb <- op_ppb[["ppb"]]
        reprise <- op_ppb[["reprise"]]

        # Evaluation du besoin non prise en charge par la PPB pour le financement des TMG sur prestations
        contrib_tmg_stock <- reprise


        # Output
        return(list(
            contrib_tmg_prest = contrib_tmg_prest,
            contrib_tmg_stock = contrib_tmg_stock,
            ppb = ppb
        ))
    }
)