10#ifndef EIGEN_RANK_REVEALING_BASE_H
11#define EIGEN_RANK_REVEALING_BASE_H
14#include "./InternalHeaderCheck.h"
28template <
typename BlockType,
typename NormsType>
29bool column_norms_with_fallback(
const BlockType& block, NormsType& norms) {
30 using RealScalar =
typename NumTraits<typename BlockType::Scalar>::Real;
31 norms = block.colwise().norm();
32 if (block.size() == 0)
return false;
33 const RealScalar maxnorm = norms.maxCoeff();
34 const RealScalar smallest_accurate =
35 RealScalar(2) * numext::sqrt((std::numeric_limits<RealScalar>::min)() * RealScalar(block.rows())) /
36 NumTraits<RealScalar>::epsilon();
38 if (EIGEN_PREDICT_FALSE(!(maxnorm >= smallest_accurate && maxnorm <= NumTraits<RealScalar>::highest()))) {
39 norms = block.colwise().stableNorm();
57template <
typename Derived>
58class RankRevealingBase {
60 using Scalar =
typename internal::traits<Derived>::Scalar;
61 using RealScalar =
typename NumTraits<Scalar>::Real;
64 : m_usePrescribedThreshold(false),
65 m_prescribedThreshold(RealScalar(0)),
66 m_maxpivot(RealScalar(0)),
67 m_nonzero_pivots(0) {}
88 m_usePrescribedThreshold =
true;
102 m_usePrescribedThreshold =
false;
111 eigen_assert(self().m_isInitialized || m_usePrescribedThreshold);
114 return m_usePrescribedThreshold
115 ? m_prescribedThreshold
116 : NumTraits<Scalar>::epsilon() * RealScalar(4 * (std::min)(self().rows(), self().cols()));
126 eigen_assert(self().m_isInitialized &&
"Decomposition is not initialized.");
127 RealScalar premultiplied_threshold = numext::abs(m_maxpivot) *
threshold();
129 for (Index i = 0; i < m_nonzero_pivots; ++i) result += (self().pivotCoeff(i) > premultiplied_threshold);
140 eigen_assert(self().m_isInitialized &&
"Decomposition is not initialized.");
152 eigen_assert(self().m_isInitialized &&
"Decomposition is not initialized.");
153 return rank() == self().cols();
164 eigen_assert(self().m_isInitialized &&
"Decomposition is not initialized.");
165 return rank() == self().rows();
175 eigen_assert(self().m_isInitialized &&
"Decomposition is not initialized.");
187 eigen_assert(self().m_isInitialized &&
"Decomposition is not initialized.");
188 return m_nonzero_pivots;
197 bool m_usePrescribedThreshold;
198 RealScalar m_prescribedThreshold;
199 RealScalar m_maxpivot;
200 Index m_nonzero_pivots;
203 Derived& self() {
return static_cast<Derived&
>(*this); }
204 const Derived& self()
const {
return static_cast<const Derived&
>(*this); }
Index dimensionOfKernel() const
Definition RankRevealingBase.h:139
bool isInjective() const
Definition RankRevealingBase.h:151
bool isSurjective() const
Definition RankRevealingBase.h:163
Derived & setThreshold(Default_t)
Definition RankRevealingBase.h:101
Derived & setThreshold(const RealScalar &threshold)
Definition RankRevealingBase.h:87
Index nonzeroPivots() const
Definition RankRevealingBase.h:186
RealScalar threshold() const
Definition RankRevealingBase.h:110
RealScalar maxPivot() const
Definition RankRevealingBase.h:194
Index rank() const
Definition RankRevealingBase.h:125
bool isInvertible() const
Definition RankRevealingBase.h:174