get_number_threads

C++ Function Reference

1 Signature

unsigned int get_number_threads(Rcpp::Nullable< int > threads, Rcpp::Nullable< bool > bparal)

2 Parameters

threads (Rcpp::Nullable< int >)
bparal (Rcpp::Nullable< bool >)

3 Returns

Type: unsigned int

4 Call Graph

5 Source Code

Implementation

File: inst/include/Utilities/openme-utils.hpp • Lines 277-298

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

6 Usage Example

#include "BigDataStatMeth.hpp"

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

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

## Signature

```cpp
unsigned int get_number_threads(Rcpp::Nullable< int > threads, Rcpp::Nullable< bool > bparal)
```

## Parameters

- `threads` (`Rcpp::Nullable< int >`)
- `bparal` (`Rcpp::Nullable< bool >`)

## Returns

Type: `unsigned int`

## Call Graph

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

## Source Code

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

**File:** `inst/include/Utilities/openme-utils.hpp` • **Lines 277-298**

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

## Usage Example

```cpp
#include "BigDataStatMeth.hpp"

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