R/AlmEngine_create_ptf_bought_action.R

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

#----------------------------------------------------------------------------------------------------------------------------------------------------
#           create_ptf_bought_action
#----------------------------------------------------------------------------------------------------------------------------------------------------
##' Ajuste les quantites d'actions a acheter.
##'
##' \code{create_ptf_bought_action} est une methode permettant d'ajuster d'un coefficient les quantites
##' d'actions a acheter. Cette methode est utilisee pour l'achat de nouvelles actions.
##' @name create_ptf_bought_action
##' @docType methods
##' @param x objet de la classe \code{\link{Action}}, correspondant au portefeuille actions de reinvestissement.
##' Ce portefeuille est unitaire.
##' @param coefficient un vecteur de type \code{numeric} qui a autant d'elements
##'  que le portefeuille de reinvestissement action a de lignes.
##'   Il correspond au coefficient a appliquer au portefeuille de reinvestissement action
##'   pour effectuer l'achat desire.
##' @return \code{x} un objet de la classe \code{\link{Action}} correspondant a une
##'  proportion precise du portefeuille de reinvestissement action.
##' @author Prim'Act
##' @seealso La classe \code{\link{Action}}.
##' @export
##' @include AlmEngine_class.R Action_class.R

setGeneric(name = "create_ptf_bought_action", def = function(x, coefficient) {
    standardGeneric("create_ptf_bought_action")
})
setMethod(
    f = "create_ptf_bought_action",
    signature = c(x = "Action", coefficient = "numeric"),
    definition = function(x, coefficient) {
        # Recuperation du PTF action
        ptf_action <- x@ptf_action

        # Test input
        if (length(coefficient) != nrow(ptf_action)) stop("[Action : create_ptf_bought_action] : Les inputs sont de dimensions distinctes \n")

        # Donnees
        nom_table <- names(ptf_action)
        val_marche <- which(nom_table == "val_marche")
        val_nc <- which(nom_table == "val_nc")
        val_achat <- which(nom_table == "val_achat")
        nb_unit <- which(nom_table == "nb_unit")

        # Mise a jour des donnees du PTF action
        ptf_action$val_marche <- coefficient * .subset2(ptf_action, val_marche)
        ptf_action$val_nc <- coefficient * .subset2(ptf_action, val_nc)
        ptf_action$val_achat <- coefficient * .subset2(ptf_action, val_achat)
        ptf_action$nb_unit <- coefficient * .subset2(ptf_action, nb_unit)

        # Mise a jour du PTF
        x@ptf_action <- ptf_action

        # Output
        return(x)
    }
)