Tomographer  v5.3
Tomographer C++ Framework Documentation
Tomographer::DenseDM::ParamX< DMTypes_ > Class Template Reference

Convert hermitian matrices to vectors via their X Parameterization. More...

#include <tomographer/densedm/param_herm_x.h>

+ Inheritance diagram for Tomographer::DenseDM::ParamX< DMTypes_ >:

Public Types

typedef DMTypes_ DMTypes
 
typedef DMTypes::MatrixType MatrixType
 
typedef DMTypes::MatrixTypeConstRef MatrixTypeConstRef
 
typedef DMTypes::VectorParamType VectorParamType
 
typedef DMTypes::VectorParamTypeConstRef VectorParamTypeConstRef
 
typedef DMTypes::RealScalar RealScalar
 
typedef DMTypes::ComplexScalar ComplexScalar
 
typedef Eigen::Index IndexType
 

Public Member Functions

 ParamX (DMTypes dmt)
 Constructor. Just give it the DMTypes instance. More...
 
VectorParamType HermToX (MatrixTypeConstRef Herm) const
 Get the X-parameterization corresponding to a given hermitian matrix. More...
 
template<bool OnlyLowerTri = false>
MatrixType XToHerm (VectorParamTypeConstRef x) const
 Get the Hermitian matrix parameterized by the "X-parameter" vector x. More...
 
 ParamX ()
 Construct an invalid ParamX object – only for use with Boost.Serialization.
 

Protected Attributes

Eigen::Index dim
 

Detailed Description

template<typename DMTypes_>
class Tomographer::DenseDM::ParamX< DMTypes_ >

Convert hermitian matrices to vectors via their X Parameterization.

Definition at line 58 of file param_herm_x.h.

Constructor & Destructor Documentation

§ ParamX()

template<typename DMTypes_>
Tomographer::DenseDM::ParamX< DMTypes_ >::ParamX ( DMTypes  dmt)
inline

Constructor. Just give it the DMTypes instance.

Definition at line 73 of file param_herm_x.h.

Member Function Documentation

§ HermToX()

template<typename DMTypes_>
VectorParamType Tomographer::DenseDM::ParamX< DMTypes_ >::HermToX ( MatrixTypeConstRef  Herm) const
inline

Get the X-parameterization corresponding to a given hermitian matrix.

See also X Parameterization and XToHerm().

Note
This function only accesses lower triangular part of Herm.

Definition at line 82 of file param_herm_x.h.

§ XToHerm()

template<typename DMTypes_>
template<bool OnlyLowerTri = false>
MatrixType Tomographer::DenseDM::ParamX< DMTypes_ >::XToHerm ( VectorParamTypeConstRef  x) const
inline

Get the Hermitian matrix parameterized by the "X-parameter" vector x.

This calculates the hermitian matrix which is parameterized by x. See X Parameterization.

Definition at line 115 of file param_herm_x.h.


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