% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/threads.R
\name{roll_threads}
\alias{roll_threads}
\title{Report the Number of Threads Used for Rolling Computations}
\usage{
roll_threads()
}
\value{
An integer scalar: the maximum number of threads used, or
  \code{NA} if the package was compiled without \code{OpenMP} support --
  useful for checking what an installation from sources ended up with.
}
\description{
Reports how many threads the rolling computations would put to work on a
large enough input. The count honors \code{options(RcppRoll.threads)}
where that is set, and otherwise defers to the \code{OpenMP} runtime
default (typically controlled through the \code{OMP_NUM_THREADS}
environment variable). Small inputs are always computed serially, and
results do not depend on the number of threads used.
}
