validateVector

C++ Function Reference

1 Signature

hsize_t BigDataStatMeth::validateVector(BigDataStatMeth::hdf5Dataset *ds)

2 Description

Validates that dataset is a vector and returns its size.

3 Parameters

ds (BigDataStatMeth::hdf5Dataset *): HDF5 dataset to validate

4 Returns

Vector size if valid, 0 if not a vector

5 Details

Checks if dataset has vector dimensions (1×N or N×1) and returns the vector length

6 Call Graph

7 Source Code

Implementation

File: inst/include/hdf5Algebra/vectorOperations.hpp • Lines 67-79

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

8 Usage Example

#include "BigDataStatMeth.hpp"

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

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

## Signature

```cpp
hsize_t BigDataStatMeth::validateVector(BigDataStatMeth::hdf5Dataset *ds)
```

## Description

Validates that dataset is a vector and returns its size.

## Parameters

- `ds` (`BigDataStatMeth::hdf5Dataset *`): HDF5 dataset to validate

## Returns

Vector size if valid, 0 if not a vector

## Details

Checks if dataset has vector dimensions (1×N or N×1) and returns the vector length

## Call Graph

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

## Source Code

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

**File:** `inst/include/hdf5Algebra/vectorOperations.hpp` • **Lines 67-79**

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

## Usage Example

```cpp
#include "BigDataStatMeth.hpp"

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