R/isVector.R

Defines functions isVector.ParamSet isVector.Param isVector

Documented in isVector

#' @title Check parameter / parameter set for vector params.
#'
#' @description
#' `TRUE` if the parameter is a vector parameter or all parameters in the
#' set are vector parameters.
#'
#' @template arg_par_or_set
#' @return `logical(1)`.
#' @export
isVector = function(par) {
  UseMethod("isVector")
}

#' @export
isVector.Param = function(par) {
  isVectorTypeString(par$type)
}

#' @export
isVector.ParamSet = function(par) {
  all(vlapply(par$pars, isVector))
}
berndbischl/ParamHelpers documentation built on Oct. 25, 2022, 10:49 p.m.