R/aggregate_node.R

In GeoFIS: Spatial Data Processing for Decision Making

################################################################################
#
# GeoFIS R package
#
# Copyright (C) 2021 INRAE
#
# Authors:
# 	Jean-luc Lablée - INRAE
# 	Serge Guillaume - INRAE
#
# License: CeCILL v2.1
# 	https://cecill.info/licences/Licence_CeCILL_V2.1-en.html
# 	https://cecill.info/licences/Licence_CeCILL_V2.1-fr.html
#
# This software is governed by the CeCILL license under French law and
# abiding by the rules of distribution of free software.  You can  use,
# modify and/ or redistribute the software under the terms of the CeCILL
# license as circulated by CEA, CNRS and INRIA at the following URL
# "https://cecill.info".
#
# As a counterpart to the access to the source code and  rights to copy,
# modify and redistribute granted by the license, users are provided only
# with a limited warranty  and the software's author,  the holder of the
# economic rights, and the successive licensors have only limited liability.
#
# In this respect, the user's attention is drawn to the risks associated
# with loading,  using,  modifying and/or developing or reproducing the
# software by the user in light of its specific status of free software,
# that may mean  that it is complicated to manipulate,  and  that  also
# therefore means  that it is reserved for developers  and  experienced
# professionals having in-depth computer knowledge. Users are therefore
# encouraged to load and test the software's suitability as regards their
# requirements in conditions enabling the security of their systems and/or
# data to be ensured and,  more generally, to use and operate it in the
# same conditions as regards security.
#
# The fact that you are presently reading this means that you have had
# knowledge of the CeCILL license and that you accept its terms.
#
################################################################################

#' @importFrom data.tree isLeaf
.aggregate <- function(source) {
  function(node) {
    if (isLeaf(node)) {
      node$sat <- node$mf$degree(source[[node$attribute]]) # [[ or unname
    } else {
      node$sat <- Aggreg(node$aggreg, node, "sat")
    }
  }
}

setGeneric(name = ".aggregate_node", def = function(source, node) {
  standardGeneric(".aggregate_node")
})

setOldClass("Node") # for use as signature in setMethod

setMethod(f = ".aggregate_node", signature = c("numeric", "Node"), definition = function(source, node) {
  node$Do(.aggregate(source), traversal = "post-order") # aggregate from leaves to root
  return(node$Get("sat"))
})

.remove_duplicate_columns <- function(data_frame) {
  return(data_frame[, !duplicated(colnames(data_frame))])
}

#' @importFrom stats setNames
setMethod(f = ".aggregate_node", signature = c("data.frame", "Node"), definition = function(source, node) {
  if (isLeaf(node)) {
    # the result of apply function for a leaf node is a numeric vector
    # must be binded in column and named to the leaf name
    return(setNames(as.data.frame(cbind(apply(source, 1, .aggregate_node, node))), node$name))
  } else {
    # the result of apply function for a node is a matrix, must be transposed
    return(.remove_duplicate_columns(as.data.frame(t(apply(source, 1, .aggregate_node, node)))))
  }
})

setMethod(f = ".aggregate_node", signature = c("data.frame", "list"), definition = function(source, node) {
  return(.remove_duplicate_columns(do.call(cbind, lapply(node, function(node) .aggregate_node(source, node)))))
})

.aggregate_node_function <- function(node) {
  return(function(x) {
    return(.aggregate_node(x, node))
  })
}

setMethod(f = ".aggregate_node", signature = c("Spatial", "Node"), definition = function(source, node) {
  return(.transform_data_frame(source, .aggregate_node_function(node)))
})

setMethod(f = ".aggregate_node", signature = c("Spatial", "list"), definition = function(source, node) {
  return(.transform_data_frame(source, .aggregate_node_function(node)))
})