1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
#
# Copyright (c) Microsoft. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# this is called to register a parallel backend
#' @title setDoPar
#' @description
#' The `setDoPar` function is used to register a parallel backend with the
#' foreach package. This isn't normally executed by the user. Instead, packages
#' that provide a parallel backend provide a function named `registerDoPar`
#' that calls `setDoPar` using the appropriate arguments.
#' @param fun A function that implements the functionality of `%dopar%`.
#' @param data Data to be passed to the registered function.
#' @param info Function that retrieves information about the backend.
#' @seealso
#' [`%dopar%`]
#' @keywords utilities
#' @export
setDoPar <- function(fun, data=NULL, info=function(data, item) NULL) {
tryCatch(
{
assign('fun', fun, pos=.foreachGlobals, inherits=FALSE)
assign('data', data, pos=.foreachGlobals, inherits=FALSE)
assign('info', info, pos=.foreachGlobals, inherits=FALSE)
}, error = function(e) {
if (exists('fun', where=.foreachGlobals, inherits=FALSE))
remove('fun', envir=.foreachGlobals)
if (exists('data', where=.foreachGlobals, inherits=FALSE))
remove('data', envir=.foreachGlobals)
if (exists('info', where=.foreachGlobals, inherits=FALSE))
remove('info', envir=.foreachGlobals)
e
})
}
|
