R/chebyshevDistanceW.details.R

In LearnClust: Learning Hierarchical Clustering Algorithms

#' @title To calculate the Chebyshev distance applying weights.
#' @description To explain how to calculate the Chebyshev distance between clusters applying weights given.
#' @param cluster1 is a cluster.
#' @param cluster2 is a cluster.
#' @param weight is a numeric vector.
#' @details The function calculates the Chebyshev distance value from \code{cluster1} and \code{cluster2}, applying weights to the cluster's components.
#' @author Roberto Alcántara \email{roberto.alcantara@@edu.uah.es}
#' @author Juan José Cuadrado \email{jjcg@@uah.es}
#' @author Universidad de Alcalá de Henares
#' @return Chebyshev distance applying weights value. Explanation.
#' @examples
#'
#' cluster1 <- matrix(c(1,2),ncol=2)
#' cluster2 <- matrix(c(1,3),ncol=2)
#'
#' weight1 <- c(0.4,0.6)
#' weight2 <- c(2,12)
#'
#' chebyshevDistanceW.details(cluster1,cluster2,weight1)
#'
#' chebyshevDistanceW.details(cluster1,cluster2,weight2)
#'
#' @export

chebyshevDistanceW.details <- function(cluster1,cluster2,weight){
  message("\n This function calculates the chebyshev distance applying some weight to each element in the clusters.\n")
  message("\n It allows the algorithm to use some categories more importante than the others. \n")
  buffer <- c()
  if(is.null(weight)){
    message("\n Due to there is not weight, the formula does not change. \n")
    for (index in c(1:ncol(cluster1))) {
      aux <- abs(cluster2[index] - cluster1[index])
      buffer <- c(buffer, aux)
    }
    res <- max(buffer)
  } else {
    message("\n Due to there is weight, the formula has to multiply values by each weight. \n")
    for (index in c(1:ncol(cluster1))) {
      aux <- weight[index] * abs(cluster2[index] - cluster1[index])
      buffer <- c(buffer, aux)
    }
    res <- max(buffer)
  }
  message("\n Chebyshev distance is ", res," \n")
  res
}