Blaze 3.9
Modules | Classes | Typedefs | Functions | Variables

Modules

 Band
 
 Diagonal
 
 Column
 
 Columns
 
 Elements
 
 Row
 
 Rows
 
 Submatrix
 
 Subvector
 

Classes

struct  blaze::Check< C >
 Template for the blaze::checked and blaze::unchecked instances. More...
 

Typedefs

using blaze::Checked = Check< true >
 Type of the blaze::checked instance. More...
 
using blaze::Unchecked = Check< false >
 Type of the blaze::unchecked instance. More...
 

Functions

template<typename T , typename... Ts>
constexpr auto blaze::getCheck (const T &a, const Ts &... args) noexcept
 Extracting blaze::Check arguments from a given list of arguments. More...
 
template<typename... Ts>
constexpr bool blaze::isChecked (const Ts &... args)
 Extracting blaze::Check arguments from a given list of arguments. More...
 

Variables

constexpr Checked blaze::checked
 Global Checked instance. More...
 
constexpr Unchecked blaze::unchecked
 Global Unchecked instance. More...
 

Detailed Description

Typedef Documentation

◆ Checked

using blaze::Checked = typedef Check<true>

Type of the blaze::checked instance.

blaze::Checked is the type of the blaze::checked instance, which is an optional token for the creation of views. It can be used to enforce runtime checks during the creation of a view (subvectors, submatrices, rows, columns, bands, ...).

◆ Unchecked

using blaze::Unchecked = typedef Check<false>

Type of the blaze::unchecked instance.

blaze::Unchecked is the type of the blaze::unchecked instance, which is an optional token for the creation of views. It can be used to skip all runtime checks during the creation of a view (subvectors, submatrices, rows, columns, bands, ...).

Function Documentation

◆ getCheck()

template<typename T , typename... Ts>
constexpr auto blaze::getCheck ( const T &  a,
const Ts &...  args 
)
constexprnoexcept

Extracting blaze::Check arguments from a given list of arguments.

Parameters
aThe first given argument.
argsThe remaining given arguments.
Returns
blaze::Unchecked if at least one blaze::Unchecked is given, blaze::Checked otherwise.

This function extracts any argument of type blaze::Check from the given list of arguments. It returns an instance of type blaze::Unchecked if at least one argument of type blaze::Unchecked is given, otherwise an instance of blaze::Checked.

◆ isChecked()

template<typename... Ts>
constexpr bool blaze::isChecked ( const Ts &...  args)
constexpr

Extracting blaze::Check arguments from a given list of arguments.

Parameters
argsThe given arguments.
Returns
false if at least one blaze::Unchecked is given, true otherwise.

This function extracts any argument of type blaze::Check from the given list of arguments. It returns false if at least one argument of type blaze::Unchecked is given, otherwise it returns true.

Variable Documentation

◆ checked

constexpr Checked blaze::checked
constexpr

Global Checked instance.

The blaze::checked instance is an optional token for the creation of views. It can be used used to enforce runtime checks during the creation of a view (subvectors, submatrices, rows, columns, bands, ...). The following example demonstrates the setup of a checked subvector:

auto sv = subvector( v, 10UL, 20UL, checked ); // Creating an checked subvector
Efficient implementation of an arbitrary sized vector.
Definition: DynamicVector.h:223
decltype(auto) subvector(Vector< VT, TF > &, RSAs...)
Creating a view on a specific subvector of the given vector.
Definition: Subvector.h:158
constexpr Checked checked
Global Checked instance.
Definition: Check.h:129

◆ unchecked

constexpr Unchecked blaze::unchecked
constexpr

Global Unchecked instance.

The blaze::unchecked instance is an optional token for the creation of views. It can be used to skip all runtime checks during the creation of a view (subvectors, submatrices, rows, columns, bands, ...). The following example demonstrates the setup of an unchecked subvector:

auto sv = subvector( v, 10UL, 20UL, unchecked ); // Creating an unchecked subvector
constexpr Unchecked unchecked
Global Unchecked instance.
Definition: Check.h:146