R/classe-compactcen.r

In lkhenayfis/hidro-clustena: Selecao De Cenarios De ENA

############################ FUNCOES ASSOCIADAS A COMPACTACAO DE CENARIOS ##########################

#' Construtor De \code{compactcen}
#' 
#' Construtor interno de objetos com cenarios compactados
#' 
#' O argumento \code{compact} deve ser um data.table seguindo um padrao de formato:
#' 
#' \describe{
#' \item{\code{anoref}}{ano de referencia para geracao do cenario}
#' \item{\code{bacia}}{bacia a qual a ENA corresponde}
#' \item{\code{cenario}}{indice do cenario com respeito a bacia e ano de referencia}
#' \item{\code{ind}}{indice do elemento no vetor de dimensao reduzida}
#' \item{\code{ena}}{valor de energia afluente}
#' }
#' 
#' Por exemplo, para compactacao dos cenarios em tres dimensoes:
#' 
#' | anoref | bacia | cenario | ind | ena |
#' | :----: | :---: | :-----: | :-: | :-: |
#' | 2000   | SIN   | 1       | 1   | XXX |
#' | 2000   | SIN   | 1       | 2   | XXX |
#' | 2000   | SIN   | 1       | 3   | XXX |
#' | 2000   | SIN   | 2       | 1   | XXX |
#' | ...    | ...   | ...     | ... | ... |
#' 
#' \code{invfunc} deve ser uma funcao que recebe apenas um vetor numerico indicando coordenadas no
#' espaco compactado e retorna um vetor numerico indicando o cenario completo correspondente aquela
#' compactacao. Para PCA, por exemplo, isso pode ser feito multiplicando o vetor de variaveis 
#' compactadas pela matriz de carregamentos estimada.
#' 
#' @param compact data.table contendo a informacao de cenarios compactados. Ver Detalhes
#' @param metodo string indicando o nome da funcao utilizada para compactacao
#' @param invfunc caso exista, funcao para transformar vetores no espaco reduzido de volta ao 
#'     original
#' 
#' @return Objeto da classe \code{compactcen}, uma lista de um emento chamado compact contendo o
#'     argumento \code{compact}, um \code{data.table} com as colunas
#' 
#' \describe{
#' \item{\code{anoref}}{ano de referencia para geracao do cenario}
#' \item{\code{bacia}}{bacia a qual a ENA corresponde}
#' \item{\code{cenario}}{indice do cenario com respeito a bacia e ano de referencia}
#' \item{\code{ind}}{indice do elemento no vetor de dimensao reduzida}
#' \item{\code{ena}}{valor de energia afluente}
#' }
#' 
#' Adicionalmente contem os atributos
#' 
#' \itemize{
#' \item{\code{metodo}: }{string do nome da funcao chamada para compactacao}
#' \item{\code{teminv}: }{booleano indicando se a compactacao possui inversa}
#' \item{\code{invfunc}: }{caso tenha inversa, a funcao que recebe vetores no espaco compactado e 
#'     retorna no espaco original}
#' }

new_compactcen <- function(compact, metodo, invfunc) {

    teminv <- !is.null(invfunc)

    out <- list(compact = compact)

    class(out) <- c("compactcen")
    attr(out, "metodo")  <- metodo
    attr(out, "teminv")  <- teminv
    if(teminv) attr(out, "invfunc") <- invfunc

    return(out)
}