File: test_sequential.Rd

package info (click to toggle)
r-cran-rcppprogress 0.4.2-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 216 kB
  • sloc: cpp: 490; sh: 13; makefile: 2
file content (29 lines) | stat: -rw-r--r-- 824 bytes parent folder | download | duplicates (4)
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
\name{test_multithreaded}
\alias{test_multithreaded}
\title{
  Test/example of using RcppProgress in multithreaded code
}
\description{
  Test function for the package rngOpenMP in a multithreaded mode.
}
\usage{
  test_multithreaded(max=100, nb=1000, threads=0, display_progress=TRUE)
}
\arguments{
  \item{max}{ number of long computation jobs to perform }
  \item{nb}{ number of interruptible steps a long computaton job is made of }
  \item{threads}{ number of threads to use, or 0 to use the default OpenMP number, that is usually the number of cores }
  \item{display_progress}{ whether to display the progress bar or not }
}
\details{
 Will perform max long jobs made of nb interruptible steps.
 The jobs are parallelized. The computation can be interrupted by the user.
}
\value{
  None
}
\author{
  Karl Forner
}