isDiagonalVector

C++ Function Reference

1 Signature

bool BigDataStatMeth::DiagonalOps::isDiagonalVector(BigDataStatMeth::hdf5Dataset *ds)

2 Description

Check if dataset represents a diagonal vector.

3 Parameters

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

4 Returns

true if dataset is a valid vector, false if matrix

5 Details

Validates dataset dimensions to determine if it’s a vector (1×N or N×1). A dataset is considered a diagonal vector if it has vector dimensions. Future enhancements could include .diag suffix validation.

6 Call Graph

7 Source Code

Implementation

File: inst/include/hdf5Utilities/hdf5DiagonalMethods.hpp • Lines 72-80

inline bool isDiagonalVector(BigDataStatMeth::hdf5Dataset* ds)
        {
            hsize_t rows = ds->nrows();
            hsize_t cols = ds->ncols();
            
            return (rows == 1 && cols > 1) ||     // Row vector
                (cols == 1 && rows > 1) ||     // Column vector
                (rows == 1 && cols == 1);      // Scalar
        }

8 Usage Example

#include "BigDataStatMeth.hpp"

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

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

## Signature

```cpp
bool BigDataStatMeth::DiagonalOps::isDiagonalVector(BigDataStatMeth::hdf5Dataset *ds)
```

## Description

Check if dataset represents a diagonal vector.

## Parameters

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

## Returns

true if dataset is a valid vector, false if matrix

## Details

Validates dataset dimensions to determine if it's a vector (1×N or N×1). A dataset is considered a diagonal vector if it has vector dimensions. Future enhancements could include .diag suffix validation.

## Call Graph

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

## Source Code

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

**File:** `inst/include/hdf5Utilities/hdf5DiagonalMethods.hpp` • **Lines 72-80**

```cpp
inline bool isDiagonalVector(BigDataStatMeth::hdf5Dataset* ds)
        {
            hsize_t rows = ds->nrows();
            hsize_t cols = ds->ncols();
            
            return (rows == 1 && cols > 1) ||     // Row vector
                (cols == 1 && rows > 1) ||     // Column vector
                (rows == 1 && cols == 1);      // Scalar
        }
```
:::

## Usage Example

```cpp
#include "BigDataStatMeth.hpp"

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