Blaze  3.6
blaze::DeclLowTrait< MT > Struct Template Reference

Base template for the DeclLowTrait class. More...

#include <DeclLowTrait.h>

Detailed Description

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

Base template for the DeclLowTrait class.

General

The DeclLowTrait class template offers the possibility to select the resulting data type of a generic decllow() operation on the given type MT. DeclLowTrait defines the nested type Type, which represents the resulting data type of the decllow() 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.

Creating custom specializations

Per default, DeclLowTrait supports all matrix types of the Blaze library (including views and adaptors). For all other data types it is possible to specialize the DeclLowTrait template. The following example shows the according specialization for the SymmetricMatrix class template:

template< typename MT, bool SO, bool DF, bool NF >
struct DeclLowTrait< SymmetricMatrix<MT,SO,DF,NF> >
{
using Type = DiagonalMatrix<MT>;
};


Examples

The following example demonstrates the use of the DeclLowTrait 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 DeclLowType1 = typename DeclLowTrait<MatrixType1>::Type;
// Definition of the resulting type of a symmetric column-major static matrix
using MatrixType2 = SymmetricMatrix< StaticMatrix<int,3UL,3UL,columnMajor> >;
using DeclLowType2 = typename DeclLowTrait<MatrixType2>::Type;

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