get_threads

C++ Function Reference

1 Signature

unsigned int BigDataStatMeth::get_threads(bool bparal, Rcpp::Nullable< int > threads=R_NilValue)

2 Description

Determines number of threads for parallel operations.

3 Parameters

bparal (bool): Whether to use parallel processing
threads (Rcpp::Nullable< int >): Optional number of threads to use

4 Returns

unsigned int Number of threads to use

5 Details

bparalWhether to use parallel processing threadsOptional number of threads to use unsigned int Number of threads to use Thread determination:Considers hardware concurrencyRespects user-specified thread countFalls back to single thread if parallel disabledOptimizes for system resources

6 Call Graph

7 Source Code

Implementation

File: inst/include/Utilities/Utilities.hpp • Lines 541-560

inline unsigned int get_threads(bool bparal, Rcpp::Nullable<int> threads = R_NilValue) 
    {
        unsigned int ithreads = std::thread::hardware_concurrency();
        
        if(bparal == false) {
            ithreads = 1;
        } else {
            if(threads.isNotNull()) {
                
                if ((unsigned)Rcpp::as<int> (threads) <= ithreads){
                    ithreads = Rcpp::as<int> (threads);
                } 
            
            } else {
                ithreads =  getDTthreads(ithreads, false);
            }    
        }
        
        return(ithreads);
    }

8 Usage Example

#include "BigDataStatMeth.hpp"

// Example usage
auto result = get_threads(...);

---
title: "get_threads"
subtitle: "C++ Function Reference"
---

## Signature

```cpp
unsigned int BigDataStatMeth::get_threads(bool bparal, Rcpp::Nullable< int > threads=R_NilValue)
```

## Description

Determines number of threads for parallel operations.

## Parameters

- `bparal` (`bool`): Whether to use parallel processing
- `threads` (`Rcpp::Nullable< int >`): Optional number of threads to use

## Returns

unsigned int Number of threads to use

## Details

bparalWhether to use parallel processing threadsOptional number of threads to use unsigned int Number of threads to use
Thread determination:Considers hardware concurrencyRespects user-specified thread countFalls back to single thread if parallel disabledOptimizes for system resources

## Call Graph

::: {.diagram-section}
<object type="image/svg+xml" data="images/namespace_big_data_stat_meth_aa45d0a23a84ef2af8d4ec641ecaca518_cgraph.svg" class="class-diagram">
  <img src="images/namespace_big_data_stat_meth_aa45d0a23a84ef2af8d4ec641ecaca518_cgraph.svg" alt="Function dependencies"/>
</object>
:::

## Source Code

::: {.callout-note collapse="true"}
### Implementation

**File:** `inst/include/Utilities/Utilities.hpp` • **Lines 541-560**

```cpp
inline unsigned int get_threads(bool bparal, Rcpp::Nullable<int> threads = R_NilValue) 
    {
        unsigned int ithreads = std::thread::hardware_concurrency();
        
        if(bparal == false) {
            ithreads = 1;
        } else {
            if(threads.isNotNull()) {
                
                if ((unsigned)Rcpp::as<int> (threads) <= ithreads){
                    ithreads = Rcpp::as<int> (threads);
                } 
            
            } else {
                ithreads =  getDTthreads(ithreads, false);
            }    
        }
        
        return(ithreads);
    }
```
:::

## Usage Example

```cpp
#include "BigDataStatMeth.hpp"

// Example usage
auto result = get_threads(...);
```