Classes
HermitianMatrix

Classes

class  blaze::HermitianMatrix< MT, SO, DF >
 Matrix adapter for Hermitian $ N \times N $ matrices. More...
 
class  blaze::HermitianElement< MT >
 Representation of two synchronized elements within the sparse Hermitian matrix.The HermitianElement class represents two synchronized elements (i.e. two value/index pairs) within a sparse Hermitian matrix. It guarantees that a modification of element $ a_{ij} $ via iterator is also applied to element $ a_{ji} $. The following example illustrates this by means of a $ 3 \times 3 $ dense Hermitian matrix: More...
 
class  blaze::HermitianProxy< MT >
 Access proxy for Hermitian matrices.The HermitianProxy provides controlled access to the elements of a non-const Hermitian matrix. It guarantees that a modification of element $ a_{ij} $ of the accessed matrix is also applied to element $ a_{ji} $. The following example illustrates this by means of a $ 3 \times 3 $ dense Hermitian matrix: More...
 
class  blaze::HermitianValue< MT >
 Representation of two synchronized values within a sparse Hermitian matrix.The HermitianValue class represents two synchronized values within a sparse Hermitian matrix. It guarantees that a modification of value $ a_{ij} $ via iterator is also applied to the value $ a_{ji} $. The following example illustrates this by means of a $ 3 \times 3 $ sparse Hermitian matrix: More...
 

HermitianProxy global functions

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

HermitianValue global functions

template<typename MT >
void blaze::reset (const HermitianValue< MT > &value)
 Resetting the Hermitian value to the default initial values. More...
 
template<typename MT >
void blaze::clear (const HermitianValue< MT > &value)
 Clearing the Hermitian value. More...
 
template<typename MT >
void blaze::invert (const HermitianValue< MT > &value)
 In-place inversion of the Hermitian value. More...
 
template<typename MT >
bool blaze::isDefault (const HermitianValue< MT > &value)
 Returns whether the Hermitian value is in default state. More...
 
template<typename MT >
bool blaze::isReal (const HermitianValue< MT > &value)
 Returns whether the Hermitian value represents a real number. More...
 
template<typename MT >
bool blaze::isZero (const HermitianValue< MT > &value)
 Returns whether the Hermitian value is 0. More...
 
template<typename MT >
bool blaze::isOne (const HermitianValue< MT > &value)
 Returns whether the Hermitian value is 1. More...
 
template<typename MT >
bool blaze::isnan (const HermitianValue< MT > &value)
 Returns whether the Hermitian value is not a number. More...
 

HermitianMatrix operators

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

Detailed Description

Function Documentation

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

Clearing the given Hermitian matrix.

Parameters
mThe Hermitian matrix to be cleared.
Returns
void
template<typename MT >
void blaze::clear ( const HermitianValue< MT > &  value)
inline

Clearing the Hermitian value.

Parameters
valueThe given Hermitian value.
Returns
void

This function clears the Hermitian value to its default initial state.

template<typename MT >
void blaze::clear ( const HermitianProxy< 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 >
void blaze::invert ( const HermitianValue< MT > &  value)
inline

In-place inversion of the Hermitian value.

Parameters
valueThe given Hermitian value.
Returns
void
template<typename MT >
void blaze::invert ( const HermitianProxy< MT > &  proxy)
inline

In-place inversion of the represented element.

Parameters
proxyThe given proxy instance.
Returns
void
template<typename MT , bool SO, bool DF>
bool blaze::isDefault ( const HermitianMatrix< MT, SO, DF > &  m)
inline

Returns whether the given Hermitian matrix is in default state.

Parameters
mThe Hermitian 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 matrix is in default state. For instance, in case the matrix is instantiated for a built-in integral or floating point data type, the function returns true in case all matrix elements are 0 and false in case any matrix element is not 0. The following example demonstrates the use of the isDefault function:

// ... Resizing and initialization
if( isDefault( A ) ) { ... }
template<typename MT >
bool blaze::isDefault ( const HermitianValue< MT > &  value)
inline

Returns whether the Hermitian value is in default state.

Parameters
valueThe given Hermitian value.
Returns
true in case the Hermitian value is in default state, false otherwise.

This function checks whether the Hermitian value is in default state. In case it is in default state, the function returns true, otherwise it returns false.

template<typename MT >
bool blaze::isDefault ( const HermitianProxy< 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 HermitianMatrix< MT, SO, DF > &  m)
inline

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

Parameters
mThe Hermitian 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 Hermitian 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:

HermitianMatrix< DynamicMatrix<int> > A;
// ... Resizing and initialization
if( isIntact( A ) ) { ... }
template<typename MT >
bool blaze::isnan ( const HermitianValue< MT > &  value)
inline

Returns whether the Hermitian value is not a number.

Parameters
valueThe given Hermitian value.
Returns
true in case the Hermitian value is in not a number, false otherwise.

This function checks whether the Hermitian value 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::isnan ( const HermitianProxy< 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 HermitianValue< MT > &  value)
inline

Returns whether the Hermitian value is 1.

Parameters
valueThe given Hermitian value.
Returns
true in case the Hermitian value is 1, false otherwise.

This function checks whether the Hermitian value represents the numeric value 1. In case it is 1, the function returns true, otherwise it returns false.

template<typename MT >
bool blaze::isOne ( const HermitianProxy< 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 HermitianValue< MT > &  value)
inline

Returns whether the Hermitian value represents a real number.

Parameters
valueThe given Hermitian value.
Returns
true in case the Hermitian value represents a real number, false otherwise.

This function checks whether the Hermitian value represents the a real number. In case the value 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::isReal ( const HermitianProxy< 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 HermitianValue< MT > &  value)
inline

Returns whether the Hermitian value is 0.

Parameters
valueThe given Hermitian value.
Returns
true in case the Hermitian value is 0, false otherwise.

This function checks whether the Hermitian value represents the numeric value 0. In case it is 0, the function returns true, otherwise it returns false.

template<typename MT >
bool blaze::isZero ( const HermitianProxy< 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 ( HermitianMatrix< MT, SO, DF > &  m)
inline

Resetting the given Hermitian matrix.

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

Resetting the specified row/column of the given Hermitian matrix.

Parameters
mThe Hermitian 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 Hermitian 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 HermitianValue< MT > &  value)
inline

Resetting the Hermitian value to the default initial values.

Parameters
valueThe given Hermitian value.
Returns
void

This function resets the Hermitian value to its default initial value.

template<typename MT >
void blaze::reset ( const HermitianProxy< 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 ( HermitianMatrix< MT, SO, DF > &  a,
HermitianMatrix< 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