blaze::DeclIdTrait< MT > Struct Template Reference

Base template for the DeclIdTrait class. More...

#include <DeclIdTrait.h>

Detailed Description

template<typename MT>
struct blaze::DeclIdTrait< MT >

Base template for the DeclIdTrait class.

General

The DeclIdTrait class template offers the possibility to select the resulting data type of a generic declid() operation on the given type MT. DeclIdTrait defines the nested type Type, which represents the resulting data type of the declid() operation. In case the given data type is not a dense or sparse matrix type, the resulting data type Type is set to INVALID_TYPE. Note that const and volatile qualifiers and reference modifiers are generally ignored.

Per default, the DeclIdTrait template only supports the following matrix types:

Creating custom specializations

It is possible to specialize the DeclIdTrait template for additional user-defined matrix types. The following example shows the according specialization for the SymmetricMatrix class template:

template< typename MT, bool SO, bool DF, bool NF >
struct DeclIdTrait< SymmetricMatrix<MT,SO,DF,NF> >
{
using Type = IdentityMatrix< ElementType_<MT>, SO >;
};


Examples

The following example demonstrates the use of the DeclIdTrait template, where depending on the given matrix type the resulting type is selected:

// Definition of the resulting type of a row-major dynamic matrix
using MatrixType1 = DynamicMatrix<int,rowMajor>;
using DeclIdType1 = typename DeclIdTrait<MatrixType1>::Type;
// Definition of the resulting type of a symmetric column-major static matrix
using MatrixType2 = SymmetricMatrix< StaticMatrix<int,3UL,3UL,columnMajor> >;
using DeclIdType2 = typename DeclIdTrait<MatrixType2>::Type;

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