gem5::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.
	GenericSatCounter (unsigned bits, T initial_val=0)
	Constructor for the counter.
	GenericSatCounter (const GenericSatCounter &other)
	Copy constructor.
GenericSatCounter &	operator= (const GenericSatCounter &other)
	Copy assignment.
	GenericSatCounter (GenericSatCounter &&other)
	Move constructor.
GenericSatCounter &	operator= (GenericSatCounter &&other)
	Move assignment.
void	swap (GenericSatCounter &other)
	Swap the contents of every member of the class.
GenericSatCounter &	operator++ ()
	Pre-increment operator.
GenericSatCounter	operator++ (int)
	Post-increment operator.
GenericSatCounter &	operator-- ()
	Pre-decrement operator.
GenericSatCounter	operator-- (int)
	Post-decrement operator.
GenericSatCounter &	operator>>= (const int &shift)
	Shift-right-assignment.
GenericSatCounter &	operator<<= (const int &shift)
	Shift-left-assignment.
GenericSatCounter &	operator+= (const long long &value)
	Add-assignment.
GenericSatCounter &	operator-= (const long long &value)
	Subtract-assignment.
	operator T () const
	Read the counter's value.
void	reset ()
	Reset the counter to its initial value.
double	calcSaturation () const
	Calculate saturation percentile of the current counter's value with regard to its maximum possible value.
bool	isSaturated () const
	Whether the counter has achieved its maximum value or not.
T	saturate ()
	Saturate the counter.

Private Attributes
T	initialVal
T	maxVal
T	counter

Detailed Description

template<class T>
class gem5::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 60 of file sat_counter.hh.

Constructor & Destructor Documentation

GenericSatCounter()

template<class T >

gem5::GenericSatCounter< T >::GenericSatCounter ( )

delete

The default constructor should never be used.

Member Data Documentation

counter

template<class T >

T gem5::GenericSatCounter< T >::counter

private

Definition at line 331 of file sat_counter.hh.

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

initialVal

template<class T >

T gem5::GenericSatCounter< T >::initialVal

private

Definition at line 329 of file sat_counter.hh.

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

maxVal

template<class T >

T gem5::GenericSatCounter< T >::maxVal

private

Definition at line 330 of file sat_counter.hh.

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

---

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

• base/sat_counter.hh