R/getParamNr.R

In ParamHelpers: Helpers for Parameters in Black-Box Optimization, Tuning and Machine Learning

#' @title Return number of parameters in set.
#'
#' @description
#' Either number of parameters or sum over parameter lengths.
#'
#' @template arg_parset
#' @param devectorize (`logical(1)`)\cr
#'   Sum over length of vector parameters?
#'   Default is code{FALSE}.
#' @return [`integer`].
#' @examples
#' ps = makeParamSet(
#'   makeNumericParam("u"),
#'   makeDiscreteVectorParam("x", len = 2, values = c("a", "b"))
#' )
#' getParamNr(ps)
#' getParamNr(ps, devectorize = TRUE)
#' @export
getParamNr = function(par.set, devectorize = FALSE) {
  assertClass(par.set, "ParamSet")
  assertFlag(devectorize)
  if (devectorize) {
    return(sum(getParamLengths(par.set)))
  } else {
    return(length(par.set$pars))
  }
}