ClusterFuture-class: A cluster future is a future whose value will be resolved...

In HenrikBengtsson/future: Unified Parallel and Distributed Processing in R for Everyone

A cluster future is a future whose value will be resolved asynchronously in a parallel process

Description

A cluster future is a future whose value will be resolved asynchronously in a parallel process

Usage

ClusterFuture(
  expr = NULL,
  substitute = TRUE,
  envir = parent.frame(),
  persistent = FALSE,
  workers = NULL,
  ...
)

MultisessionFuture(
  expr = NULL,
  substitute = TRUE,
  envir = parent.frame(),
  persistent = FALSE,
  workers = NULL,
  ...
)

Arguments

expr	An R expression.
substitute	If TRUE, argument expr is substitute():ed, otherwise not.
envir	The environment from where global objects should be identified.
persistent	If FALSE, the evaluation environment is cleared from objects prior to the evaluation of the future.
workers	A 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 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.
...	Additional named elements passed to Future().

Value

ClusterFuture() returns an object of class ClusterFuture.

MultisessionFuture() returns an object of class MultisessionFuture, which inherits from ClusterFuture.

Usage

To use 'cluster' futures, use plan(cluster, ...), cf. cluster.

To use 'multisession' futures, use plan(multisession, ...), cf. multisession.

HenrikBengtsson/future documentation built on Dec. 15, 2024, 8:42 p.m.