agg_make_blocks

C++ Function Reference

1 Signature

void BigDataStatMeth::agg_make_blocks(hsize_t dim, hsize_t block_size, std::vector< hsize_t > &starts, std::vector< hsize_t > &sizes)

2 Description

Compute block start positions and sizes for a single dimension.

3 Parameters

dim (hsize_t): Total size of the dimension to iterate.
block_size (hsize_t): Nominal block size (>= 1).
starts (std::vector< hsize_t > &): Output: start offsets.
sizes (std::vector< hsize_t > &): Output: block sizes (last may be smaller).

4 Details

Fills starts and sizes so that all blocks together cover [0, dim) exactly, with no off-by-one. The last block may be smaller than block_size if dim is not an exact multiple.

5 Caller Graph

6 Source Code

Implementation

File: inst/include/hdf5Algebra/matrixAggregations.hpp • Lines 66-75

inline void agg_make_blocks(hsize_t dim,
                             hsize_t block_size,
                             std::vector<hsize_t>& starts,
                             std::vector<hsize_t>& sizes)
{
    for (hsize_t off = 0; off < dim; off += block_size) {
        starts.push_back(off);
        sizes.push_back(std::min(block_size, dim - off));
    }
}

7 Usage Example

#include "BigDataStatMeth.hpp"

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

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

## Signature

```cpp
void BigDataStatMeth::agg_make_blocks(hsize_t dim, hsize_t block_size, std::vector< hsize_t > &starts, std::vector< hsize_t > &sizes)
```

## Description

Compute block start positions and sizes for a single dimension.

## Parameters

- `dim` (`hsize_t`): Total size of the dimension to iterate.
- `block_size` (`hsize_t`): Nominal block size (>= 1).
- `starts` (`std::vector< hsize_t > &`): Output: start offsets.
- `sizes` (`std::vector< hsize_t > &`): Output: block sizes (last may be smaller).

## Details

Fills starts and sizes so that all blocks together cover [0, dim) exactly, with no off-by-one. The last block may be smaller than block_size if dim is not an exact multiple.

## Caller Graph

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

## Source Code

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

**File:** `inst/include/hdf5Algebra/matrixAggregations.hpp` • **Lines 66-75**

```cpp
inline void agg_make_blocks(hsize_t dim,
                             hsize_t block_size,
                             std::vector<hsize_t>& starts,
                             std::vector<hsize_t>& sizes)
{
    for (hsize_t off = 0; off < dim; off += block_size) {
        starts.push_back(off);
        sizes.push_back(std::min(block_size, dim - off));
    }
}
```
:::

## Usage Example

```cpp
#include "BigDataStatMeth.hpp"

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