MulticoreFuture-class

MulticoreFuture

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

internal

The purpose of this package is to provide a lightweight and
unified Future API for sequential and parallel processing of R
expression via futures. The simplest way to evaluate an expression
in parallel is to use `x %<-% { expression }` with `plan(multisession)`.
This package implements sequential, multicore, multisession, and
cluster futures. With these, R expressions can be evaluated on the
local machine, in parallel a set of local machines, or distributed
on a mix of local and remote machines.
Extensions to this package implement additional backends for
processing futures via compute cluster schedulers, etc.
Because of its unified API, there is no need to modify any code in order
switch from sequential on the local machine to, say, distributed
processing on a remote compute cluster.
Another strength of this package is that global variables and functions
are automatically identified and exported as needed, making it
straightforward to tweak existing code to make use of futures.

Henrik Bengtsson

future

Unified Parallel and Distributed Processing in R for Everyone

MulticoreFuture-class function

<dl><dt>expr</dt>
<dd>An R <a href="/link/expression?package=future&version=1.26.1" data-mini-rdoc="future::expression">expression</a>.</dd>
<dt>substitute</dt>
<dd>If TRUE, argument <code>expr</code> is
<code><a href="/link/substitute?package=future&version=1.26.1" data-mini-rdoc="future::substitute">substitute</a>()</code>:ed, otherwise not.</dd>
<dt>envir</dt>
<dd>The <a href="/link/environment?package=future&version=1.26.1" data-mini-rdoc="future::environment">environment</a> from where global objects should be
identified.</dd>
<dt>globals</dt>
<dd>(optional) a logical, a character vector, or a named list
to control how globals are handled.
For details, see section 'Globals used by future expressions'
in the help for <code>future()</code>.</dd>
<dt>lazy</dt>
<dd>If FALSE (default), the future is resolved
eagerly (starting immediately), otherwise not.</dd>
<dt>...</dt>
<dd>Additional named elements passed to <code>Future()</code>.</dd></dl>

Arguments

To use 'multicore' futures, use <code>plan(multicore, ...)</code>, cf. multicore.

Usage

A multicore future is a future whose value will be resolved asynchronously in a parallel process — MulticoreFuture-class

<dl>

<dt>expr</dt>
<dd>An R <a href='https://rdrr.io/r/base/expression.html'>expression</a>.</dd>


<dt>substitute</dt>
<dd>If TRUE, argument <code>expr</code> is
<code><a href='https://rdrr.io/r/base/substitute.html'>substitute</a>()</code>:ed, otherwise not.</dd>


<dt>envir</dt>
<dd>The <a href='https://rdrr.io/r/base/environment.html'>environment</a> from where global objects should be
identified.</dd>


<dt>globals</dt>
<dd>(optional) a logical, a character vector, or a named list
to control how globals are handled.
For details, see section 'Globals used by future expressions'
in the help for <code>future()</code>.</dd>


<dt>lazy</dt>
<dd>If FALSE (default), the future is resolved
eagerly (starting immediately), otherwise not.</dd>


<dt>...</dt>
<dd>Additional named elements passed to <code>Future()</code>.</dd>

</dl>

To use 'multicore' futures, use <code>plan(multicore, ...)</code>, cf. multicore.

MulticoreFuture-class: A multicore future is a future whose value will be resolved asynchronously in a parallel process

Description

Usage

Value

Arguments

Usage