Internal Functions for SNOW-style Parallel Evaluation

The functions documented on this page are primarily for use within BiocParallel to enable SNOW-style parallel evaluation, using communication between manager and worker nodes through sockets.

Usage
"bploop"(manager, ...)
"bploop"(manager, ...)
"bploop"(manager, ...)
"bploop"(manager, X, FUN, ARGFUN, BPPARAM, ...)
"bploop"(manager, ITER, FUN, ARGFUN, BPPARAM, REDUCE, init, reduce.in.order, ...)
Arguments
manager
An object representing the manager node. For workers, this is the node to which the worker will communicate. For managers, this is the form of iteration -- lapply or iterate.
X
A vector of jobs to be performed.
FUN
A function to apply to each job.
ARGFUN
A function accepting an integer value indicating the job number, and returning the job-specific arguments to FUN.
BPPARAM
An instance of a BiocParallelParam class.
ITER
A function used to generate jobs. No more jobs are available when ITER() returns NULL.
REDUCE
(Optional) A function combining two values returned by FUN into a single value.
init
(Optional) Initial value for reduction.
reduce.in.order
(Optional) logical(1) indicating that reduction must occur in the order jobs are dispatched (TRUE) or that reduction can occur in the order jobs are completed (FALSE).
...
Additional arguments, ignored in all cases.
Details

Workers enter a loop. They wait to receive a message (R list) from the manager. The message contains a type element, with evaluation as follows:

“EXEC”
Execute the R code in the message, returning the result to the manager.

“DONE”
Signal termination to the manager, terminate the worker.

Managers under lapply dispatch pre-determined jobs, X, to workers, collecting the results from and dispatching new jobs to the first available worker. The manager returns a list of results, in a one-to-one correspondence with the order of jobs supplied, when all jobs have been evaluated.

Managers under iterate dispatch an undetermined number of jobs to workers, collecting previous jobs from and dispatching new jobs to the first available worker. Dispatch continues until available jobs are exhausted. The return value is by default a list of results in a one-to-one correspondence with the order of jobs supplied. The return value is influenced by REDUCE, init, and reduce.in.order.

Aliases
  • bploop
  • bploop.MPInode
  • bploop.SOCKnode
  • bploop.SOCK0node
  • bploop.lapply
  • bploop.iterate
  • bprunMPIslave
Examples
## These functions are not meant to be called by the end user.
Documentation reproduced from package BiocParallel, version 1.6.2, License: GPL-2 | GPL-3

Community examples

Looks like there are no examples yet.