getAvailableMemoryMB

C++ Function Reference

1 Signature

size_t BigDataStatMeth::getAvailableMemoryMB()

2 Description

Detects available system memory using R-compatible methods.

3 Returns

size_t Available memory in megabytes (MB)

4 Details

Safely detects available memory using R’s internal functions without external dependencies. Designed for CRAN/Bioconductor compatibility across Windows, Linux, and macOS platforms.

5 Caller Graph

6 Source Code

Implementation

File: inst/include/Utilities/system-utils.hpp • Lines 37-47

inline size_t getAvailableMemoryMB() {
    try {
        #ifdef _WIN32
            Rcpp::Function memSize("memory.size");
            Rcpp::NumericVector memResult = memSize();
            if (memResult.size() > 0 && !Rcpp::NumericVector::is_na(memResult[0]))
                return static_cast<size_t>(memResult[0] * 0.6);
        #endif
    } catch(...) {}
    return 4000;
}

7 Usage Example

#include "BigDataStatMeth.hpp"

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

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

## Signature

```cpp
size_t BigDataStatMeth::getAvailableMemoryMB()
```

## Description

Detects available system memory using R-compatible methods.

## Returns

size_t Available memory in megabytes (MB)

## Details

Safely detects available memory using R's internal functions without external dependencies. Designed for CRAN/Bioconductor compatibility across Windows, Linux, and macOS platforms.

## Caller Graph

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

## Source Code

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

**File:** `inst/include/Utilities/system-utils.hpp` • **Lines 37-47**

```cpp
inline size_t getAvailableMemoryMB() {
    try {
        #ifdef _WIN32
            Rcpp::Function memSize("memory.size");
            Rcpp::NumericVector memResult = memSize();
            if (memResult.size() > 0 && !Rcpp::NumericVector::is_na(memResult[0]))
                return static_cast<size_t>(memResult[0] * 0.6);
        #endif
    } catch(...) {}
    return 4000;
}
```
:::

## Usage Example

```cpp
#include "BigDataStatMeth.hpp"

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