Blaze 3.9
Classes
SymmetricMatrix

Classes

class  blaze::SymmetricMatrix< MT, SO, DF, SF >
 Matrix adapter for symmetric $ N \times N $ matrices. More...
 
class  blaze::NonScalarProxy< MT >
 Access proxy for symmetric, square matrices with non-scalar element types. More...
 
class  blaze::ScalarProxy< MT >
 Access proxy for symmetric, square matrices with scalar element types. More...
 
class  blaze::SharedValue< Type >
 Value shared among several positions within a symmetric matrix. More...
 
class  blaze::SymmetricElement< MT >
 Representation of two synchronized elements within the sparse symmetric matrix. More...
 
class  blaze::SymmetricValue< MT >
 Representation of two synchronized values within a sparse symmetric matrix. More...
 

ScalarProxy global functions

template<typename MT >
void blaze::invert (const ScalarProxy< MT > &proxy)
 In-place inversion of the represented element. More...
 

SharedValue operators

template<typename T1 , typename T2 >
bool blaze::operator== (const SharedValue< T1 > &lhs, const SharedValue< T2 > &rhs)
 Equality comparison between two SharedValue objects. More...
 
template<typename T1 , typename T2 >
bool blaze::operator!= (const SharedValue< T1 > &lhs, const SharedValue< T2 > &rhs)
 Inequality comparison between two SharedValue objects. More...
 

SharedValue global functions

template<RelaxationFlag RF, typename Type >
bool blaze::isDefault (const SharedValue< Type > &value)
 Returns whether the shared value is in default state. More...
 
template<RelaxationFlag RF, typename T1 , typename T2 >
bool blaze::equal (const SharedValue< T1 > &a, const SharedValue< T2 > &b)
 Equality check for a two shared values. More...
 

SymmetricValue global functions

template<typename MT >
void blaze::invert (const SymmetricValue< MT > &value)
 In-place inversion of the symmetric value. More...
 

Detailed Description

Function Documentation

◆ equal()

template<RelaxationFlag RF, typename T1 , typename T2 >
bool blaze::equal ( const SharedValue< T1 > &  a,
const SharedValue< T2 > &  b 
)
inline

Equality check for a two shared values.

Parameters
aThe left-hand side shared value.
bThe right-hand side shared value.
Returns
true if the two shared values are equal, false if not.

This function checks whether the two given shared values are equal, taking the limited machine accuracy into account. In case the two values are equal, the function returns true, otherwise it returns false.

◆ invert() [1/2]

template<typename MT >
void blaze::invert ( const ScalarProxy< MT > &  proxy)
inline

In-place inversion of the represented element.

Parameters
proxyThe given proxy instance.
Returns
void

◆ invert() [2/2]

template<typename MT >
void blaze::invert ( const SymmetricValue< MT > &  value)
inline

In-place inversion of the symmetric value.

Parameters
valueThe given symmetric value.
Returns
void

◆ isDefault()

template<RelaxationFlag RF, typename Type >
bool blaze::isDefault ( const SharedValue< Type > &  value)
inline

Returns whether the shared value is in default state.

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

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

◆ operator!=()

template<typename T1 , typename T2 >
bool blaze::operator!= ( const SharedValue< T1 > &  lhs,
const SharedValue< T2 > &  rhs 
)
inline

Inequality comparison between two SharedValue objects.

Parameters
lhsThe left-hand side SharedValue object.
rhsThe right-hand side SharedValue object.
Returns
true if both shared values refer to different values, false if they don't.

◆ operator==()

template<typename T1 , typename T2 >
bool blaze::operator== ( const SharedValue< T1 > &  lhs,
const SharedValue< T2 > &  rhs 
)
inline

Equality comparison between two SharedValue objects.

Parameters
lhsThe left-hand side SharedValue object.
rhsThe right-hand side SharedValue object.
Returns
true if both shared values refer to the same value, false if they don't.