Blaze 3.9
blaze::DeclUppTrait< MT > Struct Template Reference

Base template for the DeclUppTrait class. More...

#include <DeclUppTrait.h>

Inherits decltype evalDeclUppTrait std::declval< MT & >.

Detailed Description

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

Base template for the DeclUppTrait class.

General

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

Creating custom specializations

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

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


Examples

The following example demonstrates the use of the DeclUppTrait 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 DeclUppType1 = typename DeclUppTrait<MatrixType1>::Type;
// Definition of the resulting type of a symmetric column-major static matrix
using MatrixType2 = SymmetricMatrix< StaticMatrix<int,3UL,3UL,columnMajor> >;
using DeclUppType2 = typename DeclUppTrait<MatrixType2>::Type;
Efficient implementation of a dynamic matrix.
Definition: DynamicMatrix.h:242
Efficient implementation of a fixed-sized matrix.
Definition: StaticMatrix.h:249
Matrix adapter for symmetric matrices.
Definition: BaseTemplate.h:614
constexpr bool rowMajor
Storage order flag for row-major matrices.
Definition: StorageOrder.h:71
constexpr bool columnMajor
Storage order flag for column-major matrices.
Definition: StorageOrder.h:99
Base template for the DeclUppTrait class.
Definition: DeclUppTrait.h:126

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