R/system-check-scalar-hasCpu.R

In steinbaugh/goalie: Assertive Check Functions

#' Does the current machine have a sufficient number of CPU cores?
#'
#' @name check-scalar-hasCpu
#' @note Updated 2023-08-10.
#'
#' @inherit check return
#'
#' @param n `integer(1)`.
#' Minimum number of CPU cores.
#'
#' @examples
#' ## TRUE ====
#' hasCpu(n = 1L)
#'
#' ## FALSE ====
#' hasCpu(n = Inf)
NULL



#' @rdname check-scalar-hasCpu
#' @export
hasCpu <- function(n) {
    requireNamespaces("AcidBase")
    cpus <- AcidBase::cpus()
    ok <- cpus >= n
    if (!isTRUE(ok)) {
        return(false(
            "Not enough CPU cores: %s (%s) < %s (%s).",
            as.character(cpus), "current",
            as.character(n), "expected"
        ))
    }
    TRUE
}