R/gen_cube.R

In volesti: Volume Approximation and Sampling of Convex Polytopes

#' Generator function for hypercubes
#' 
#' This function generates the \eqn{d}-dimensional unit hypercube \eqn{[-1,1]^d} in H- or V-representation.
#' 
#' @param dimension The dimension of the hypercube
#' @param representation A string to declare the representation. It has to be \code{'H'} for H-representation or \code{'V'} for V-representation. Default valus is 'H'.
#' 
#' @return A polytope class representing the unit \eqn{d}-dimensional hypercube in H- or V-representation.
#' @examples 
#' # generate a 10-dimensional hypercube in H-representation
#' P = gen_cube(10, 'H')
#' 
#' # generate a 15-dimension hypercube in V-representation
#' P = gen_cube(5, 'V')
#' @export
gen_cube <- function(dimension, representation = 'H') {
  
  kind_gen = 1
  m_gen = 0
  if (representation == 'V') {
    Vpoly_gen = TRUE
  } else if (representation == 'H') {
    Vpoly_gen = FALSE
  } else {
    stop('Not a known representation.')
  }
  
  Mat = poly_gen(kind_gen, Vpoly_gen, FALSE, dimension, m_gen)
  
  # first column is the vector b
  b = Mat[, 1]
  Mat = Mat[, -c(1), drop = FALSE]
  if (Vpoly_gen) {
    P = Vpolytope(V = Mat, volume = 2^dimension)
  } else {
    P = Hpolytope(A = -Mat, b = b, volume = 2^dimension)
  }
  
  return(P)
}