GenericSatCounter< T > Class Template Reference

Implements an n bit saturating counter and provides methods to increment, decrement, and read it. More...

#include <sat_counter.hh>

Public Member Functions
	GenericSatCounter ()=delete
	The default constructor should never be used. More...
	GenericSatCounter (unsigned bits, T initial_val=0)
	Constructor for the counter. More...
	GenericSatCounter (const GenericSatCounter &other)
	Copy constructor. More...
GenericSatCounter &	operator= (const GenericSatCounter &other)
	Copy assignment. More...
	GenericSatCounter (GenericSatCounter &&other)
	Move constructor. More...
GenericSatCounter &	operator= (GenericSatCounter &&other)
	Move assignment. More...
void	swap (GenericSatCounter &other)
	Swap the contents of every member of the class. More...
GenericSatCounter &	operator++ ()
	Pre-increment operator. More...
GenericSatCounter	operator++ (int)
	Post-increment operator. More...
GenericSatCounter &	operator-- ()
	Pre-decrement operator. More...
GenericSatCounter	operator-- (int)
	Post-decrement operator. More...
GenericSatCounter &	operator>>= (const int &shift)
	Shift-right-assignment. More...
GenericSatCounter &	operator<<= (const int &shift)
	Shift-left-assignment. More...
GenericSatCounter &	operator+= (const long long &value)
	Add-assignment. More...
GenericSatCounter &	operator-= (const long long &value)
	Subtract-assignment. More...
	operator T () const
	Read the counter's value. More...
void	reset ()
	Reset the counter to its initial value. More...
double	calcSaturation () const
	Calculate saturation percentile of the current counter's value with regard to its maximum possible value. More...
bool	isSaturated () const
	Whether the counter has achieved its maximum value or not. More...
uint8_t	saturate ()
	Saturate the counter. More...

Private Attributes
T	initialVal
T	maxVal
T	counter

Detailed Description

template<class T>
class GenericSatCounter< T >

Implements an n bit saturating counter and provides methods to increment, decrement, and read it.

Template Parameters

T	The type of the underlying counter container.

Definition at line 57 of file sat_counter.hh.

Constructor & Destructor Documentation

GenericSatCounter()

template<class T >

GenericSatCounter< T >::GenericSatCounter ( )

delete

The default constructor should never be used.

Member Data Documentation

counter

template<class T >

T GenericSatCounter< T >::counter

private

Definition at line 328 of file sat_counter.hh.

Referenced by GenericSatCounter< uint8_t >::calcSaturation(), GenericSatCounter< uint8_t >::GenericSatCounter(), Prefetcher::SignaturePath::PatternEntry::getStrideEntry(), Prefetcher::SignaturePathV2::increasePatternEntryCounter(), GenericSatCounter< uint8_t >::isSaturated(), GenericSatCounter< uint8_t >::operator uint8_t(), GenericSatCounter< uint8_t >::operator++(), GenericSatCounter< uint8_t >::operator+=(), GenericSatCounter< uint8_t >::operator--(), GenericSatCounter< uint8_t >::operator-=(), GenericSatCounter< uint8_t >::operator<<=(), GenericSatCounter< uint8_t >::operator=(), GenericSatCounter< uint8_t >::operator>>=(), GenericSatCounter< uint8_t >::reset(), GenericSatCounter< uint8_t >::saturate(), and GenericSatCounter< uint8_t >::swap().

initialVal

template<class T >

T GenericSatCounter< T >::initialVal

private

Definition at line 326 of file sat_counter.hh.

Referenced by GenericSatCounter< uint8_t >::GenericSatCounter(), GenericSatCounter< uint8_t >::operator=(), GenericSatCounter< uint8_t >::reset(), and GenericSatCounter< uint8_t >::swap().

maxVal

template<class T >

T GenericSatCounter< T >::maxVal

private

Definition at line 327 of file sat_counter.hh.

Referenced by GenericSatCounter< uint8_t >::calcSaturation(), GenericSatCounter< uint8_t >::GenericSatCounter(), GenericSatCounter< uint8_t >::isSaturated(), GenericSatCounter< uint8_t >::operator++(), GenericSatCounter< uint8_t >::operator+=(), GenericSatCounter< uint8_t >::operator<<=(), GenericSatCounter< uint8_t >::operator=(), GenericSatCounter< uint8_t >::saturate(), and GenericSatCounter< uint8_t >::swap().

---

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

• base/sat_counter.hh