getSymmetricSortRule

C++ Function Reference

1 Signature

Spectra::SortRule BigDataStatMeth::getSymmetricSortRule(const std::string &which)

2 Description

Convert ‘which’ string to Spectra SortRule for symmetric matrices.

3 Parameters

which (const std::string &): String indicating which eigenvalues to compute

4 Returns

Corresponding Spectra SortRule for symmetric eigenproblems

5 Details

whichString indicating which eigenvalues to compute Corresponding Spectra SortRule for symmetric eigenproblems

6 Caller Graph

7 Source Code

Implementation

File: inst/include/hdf5Algebra/matrixEigenDecomposition.hpp • Lines 40-47

inline Spectra::SortRule getSymmetricSortRule(const std::string& which) {
        if (which == "LA") return Spectra::SortRule::LargestAlge;
        if (which == "SA") return Spectra::SortRule::SmallestAlge;
        if (which == "LM") return Spectra::SortRule::LargestMagn;
        if (which == "SM") return Spectra::SortRule::SmallestMagn;
        // Default to largest magnitude for symmetric matrices
        return Spectra::SortRule::LargestMagn;
    }

8 Usage Example

#include "BigDataStatMeth.hpp"

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

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

## Signature

```cpp
Spectra::SortRule BigDataStatMeth::getSymmetricSortRule(const std::string &which)
```

## Description

Convert 'which' string to Spectra SortRule for symmetric matrices.

## Parameters

- `which` (`const std::string &`): String indicating which eigenvalues to compute

## Returns

Corresponding Spectra SortRule for symmetric eigenproblems

## Details

whichString indicating which eigenvalues to compute Corresponding Spectra SortRule for symmetric eigenproblems

## Caller Graph

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

## Source Code

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

**File:** `inst/include/hdf5Algebra/matrixEigenDecomposition.hpp` • **Lines 40-47**

```cpp
inline Spectra::SortRule getSymmetricSortRule(const std::string& which) {
        if (which == "LA") return Spectra::SortRule::LargestAlge;
        if (which == "SA") return Spectra::SortRule::SmallestAlge;
        if (which == "LM") return Spectra::SortRule::LargestMagn;
        if (which == "SM") return Spectra::SortRule::SmallestMagn;
        // Default to largest magnitude for symmetric matrices
        return Spectra::SortRule::LargestMagn;
    }
```
:::

## Usage Example

```cpp
#include "BigDataStatMeth.hpp"

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