CLEANUP: Remove ClusterFuture and MultisessionFuture

Author: HenrikBengtsson

NAMESPACE

@@ -97,7 +97,6 @@ export("%plan%")
 export("%seed%")
 export("%stdout%")
 export("%tweak%")
-export(ClusterFuture)
 export(ClusterFutureBackend)
 export(ConstantFuture)
 export(Future)
@@ -114,7 +113,6 @@ export(GlobalEnvFutureError)
 export(GlobalEnvFutureWarning)
 export(MulticoreFutureBackend)
 export(MultiprocessFuture)
-export(MultisessionFuture)
 export(MultisessionFutureBackend)
 export(RngFutureCondition)
 export(RngFutureError)

R/backend_api-ClusterFuture-class.R

@@ -1,102 +1,3 @@
-#' A cluster future is a future whose value will be resolved asynchronously in a parallel process
-#'
-#' @inheritParams MultiprocessFuture-class
-#' @inheritParams Future-class
-#' 
-#' @param persistent If FALSE, the evaluation environment is cleared
-#' from objects prior to the evaluation of the future.
-#' 
-#' @param workers A \code{\link[parallel:makeCluster]{cluster}} object,
-#' a character vector of host names, a positive numeric scalar,
-#' or a function.
-#' If a character vector or a numeric scalar, a `cluster` object
-#' is created using \code{\link[parallelly:makeClusterPSOCK]{makeClusterPSOCK}(workers)}.
-#' If a function, it is called without arguments _when the future
-#' is created_ and its value is used to configure the workers.
-#' The function should return any of the above types.
-#' 
-#' @return
-#' `ClusterFuture()` returns an object of class `ClusterFuture`.
-#'
-#' @section Usage:
-#' To use 'cluster' futures, use `plan(cluster, ...)`, cf. [cluster].
-#'
-#' @aliases MultisessionFuture MultisessionFuture-class
-#' @export
-#' @export MultisessionFuture
-#' @importFrom digest digest
-#' @name ClusterFuture-class
-#' @keywords internal
-ClusterFuture <- function(expr = NULL, substitute = TRUE, envir = parent.frame(), persistent = FALSE, workers = NULL, ...) {
-  if (substitute) expr <- substitute(expr)
-  
-  stop_if_not(is.logical(persistent), length(persistent) == 1L,
-              !is.na(persistent))
-
-  args <- list(...)
-
-  ## Which '...' arguments should be passed to Future() and 
-  ## which should be passed to makeClusterPSOCK()?
-  future_args <- !is.element(names(args), makeClusterPSOCK_args())
-  
-  future <- do.call(MultiprocessFuture, args = c(list(expr = quote(expr), substitute = FALSE, envir = envir, persistent = persistent, node = NA_integer_), args[future_args]), quote = FALSE)
-
-  future <- do.call(as_ClusterFuture, args = c(list(future, workers = workers), args[!future_args]), quote = TRUE)
-  
-  future
-}
-
-
-as_ClusterFuture <- local({
-  getDefaultCluster <- import_parallel_fcn("getDefaultCluster")
-  
-  function(future, workers = NULL, ...) {
-    if (is.function(workers)) workers <- workers()
-    if (is.null(workers)) {
-      workers <- getDefaultCluster()
-      workers <- addCovrLibPath(workers)
-    } else if (is.character(workers) || is.numeric(workers)) {
-      workers <- ClusterRegistry("start", workers = workers, ...)
-    } else {
-      workers <- as.cluster(workers)
-      workers <- addCovrLibPath(workers)
-    }
-    if (!inherits(workers, "cluster")) {
-      stopf("Argument 'workers' is not of class 'cluster': %s", commaq(class(workers)))
-    }
-    stop_if_not(length(workers) > 0)
-  
-  
-    ## Attached workers' session information, unless already done.
-    ## FIXME: We cannot do this here, because it introduces a race condition
-    ## where multiple similar requests may appear at the same time bringing
-    ## the send/receive data to be out of sync and therefore corrupt the
-    ## futures' values.
-    ##  workers <- add_cluster_session_info(workers)
-  
-    ## Attach name to cluster?
-    name <- attr(workers, "name", exact = TRUE)
-    if (is.null(name)) {
-      name <- digest(workers)
-      stop_if_not(length(name) > 0, nzchar(name))
-      attr(workers, "name") <- name
-    }
-  
-    future[["backend"]] <- list(
-      workers = workers, 
-          reg = sprintf("workers-%s", attr(workers, "name", exact = TRUE))
-    )
-  
-    ## FIXME: To be cleaned out /HB 2025-02-19
-    future[["workers"]] <- workers
-    
-    future <- structure(future, class = c("ClusterFuture", class(future)))
-  
-    future
-  }
-})
-
-
 getSocketSelectTimeout <- function(future, timeout = NULL) {
   if (!is.null(timeout)) return(timeout)
 

R/backend_api-MultisessionFuture-class.R

@@ -27,14 +27,25 @@
 #' plan(cluster, workers = c("localhost", "n1", "n1", "pi.example.org"))
 #' ```
 #'
-#' @inheritParams ClusterFuture-class
 #' @inheritParams Future-class
 #' @inheritParams future
 #'
-#' @param \dots Additional named elements passed to [ClusterFuture()].
+#' @param workers A \code{\link[parallel:makeCluster]{cluster}} object,
+#' a character vector of host names, a positive numeric scalar,
+#' or a function.
+#' If a character vector or a numeric scalar, a `cluster` object
+#' is created using \code{\link[parallelly:makeClusterPSOCK]{makeClusterPSOCK}(workers)}.
+#' If a function, it is called without arguments _when the future
+#' is created_ and its value is used to configure the workers.
+#' The function should return any of the above types.
+#'
+#' @param persistent If FALSE, the evaluation environment is cleared
+#' from objects prior to the evaluation of the future.
+#' 
+#' @param \dots Additional named elements passed to [Future()].
 #'
 #' @return
-#' A \link{ClusterFuture}.
+#' A ClusterFuture.
 #'
 #' @example incl/cluster.R
 #'

R/backend_api-cluster.R

@@ -36,7 +36,7 @@
 #' This is passed down as-is to [parallelly::makeClusterPSOCK()].
 #'
 #' @return
-#' A \link{MultisessionFuture}.
+#' A MultisessionFuture.
 #' If `workers == 1`, then all processing is done in the
 #' current/main \R session and we therefore fall back to using a
 #' lazy future.  To override this fallback, use `workers = I(1)`.