foreach: Utilities and Extensions for Foreach Loops

In renozao/NMF: Algorithms and Framework for Nonnegative Matrix Factorization (NMF)

Description

registerDoBackend is a unified register function for foreach backends.

Usage

registerDoBackend(object, ...)

getDoBackend()

setDoBackend(data, cleanup = FALSE)

register(x, ...)

## S3 method for class 'foreach_backend'
register(x, ...)

ForeachBackend(object, ...)

## S4 method for signature 'ANY'
ForeachBackend(object, ...)

## S4 method for signature 'character'
ForeachBackend(object, ...)

## S4 method for signature 'missing'
ForeachBackend(object, ...)

## S4 method for signature ''NULL''
ForeachBackend(object, ...)

## S4 method for signature 'cluster'
ForeachBackend(object, ...)

## S4 method for signature 'numeric'
ForeachBackend(object, ...)

## S4 method for signature 'doParallel_backend'
ForeachBackend(object, cl, type = NULL)

## S4 method for signature 'doParallelMC_backend'
ForeachBackend(object, ...)

## S4 method for signature 'doParallelSNOW_backend'
ForeachBackend(object, ...)

## S4 method for signature 'doPSOCK_backend'
ForeachBackend(object, cl)

## S3 method for class 'doParallel_backend'
register(x, ...)

## S3 method for class 'doMPI_backend'
register(x, ...)

## S4 method for signature 'mpicluster'
ForeachBackend(object, ...)

## S4 method for signature 'doMPI_backend'
ForeachBackend(object, cl)

getDoParHosts(object, ...)

## S4 method for signature 'ANY'
getDoParHosts(object, ...)

getDoParNHosts(object)

Arguments

object	specification of a foreach backend, e.g. ‘SEQ’, ‘PAR’ (for doParallel), ‘MPI’, etc...
...	extra arguments passed to the backend own registration function.
data	internal data of a foreach %dopar% backend.
cleanup	logical that indicates if the previous backend's cleanup procedure should be run, before setting the new backend.
x	specification of a foreach backend
cl	cluster specification: a cluster object or a numeric that indicates the number of nodes to use.
type	type of cluster, See makeCluster.

Methods (by generic)

ForeachBackend:

• ForeachBackend(object = ANY): Default method defined to throw an informative error message, when no other method was found.

• ForeachBackend(object = character): Creates a foreach backend object based on its name.

• ForeachBackend(object = missing): Creates a foreach backend object for the currently registered backend.

• ForeachBackend(object = NULL): Dummy method that returns NULL, defined for correct dispatch.

• ForeachBackend(object = cluster): Creates a doParallel foreach backend that uses the cluster described in object.

• ForeachBackend(object = numeric): Creates a doParallel foreach backend with object processes.

• ForeachBackend(object = doParallel_backend): doParallel-specific backend factory

• ForeachBackend(object = doParallelMC_backend): doParallel-specific backend factory for multicore (fork) clusters

  This method is needed since version 1.0.7 of doParallel, which removed internal function info and defined separate backend names for mc and snow clusters.

• ForeachBackend(object = doParallelSNOW_backend): doParallel-specific backend factory for SNOW clusters.

  This method is needed since version 1.0.7 of doParallel, which removed internal function info and defined separate backend names for mc and snow clusters.

• ForeachBackend(object = doPSOCK_backend): doSNOW-specific backend factory

• ForeachBackend(object = mpicluster): Creates a doMPI foreach backend that uses the MPI cluster described in object.

• ForeachBackend(object = doMPI_backend): doMPI-specific backend factory

getDoParHosts:

• getDoParHosts(object = ANY): Default method that tries to heuristaically infer the number of hosts and in last resort temporarly register the backend and performs a foreach loop, to retrieve the nodename from each worker.

renozao/NMF documentation built on June 14, 2020, 9:35 p.m.