Blaze  3.6
Classes
StrictlyLowerMatrix

Classes

class  blaze::StrictlyLowerMatrix< MT, SO, DF >
 Matrix adapter for strictly lower triangular $ N \times N $ matrices. More...
 
class  blaze::StrictlyLowerProxy< MT >
 Access proxy for strictly lower triangular matrices.The StrictlyLowerProxy provides controlled access to the elements of a non-const strictly lower triangular matrix. It guarantees that the strictly lower matrix invariant is not violated, i.e. that elements on the diagonal and in the upper part of the matrix remain 0. The following example illustrates this by means of a $ 3 \times 3 $ dense strictly lower triangular matrix: More...
 

StrictlyLowerProxy global functions

template<typename MT >
void blaze::reset (const StrictlyLowerProxy< MT > &proxy)
 Resetting the represented element to the default initial values. More...
 
template<typename MT >
void blaze::clear (const StrictlyLowerProxy< MT > &proxy)
 Clearing the represented element. More...
 
template<bool RF, typename MT >
bool blaze::isDefault (const StrictlyLowerProxy< MT > &proxy)
 Returns whether the represented element is in default state. More...
 
template<bool RF, typename MT >
bool blaze::isReal (const StrictlyLowerProxy< MT > &proxy)
 Returns whether the matrix element represents a real number. More...
 
template<bool RF, typename MT >
bool blaze::isZero (const StrictlyLowerProxy< MT > &proxy)
 Returns whether the represented element is 0. More...
 
template<bool RF, typename MT >
bool blaze::isOne (const StrictlyLowerProxy< MT > &proxy)
 Returns whether the represented element is 1. More...
 
template<typename MT >
bool blaze::isnan (const StrictlyLowerProxy< MT > &proxy)
 Returns whether the represented element is not a number. More...
 

StrictlyLowerMatrix operators

template<typename MT , bool SO, bool DF>
void blaze::reset (StrictlyLowerMatrix< MT, SO, DF > &m)
 Resetting the given strictly lower matrix. More...
 
template<typename MT , bool SO, bool DF>
void blaze::reset (StrictlyLowerMatrix< MT, SO, DF > &m, size_t i)
 Resetting the specified row/column of the given strictly lower matrix. More...
 
template<typename MT , bool SO, bool DF>
void blaze::clear (StrictlyLowerMatrix< MT, SO, DF > &m)
 Clearing the given strictly lower matrix. More...
 
template<bool RF, typename MT , bool SO, bool DF>
bool blaze::isDefault (const StrictlyLowerMatrix< MT, SO, DF > &m)
 Returns whether the given strictly lower matrix is in default state. More...
 
template<typename MT , bool SO, bool DF>
bool blaze::isIntact (const StrictlyLowerMatrix< MT, SO, DF > &m)
 Returns whether the invariants of the given strictly lower matrix are intact. More...
 
template<typename MT , bool SO, bool DF>
void blaze::swap (StrictlyLowerMatrix< MT, SO, DF > &a, StrictlyLowerMatrix< MT, SO, DF > &b) noexcept
 Swapping the contents of two matrices. More...
 

Detailed Description

Function Documentation

◆ clear() [1/2]

template<typename MT , bool SO, bool DF>
void blaze::clear ( StrictlyLowerMatrix< MT, SO, DF > &  m)
inline

Clearing the given strictly lower matrix.

Parameters
mThe strictly lower matrix to be cleared.
Returns
void

◆ clear() [2/2]

template<typename MT >
void blaze::clear ( const StrictlyLowerProxy< MT > &  proxy)
inline

Clearing the represented element.

Parameters
proxyThe given access proxy.
Returns
void

This function clears the element represented by the access proxy to its default initial state.

◆ isDefault() [1/2]

template<bool RF, typename MT , bool SO, bool DF>
bool blaze::isDefault ( const StrictlyLowerMatrix< MT, SO, DF > &  m)
inline

Returns whether the given strictly lower matrix is in default state.

Parameters
mThe strictly lower matrix to be tested for its default state.
Returns
true in case the given matrix is in default state, false otherwise.

This function checks whether the strictly lower triangular matrix is in default state. The following example demonstrates the use of the isDefault function:

StrictlyLowerMatrix< DynamicMatrix<int> > A;
// ... Resizing and initialization
if( isDefault( A ) ) { ... }

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

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

◆ isDefault() [2/2]

template<bool RF, typename MT >
bool blaze::isDefault ( const StrictlyLowerProxy< MT > &  proxy)
inline

Returns whether the represented element is in default state.

Parameters
proxyThe given access proxy
Returns
true in case the represented element is in default state, false otherwise.

This function checks whether the element represented by the access proxy is in default state. In case it is in default state, the function returns true, otherwise it returns false.

◆ isIntact()

template<typename MT , bool SO, bool DF>
bool blaze::isIntact ( const StrictlyLowerMatrix< MT, SO, DF > &  m)
inline

Returns whether the invariants of the given strictly lower matrix are intact.

Parameters
mThe strictly lower 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 strictly lower 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:

StrictlyLowerMatrix< DynamicMatrix<int> > A;
// ... Resizing and initialization
if( isIntact( A ) ) { ... }

◆ isnan()

template<typename MT >
bool blaze::isnan ( const StrictlyLowerProxy< MT > &  proxy)
inline

Returns whether the represented element is not a number.

Parameters
proxyThe given access proxy.
Returns
true in case the represented element is in not a number, false otherwise.

This function checks whether the element represented by the access proxy is not a number (NaN). In case it is not a number, the function returns true, otherwise it returns false.

◆ isOne()

template<bool RF, typename MT >
bool blaze::isOne ( const StrictlyLowerProxy< MT > &  proxy)
inline

Returns whether the represented element is 1.

Parameters
proxyThe given access proxy.
Returns
true in case the represented element is 1, false otherwise.

This function checks whether the element represented by the access proxy represents the numeric value 1. In case it is 1, the function returns true, otherwise it returns false.

◆ isReal()

template<bool RF, typename MT >
bool blaze::isReal ( const StrictlyLowerProxy< MT > &  proxy)
inline

Returns whether the matrix element represents a real number.

Parameters
proxyThe given access proxy.
Returns
true in case the matrix element represents a real number, false otherwise.

This function checks whether the element represented by the access proxy represents the a real number. In case the element is of built-in type, the function returns true. In case the element is of complex type, the function returns true if the imaginary part is equal to 0. Otherwise it returns false.

◆ isZero()

template<bool RF, typename MT >
bool blaze::isZero ( const StrictlyLowerProxy< MT > &  proxy)
inline

Returns whether the represented element is 0.

Parameters
proxyThe given access proxy.
Returns
true in case the represented element is 0, false otherwise.

This function checks whether the element represented by the access proxy represents the numeric value 0. In case it is 0, the function returns true, otherwise it returns false.

◆ reset() [1/3]

template<typename MT , bool SO, bool DF>
void blaze::reset ( StrictlyLowerMatrix< MT, SO, DF > &  m)
inline

Resetting the given strictly lower matrix.

Parameters
mThe strictly lower matrix to be resetted.
Returns
void

◆ reset() [2/3]

template<typename MT , bool SO, bool DF>
void blaze::reset ( StrictlyLowerMatrix< MT, SO, DF > &  m,
size_t  i 
)
inline

Resetting the specified row/column of the given strictly lower matrix.

Parameters
mThe strictly lower matrix to be resetted.
iThe index of the row/column to be resetted.
Returns
void

This function resets the values in the specified row/column of the given strictly lower matrix to their default value. In case the given matrix is a rowMajor matrix the function resets the values in row i, if it is a columnMajor matrix the function resets the values in column i. Note that the capacity of the row/column remains unchanged.

◆ reset() [3/3]

template<typename MT >
void blaze::reset ( const StrictlyLowerProxy< MT > &  proxy)
inline

Resetting the represented element to the default initial values.

Parameters
proxyThe given access proxy.
Returns
void

This function resets the element represented by the access proxy to its default initial value.

◆ swap()

template<typename MT , bool SO, bool DF>
void blaze::swap ( StrictlyLowerMatrix< MT, SO, DF > &  a,
StrictlyLowerMatrix< MT, SO, DF > &  b 
)
inlinenoexcept

Swapping the contents of two matrices.

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