File: benchmark_std.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 (38 lines) | stat: -rw-r--r-- 970 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
33
34
35
36
37
38
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/benchmark_std.R
\name{benchmark_std}
\alias{benchmark_std}
\title{Run standard benchmarks}
\usage{
benchmark_std(runs = 3, verbose = TRUE, cores = 0L)
}
\arguments{
\item{runs}{Number of times to run the test. Default 3.}

\item{verbose}{Default TRUE.}

\item{cores}{Default 0 (serial). When cores > 0, the benchmark is run in parallel.}
}
\description{
This function runs a set of standard benchmarks, which should be suitable for most
machines. It runs a collection of matrix benchmark functions
\itemize{
\item \code{benchmark_prog}
\item \code{benchmark_matrix_cal}
\item \code{benchmark_matrix_fun}
}
To view the list of benchmarks, see \code{get_available_benchmarks}.
}
\details{
Setting \code{cores} equal to 1 is useful for assessing the impact of the
parallel computing overhead.
}
\examples{
## Benchmark your system
\dontrun{
res = benchmark_std(3)

## Plot results
plot(res)
}
}