numkit-doxy/balance_8hpp_source.html

// toolboxes/linalg/include/nk/linalg/balance.hpp

//

// MATLAB balance: diagonal-similarity scaling for eigenvalue

// computations. Migrated from toolboxes/builtin/src/language/arrays/balance.cpp.


#pragma once


#include <memory_resource>

#include <nk/value/value.hpp>


namespace nk::linalg {


struct BalanceResult {

    Value B;

    Value d_col;

    Value perm_col;

};


BalanceResult balance_impl(const Value &A, bool noperm,

                           std::pmr::memory_resource *mr = nullptr);


} // namespace nk::linalg

nk::Value
Core MATLAB-compatible multidimensional array and scalar value type.
Definition value.hpp:61

nk::linalg::balance_impl
BalanceResult balance_impl(const Value &A, bool noperm, std::pmr::memory_resource *mr=nullptr)
Diagonal-similarity balancing for eigenvalue computations ([B, d, p] = balance(A, noperm)).

nk::linalg::BalanceResult
Result of balance_impl.
Definition balance.hpp:20

nk::linalg::BalanceResult::d_col
Value d_col
Column of scaling factors.
Definition balance.hpp:22

nk::linalg::BalanceResult::perm_col
Value perm_col
Column of permutation indices (1..n in v1).
Definition balance.hpp:23

nk::linalg::BalanceResult::B
Value B
Balanced matrix.
Definition balance.hpp:21