The R Project SVN R

Rev

Rev 88512 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 88512 Rev 89220
Line 50... Line 50...
50 
    type will become the default type of cluster created by
 50 
    type will become the default type of cluster created by
51 
    \code{makeCluster}. If \code{FALSE} (the default), the default cluster
 51 
    \code{makeCluster}. If \code{FALSE} (the default), the default cluster
52 
    type remains unchanged.}
 52 
    type remains unchanged.}
53 
}
 53 
}
54 
\details{
 54 
\details{
55 
  \code{makeCluster} creates a cluster of one of the supported types.
 55 
  \code{makeCluster} creates a cluster of one of the registered types.
56 
  The default type, \code{"PSOCK"}, calls \code{makePSOCKcluster}.  Type
 56 
  The default type, \code{"PSOCK"}, calls \code{makePSOCKcluster}.  Type
57 
  \code{"FORK"} calls \code{makeForkCluster}.  Other types are passed to
 57 
  \code{"FORK"} calls \code{makeForkCluster}.  Other pre-registered
- 
 
 58 
  types are \code{"SOCK"} for \code{makeSOCKcluster} in package
- 
 
 59 
  \CRANpkg{snow}, \code{"MPI"} for \code{makeMPIcluster} in
- 
 
 60 
  \CRANpkg{snow}, \code{"MIRAI"} for \code{make_cluster} in package
- 
 
 61 
  \CRANpkg{mirai}, and \code{"RPSOCK"} for \code{makeClusterPSOCK} in
58 
  package \CRANpkg{snow}.
 62 
  package \CRANpkg{parallelly}. Calling \code{registerClusterType} with
- 
 
 63 
  no arguments returns a list of currently registered types.
59 
 
 64 
 
60 
  \code{makePSOCKcluster} is an enhanced version of
 65 
  \code{makePSOCKcluster} is an enhanced version of
61 
  \code{makeSOCKcluster} in package \CRANpkg{snow}.  It runs
 66 
  \code{makeSOCKcluster} in package \CRANpkg{snow}.  It runs
62 
  \command{Rscript} on the specified host(s) to set up a worker process
 67 
  \command{Rscript} on the specified host(s) to set up a worker process
63 
  which listens on a socket for expressions to evaluate, and returns the
 68 
  which listens on a socket for expressions to evaluate, and returns the
Line 143... Line 148...
143 
 
 148 
 
144 
  Function \code{setDefaultCluster} registers a cluster as the default one
 149 
  Function \code{setDefaultCluster} registers a cluster as the default one
145 
  for the current session.  Using \code{setDefaultCluster(NULL)} removes
 150 
  for the current session.  Using \code{setDefaultCluster(NULL)} removes
146 
  the registered cluster, as does stopping that cluster.
 151 
  the registered cluster, as does stopping that cluster.
147 
 
 152 
 
148 
  Function \code{registerClusterType} registers a new type of parallel cluster
 153 
  Function \code{registerClusterType} registers a new type of parallel
149 
  in the current session. When \code{makeCluster} is called with the
 154 
  cluster in the current session, or lists the registered types. When
150 
  newly-registered \code{type}, a cluster of that type is created using the
 155 
  \code{makeCluster} is called with the newly-registered \code{type}, a
151 
  \code{starter} function.
 156 
  cluster of that type is created using the \code{starter} function.
152 
}
 157 
}
153 
 
 158 
 
154 
\value{
 159 
\value{
155 
  For the cluster creators, an object of class
 160 
  For the cluster creators, an object of class
156 
  \code{c("SOCKcluster", "cluster")}.
 161 
  \code{c("SOCKcluster", "cluster")}.
157 
 
 162 
 
158 
  For the default cluster setter and getter, the registered default
 163 
  For the default cluster setter and getter, the registered default
159 
  cluster or \code{NULL} if there is no such cluster.
 164 
  cluster or \code{NULL} if there is no such cluster.
160 
 
 165 
 
161 
  \code{registerClusterType} is invoked for its side effect which is to define
 166 
  \code{registerClusterType} is invoked for its side effect which is to
162 
  a mechanism for creating a parallel socket cluster of a given named
 167 
  define a mechanism for creating a parallel socket cluster of a given
- 
 
 168 
  named \code{type}. If called without arguments, a character vector of
163 
  \code{type}.
 169 
  registered cluster types.
164 
}
 170 
}
165 
 
 171 
 
166 
\note{
 172 
\note{
167 
  Option \code{homogeneous = TRUE} was for years documented as
 173 
  Option \code{homogeneous = TRUE} was for years documented as
168 
  \sQuote{Are all the hosts running identical setups?}, but this was
 174 
  \sQuote{Are all the hosts running identical setups?}, but this was