File: bm_parallel.Rd

package info (click to toggle)
r-cran-benchmarkme 1.0.8-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 404 kB
  • sloc: sh: 13; makefile: 2
file content (32 lines) | stat: -rw-r--r-- 1,027 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/benchmark_parallel.R
\name{bm_parallel}
\alias{bm_parallel}
\title{Benchmark in parallel}
\usage{
bm_parallel(bm, runs, verbose, cores, ...)
}
\arguments{
\item{bm}{character name of benchmark function to run from \code{\link{get_available_benchmarks}}}

\item{runs}{number of runs of benchmark to make}

\item{verbose}{display messages during benchmarking}

\item{cores}{number of cores to benchmark. If cores is specified, the benchmark is also
run for cores = 1 to allow for normalisation.}

\item{...}{additional arguments to pass to \code{bm}}
}
\description{
This function runs benchmarks in parallel to test multithreading
}
\examples{
\dontrun{
bm_parallel("bm_matrix_cal_manip", runs = 3, verbose = TRUE, cores = 2)
bm = c("bm_matrix_cal_manip","bm_matrix_cal_power", "bm_matrix_cal_sort",
       "bm_matrix_cal_cross_product", "bm_matrix_cal_lm")
results = lapply(bm, bm_parallel,
                runs = 5, verbose = TRUE, cores = 2L)
}
}