Blaze 3.9
Classes

Classes

class  blaze::ZeroMatrix< Type, SO, Tag >
 Efficient implementation of an $ M \times N $ zero matrix. More...
 

ZeroMatrix operators

template<RelaxationFlag RF, typename Type , bool SO, typename Tag >
constexpr bool blaze::isDefault (const ZeroMatrix< Type, SO, Tag > &m) noexcept
 Returns whether the given zero matrix is in default state. More...
 
template<typename Type , bool SO, typename Tag >
constexpr bool blaze::isIntact (const ZeroMatrix< Type, SO, Tag > &m) noexcept
 Returns whether the invariants of the given zero matrix are intact. More...
 
template<typename Type , bool SO, typename Tag >
constexpr void blaze::swap (ZeroMatrix< Type, SO, Tag > &a, ZeroMatrix< Type, SO, Tag > &b) noexcept
 Swapping the contents of two zero matrices. More...
 
template<typename T , bool SO = defaultStorageOrder>
constexpr decltype(auto) blaze::zero (size_t m, size_t n) noexcept
 Creating a zero matrix. More...
 
template<typename MT , bool SO>
ZeroMatrix< ElementType_t< MT >, SO > blaze::declzero (const Matrix< MT, SO > &m)
 Declares the given matrix expression m as zero matrix. More...
 

Detailed Description

Function Documentation

◆ declzero()

template<typename MT , bool SO>
ZeroMatrix< ElementType_t< MT >, SO > blaze::declzero ( const Matrix< MT, SO > &  m)
inline

Declares the given matrix expression m as zero matrix.

Parameters
mThe input matrix.
Returns
The redeclared matrix.

The declzero function declares the given dense or sparse matrix expression m as zero matrix. The following example demonstrates the use of the declzero function:

// ... Resizing and initialization
B = declzero( A );
Efficient implementation of a compressed matrix.
Definition: CompressedMatrix.h:239
ZeroMatrix< ElementType_t< MT >, SO > declzero(const Matrix< MT, SO > &m)
Declares the given matrix expression m as zero matrix.
Definition: ZeroMatrix.h:1382

◆ isDefault()

template<RelaxationFlag RF, typename Type , bool SO, typename Tag >
constexpr bool blaze::isDefault ( const ZeroMatrix< Type, SO, Tag > &  m)
constexprnoexcept

Returns whether the given zero matrix is in default state.

Parameters
mThe matrix to be tested for its default state.
Returns
true in case the given matrix's rows and columns are zero, false otherwise.

This function checks whether the zero matrix is in default (constructed) state, i.e. if it's number of rows and columns is 0. In case it is in default state, the function returns true, else it will return false. The following example demonstrates the use of the isDefault() function:

// ... Resizing and initialization
if( isDefault( Z ) ) { ... }
Efficient implementation of an zero matrix.
Definition: ZeroMatrix.h:197
bool isDefault(const DiagonalMatrix< MT, SO, DF > &m)
Returns whether the given diagonal matrix is in default state.
Definition: DiagonalMatrix.h:169

Optionally, it is possible to switch between strict semantics (blaze::strict) and relaxed semantics (blaze::relaxed):

if( isDefault<relaxed>( Z ) ) { ... }

◆ isIntact()

template<typename Type , bool SO, typename Tag >
constexpr bool blaze::isIntact ( const ZeroMatrix< Type, SO, Tag > &  m)
constexprnoexcept

Returns whether the invariants of the given zero matrix are intact.

Parameters
mThe zero matrix to be tested.
Returns
true in case the given matrix's invariants are intact, false otherwise.

This function checks whether the invariants of the zero matrix are intact, i.e. if its state is valid. In case the invariants are intact, the function returns true, else it will return false. The following example demonstrates the use of the isIntact() function:

// ... Resizing and initialization
if( isIntact( Z ) ) { ... }
bool isIntact(const DiagonalMatrix< MT, SO, DF > &m)
Returns whether the invariants of the given diagonal matrix are intact.
Definition: DiagonalMatrix.h:207

◆ swap()

template<typename Type , bool SO, typename Tag >
constexpr void blaze::swap ( ZeroMatrix< Type, SO, Tag > &  a,
ZeroMatrix< Type, SO, Tag > &  b 
)
constexprnoexcept

Swapping the contents of two zero matrices.

Parameters
aThe first matrix to be swapped.
bThe second matrix to be swapped.
Returns
void

◆ zero()

template<typename T , bool SO = defaultStorageOrder>
constexpr decltype(auto) blaze::zero ( size_t  m,
size_t  n 
)
constexprnoexcept

Creating a zero matrix.

Parameters
mThe number of rows of the zero matrix.
nThe number of columns of the zero matrix.
Returns
A zero matrix of the given size.

This function creates a zero matrix of the given element type and size. By default, the resulting zero matrix is a row-major matrix, but it is possible to specify the storage order explicitly:

// Creates the row-major zero matrix
// ( 0, 0, 0, 0, 0 )
// ( 0, 0, 0, 0, 0 )
auto Z1 = zero<int>( 2UL, 5UL );
// Creates the row-major zero matrix
// ( 0.0, 0.0 )
// ( 0.0, 0.0 )
// ( 0.0, 0.0 )
auto Z2 = zero<double,rowMajor>( 3UL, 2UL );
// Creates the column-major zero matrix
// ( 0U, 0U, 0U, 0U, 0U, 0U, 0U )
// ( 0U, 0U, 0U, 0U, 0U, 0U, 0U )
auto Z3 = zero<unsigned int,columnMajor>( 2UL, 7UL );
constexpr decltype(auto) zero(size_t m, size_t n) noexcept
Creating a zero matrix.
Definition: ZeroMatrix.h:1356
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