SUNphi  1.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
SUNphi::ValWithExtreme< T, E > Class Template Reference

Class which keeps track of extreme values of a given type. More...

#include <ValWithExtreme.hpp>

Public Member Functions

const T & extreme () const
 Retrurn extreme value.
 
void reset ()
 Reset to standard value.
 
template<typename V = T>
 ValWithExtreme (const V &init)
 Constructor.
 
 ValWithExtreme ()
 Default constructor.
 
 operator const T & () const
 Implicit cast to const value reference.
 
template<typename V >
ValWithExtreme & operator+= (const V &oth)
 
template<typename V >
ValWithExtreme & operator-= (const V &oth)
 
template<typename V >
ValWithExtreme & operator= (const V &oth)
 

Private Member Functions

ValWithExtreme & updateExtreme ()
 Update the extreme. More...
 

Private Attributes

T val
 Stored value.
 
T extr
 Extreme value.
 

Detailed Description

template<typename T, Extreme E>
class SUNphi::ValWithExtreme< T, E >

Class which keeps track of extreme values of a given type.

Definition at line 24 of file ValWithExtreme.hpp.

Member Function Documentation

template<typename T, Extreme E>
template<typename V >
ValWithExtreme& SUNphi::ValWithExtreme< T, E >::operator+= ( const V &  oth)
inline

Unary operator += with update

Definition at line 119 of file ValWithExtreme.hpp.

template<typename T, Extreme E>
template<typename V >
ValWithExtreme& SUNphi::ValWithExtreme< T, E >::operator-= ( const V &  oth)
inline

Unary operator -= with update

Definition at line 121 of file ValWithExtreme.hpp.

template<typename T, Extreme E>
template<typename V >
ValWithExtreme& SUNphi::ValWithExtreme< T, E >::operator= ( const V &  oth)
inline

Unary operator = with update

Definition at line 123 of file ValWithExtreme.hpp.

template<typename T, Extreme E>
ValWithExtreme& SUNphi::ValWithExtreme< T, E >::updateExtreme ( )
inlineprivate

Update the extreme.

Result of whether it's extreme or not

Definition at line 33 of file ValWithExtreme.hpp.

The documentation for this class was generated from the following file: