get_HDF5_scalar_mean

C++ Function Reference

1 Signature

double BigDataStatMeth::get_HDF5_scalar_mean(BigDataStatMeth::hdf5Dataset *dsA, bool bparal, Rcpp::Nullable< int > wsize, Rcpp::Nullable< int > threads)

2 Description

Mean of all elements of an HDF5 matrix.

3 Parameters

dsA (BigDataStatMeth::hdf5Dataset *): Open HDF5 dataset.
bparal (bool): Enable OpenMP parallelism.
wsize (Rcpp::Nullable< int >): Block size (NULL = auto).
threads (Rcpp::Nullable< int >): Thread count (NULL = auto).

4 Returns

Scalar mean.

5 Details

Equivalent to mean(X).

6 Call Graph

7 Source Code

Implementation

File: inst/include/hdf5Algebra/matrixAggregations.hpp • Lines 956-969

inline double get_HDF5_scalar_mean(BigDataStatMeth::hdf5Dataset* dsA,
                                    bool bparal,
                                    Rcpp::Nullable<int> wsize,
                                    Rcpp::Nullable<int> threads)
{
    try {
        const double N = static_cast<double>(dsA->nrows()) *
                         static_cast<double>(dsA->ncols());
        return get_HDF5_scalar_sum(dsA, bparal, wsize, threads) / N;
    } catch (std::exception& e) {
        throw std::runtime_error(std::string("c++ exception get_HDF5_scalar_mean: ")
                                 + e.what());
    }
}

8 Usage Example

#include "BigDataStatMeth.hpp"

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

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

## Signature

```cpp
double BigDataStatMeth::get_HDF5_scalar_mean(BigDataStatMeth::hdf5Dataset *dsA, bool bparal, Rcpp::Nullable< int > wsize, Rcpp::Nullable< int > threads)
```

## Description

Mean of all elements of an HDF5 matrix.

## Parameters

- `dsA` (`BigDataStatMeth::hdf5Dataset *`): Open HDF5 dataset.
- `bparal` (`bool`): Enable OpenMP parallelism.
- `wsize` (`Rcpp::Nullable< int >`): Block size (NULL = auto).
- `threads` (`Rcpp::Nullable< int >`): Thread count (NULL = auto).

## Returns

Scalar mean.

## Details

Equivalent to mean(X).

## Call Graph

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

## Source Code

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

**File:** `inst/include/hdf5Algebra/matrixAggregations.hpp` • **Lines 956-969**

```cpp
inline double get_HDF5_scalar_mean(BigDataStatMeth::hdf5Dataset* dsA,
                                    bool bparal,
                                    Rcpp::Nullable<int> wsize,
                                    Rcpp::Nullable<int> threads)
{
    try {
        const double N = static_cast<double>(dsA->nrows()) *
                         static_cast<double>(dsA->ncols());
        return get_HDF5_scalar_sum(dsA, bparal, wsize, threads) / N;
    } catch (std::exception& e) {
        throw std::runtime_error(std::string("c++ exception get_HDF5_scalar_mean: ")
                                 + e.what());
    }
}
```
:::

## Usage Example

```cpp
#include "BigDataStatMeth.hpp"

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