The magnitude at or under which a singular value counts as zero, in a rank (matrix_rank), a pseudo-inverse (pinv) or a least-squares solution (lstsq): by default NumPy's, the largest singular value times the machine epsilon times the larger dimension; relative to the largest, as NumPy's rcond and rtol; or absolute, as matrix_rank's tol.
More...
#include <factorizations.hpp>
The magnitude at or under which a singular value counts as zero, in a rank (matrix_rank), a pseudo-inverse (pinv) or a least-squares solution (lstsq): by default NumPy's, the largest singular value times the machine epsilon times the larger dimension; relative to the largest, as NumPy's rcond and rtol; or absolute, as matrix_rank's tol.
Definition at line 3717 of file factorizations.hpp.
◆ rank_cutoff() [1/2]
| constexpr numerical::rank_cutoff::rank_cutoff |
( |
| ) |
|
|
constexprdefaultnoexcept |
NumPy's default: the largest singular value times the machine epsilon times the larger dimension.
◆ rank_cutoff() [2/2]
|
|
inlineconstexprprivatenoexcept |
◆ absolute()
magnitude itself, whatever the largest singular value.
- Exceptions
-
Definition at line 3737 of file factorizations.hpp.
◆ checked()
◆ magnitude()
| double numerical::rank_cutoff::magnitude |
( |
double |
largest, |
|
|
std::size_t |
rows, |
|
|
std::size_t |
cols |
|
) |
| const |
|
inlinenoexcept |
The cutoff for a rows × cols matrix whose largest singular value is largest.
Definition at line 3743 of file factorizations.hpp.
◆ relative()
◆ scaled()
◆ absolute_
| bool numerical::rank_cutoff::absolute_ {false} |
|
private |
◆ value_
| double numerical::rank_cutoff::value_ {-1.0} |
|
private |
The documentation for this class was generated from the following file: