Tomographer  v1.0a
Tomographer C++ Framework Documentation
Tomographer::MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ > Struct Template Reference

Defines the data types for a particular problem setting. More...

#include <tomographer/qit/matrq.h>

+ Inheritance diagram for Tomographer::MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ >:
+ Collaboration diagram for Tomographer::MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ >:

Public Member Functions

 MatrQ (std::size_t dim_)
 Constructs a data type storage and initializer of given dimension. More...
 
- Public Member Functions inherited from Tomographer::MatrQBaseDimStore< MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ >, FixedDim_!=Eigen::Dynamic >
std::size_t dim () const
 The dimension of the quantum system. See MatrQBase<Derived>::FixedDim.
 
std::size_t dim2 () const
 The squared dimension of the quantum system. See MatrQBase<Derived>::FixedDim2.
 
std::size_t ndof () const
 The squared dimension of the quantum system, minus one. See MatrQBase<Derived>::FixedNdof.
 
 MatrQBaseDimStore (std::size_t dim_)
 
MatrQBase< MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ > >::MatrixType::ConstantReturnType initMatrixType () const
 Zero initializer for a MatrixType. More...
 
MatrQBase< MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ > >::VectorParamType::ConstantReturnType initVectorParamType () const
 Zero initializer for a VectorParamType. More...
 
MatrQBase< MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ > >::VectorParamNdofType::ConstantReturnType initVectorParamNdofType () const
 Zero initializer for a VectorParamNdofType. More...
 
MatrQBase< MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ > >::VectorParamListType::ConstantReturnType initVectorParamListType (std::size_t len) const
 Zero initializer for a VectorParamListType. More...
 
MatrQBase< MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ > >::FreqListType::ConstantReturnType initFreqListType (std::size_t len) const
 Zero initializer for a FreqListType. More...
 

Additional Inherited Members

- Public Types inherited from Tomographer::MatrQBase< MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ > >
enum  
 Values that are either fixed at compile-time, or set to Eigen::Dynamic.
 
typedef tomo_internal::matrq_traits< MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ > >::RealScalar RealScalar
 Real scalar type (usually double)
 
typedef tomo_internal::matrq_traits< MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ > >::ComplexScalar ComplexScalar
 Complex scalar type (usually std::complex<double>)
 
typedef tomo_internal::matrq_traits< MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ > >::IntFreqType IntFreqType
 Integer type, used to count measurement frequencies. (int is fine)
 
typedef Eigen::Matrix< std::complex< RealScalar >, FixedDim, FixedDimMatrixType
 Complex dim x dim Matrix.
 
typedef Eigen::Matrix< RealScalar, FixedDim2, 1 > VectorParamType
 Real dim*dim Vector.
 
typedef Eigen::Matrix< RealScalar, FixedNdof, 1 > VectorParamNdofType
 Real dim*dim-1 Vector.
 
typedef Eigen::Matrix< RealScalar, Eigen::Dynamic, FixedDim2, Eigen::RowMajor, FixedMaxParamList, FixedDim2VectorParamListType
 dynamic Matrix with rows = dim*dim Vectors (row-major) [maximum FixedMaxParamList rows, or Dynamic]
 
typedef Eigen::Array< IntFreqType, Eigen::Dynamic, 1, 0, FixedMaxParamList, 1 > FreqListType
 dynamic Array of integers [maximum FixedMaxParamList entries or Dynamic]
 

Detailed Description

template<int FixedDim_, int FixedMaxParamList_, typename RealScalar_, typename IntFreqType_>
struct Tomographer::MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ >

Defines the data types for a particular problem setting.

The dimension of the problem may either be given at compile-time or fixed at run-time, as per the great tradition of Eigen types.

This function inherits, and thus publicly exposes, the types defined in MatrQBase and the initializer methods defined in MatrQBaseDimStore.

Definition at line 49 of file matrq.h.

Constructor & Destructor Documentation

template<int FixedDim_, int FixedMaxParamList_, typename RealScalar_ , typename IntFreqType_ >
Tomographer::MatrQ< FixedDim_, FixedMaxParamList_, RealScalar_, IntFreqType_ >::MatrQ ( std::size_t  dim_)
inline

Constructs a data type storage and initializer of given dimension.

If the dimension is fixed at compile time, then dim_ must match the fixed dimension (or an assert() will fail). Otherwise, we store the dimension and provide corresponding initializer methods, e.g. initMatrixType() will return a zero initializer for a dim_-by-dim_ matrix.

Definition at line 347 of file matrq.h.


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