validateVectorDataset

C++ Function Reference

1 Signature

hsize_t BigDataStatMeth::DiagonalOps::validateVectorDataset(BigDataStatMeth::hdf5Dataset *ds)

2 Description

Validate vector dataset and return its size.

3 Parameters

ds (BigDataStatMeth::hdf5Dataset *): Dataset to validate

4 Returns

Vector size if valid vector, 0 if not a vector

5 Details

Checks dataset dimensions and returns the number of elements in the vector. Used for dimension validation before performing vector operations.

6 Call Graph

7 Source Code

Implementation

File: inst/include/hdf5Utilities/hdf5DiagonalMethods.hpp • Lines 38-51

inline hsize_t validateVectorDataset(BigDataStatMeth::hdf5Dataset* ds)
        {
            hsize_t rows = ds->nrows();
            hsize_t cols = ds->ncols();
            
            if (rows == 1 && cols > 1) {
                return cols;  // Row vector 1×N
            } else if (cols == 1 && rows > 1) {
                return rows;  // Column vector N×1
            } else if (rows == 1 && cols == 1) {
                return 1;     // Scalar 1×1
            }
            return 0;  // Not a vector (matrix N×M)
        }

8 Usage Example

#include "BigDataStatMeth.hpp"

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

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

## Signature

```cpp
hsize_t BigDataStatMeth::DiagonalOps::validateVectorDataset(BigDataStatMeth::hdf5Dataset *ds)
```

## Description

Validate vector dataset and return its size.

## Parameters

- `ds` (`BigDataStatMeth::hdf5Dataset *`): Dataset to validate

## Returns

Vector size if valid vector, 0 if not a vector

## Details

Checks dataset dimensions and returns the number of elements in the vector. Used for dimension validation before performing vector operations.

## Call Graph

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

## Source Code

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

**File:** `inst/include/hdf5Utilities/hdf5DiagonalMethods.hpp` • **Lines 38-51**

```cpp
inline hsize_t validateVectorDataset(BigDataStatMeth::hdf5Dataset* ds)
        {
            hsize_t rows = ds->nrows();
            hsize_t cols = ds->ncols();
            
            if (rows == 1 && cols > 1) {
                return cols;  // Row vector 1×N
            } else if (cols == 1 && rows > 1) {
                return rows;  // Column vector N×1
            } else if (rows == 1 && cols == 1) {
                return 1;     // Scalar 1×1
            }
            return 0;  // Not a vector (matrix N×M)
        }
```
:::

## Usage Example

```cpp
#include "BigDataStatMeth.hpp"

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