Classes
StrictlyUpperMatrix

Classes

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

StrictlyUpperProxy global functions

template<typename MT >
ConjExprTrait< typename StrictlyUpperProxy< MT >::RepresentedType >::Type blaze::conj (const StrictlyUpperProxy< MT > &proxy)
 Computing the complex conjugate of the represented element. More...
 
template<typename MT >
void blaze::reset (const StrictlyUpperProxy< MT > &proxy)
 Resetting the represented element to the default initial values. More...
 
template<typename MT >
void blaze::clear (const StrictlyUpperProxy< MT > &proxy)
 Clearing the represented element. More...
 
template<typename MT >
bool blaze::isDefault (const StrictlyUpperProxy< MT > &proxy)
 Returns whether the represented element is in default state. More...
 
template<typename MT >
bool blaze::isReal (const StrictlyUpperProxy< MT > &proxy)
 Returns whether the matrix element represents a real number. More...
 
template<typename MT >
bool blaze::isZero (const StrictlyUpperProxy< MT > &proxy)
 Returns whether the represented element is 0. More...
 
template<typename MT >
bool blaze::isOne (const StrictlyUpperProxy< MT > &proxy)
 Returns whether the represented element is 1. More...
 
template<typename MT >
bool blaze::isnan (const StrictlyUpperProxy< MT > &proxy)
 Returns whether the represented element is not a number. More...
 

StrictlyUpperMatrix operators

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

Detailed Description

Function Documentation

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

Clearing the given strictly upper matrix.

Parameters
mThe strictly upper matrix to be cleared.
Returns
void
template<typename MT >
void blaze::clear ( const StrictlyUpperProxy< 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.

template<typename MT >
ConjExprTrait< typename StrictlyUpperProxy< MT >::RepresentedType >::Type blaze::conj ( const StrictlyUpperProxy< MT > &  proxy)
inline

Computing the complex conjugate of the represented element.

Parameters
proxyThe given proxy instance.
Returns
The complex conjugate of the represented element.

This function computes the complex conjugate of the element represented by the access proxy. In case the proxy represents a vector- or matrix-like data structure the function returns an expression representing the complex conjugate of the vector/matrix.

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

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

Parameters
mThe strictly upper matrix to be tested for its default state.
Returns
true in case the given matrix is component-wise zero, false otherwise.

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

StrictlyUpperMatrix< DynamicMatrix<int,rowMajor> > A;
// ... Resizing and initialization
if( isDefault( A ) ) { ... }
template<typename MT >
bool blaze::isDefault ( const StrictlyUpperProxy< 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.

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

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

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

StrictlyUpperMatrix< DynamicMatrix<int> > A;
// ... Resizing and initialization
if( isIntact( A ) ) { ... }
template<typename MT >
bool blaze::isnan ( const StrictlyUpperProxy< 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.

template<typename MT >
bool blaze::isOne ( const StrictlyUpperProxy< 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.

template<typename MT >
bool blaze::isReal ( const StrictlyUpperProxy< 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.

template<typename MT >
bool blaze::isZero ( const StrictlyUpperProxy< 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.

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

Resetting the given strictly upper matrix.

Parameters
mThe strictly upper matrix to be resetted.
Returns
void
template<typename MT , bool SO, bool DF>
void blaze::reset ( StrictlyUpperMatrix< MT, SO, DF > &  m,
size_t  i 
)
inline

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

Parameters
mThe strictly upper 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 upper 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.

template<typename MT >
void blaze::reset ( const StrictlyUpperProxy< 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.

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

Swapping the contents of two matrices.

Parameters
aThe first matrix to be swapped.
bThe second matrix to be swapped.
Returns
void
Exceptions
no-throwguarantee.