Tomographer  v5.3
Tomographer C++ Framework Documentation
Tomographer::MAT::EigenPosSemidefMatrixWithSqrt< EigenType_ >::Params Struct Reference

Parameters to read the positive semidefinite matrix. More...

#include <tomographer/tools/ezmatio.h>

Public Member Functions

 Params (RealScalarType tolerance_=Eigen::NumTraits< RealScalarType >::dummy_precision())
 Constructor, specify the tolerance.
 

Public Attributes

const RealScalarType tolerance
 The tolerance.
 

Detailed Description

template<typename EigenType_>
struct Tomographer::MAT::EigenPosSemidefMatrixWithSqrt< EigenType_ >::Params

Parameters to read the positive semidefinite matrix.

The main parameter is the tolerance. The tolerance is the minimal acceptable eigenvalue of the returned matrix (in any case must be positive).

The tolerance defaults to Eigen's tolerance, typically 1e-12 for double type.

Internally, we use the Tomographer::MathTools::forcePosSemiDef() family of utilities (preserving the total trace of the matrix). This means that the minimal eigenvalue of the returned matrix will be the tolerance.

Definition at line 2096 of file ezmatio.h.


The documentation for this struct was generated from the following file: