#include <FIFO.h>

Inheritance diagram for FIFO< _T >:

Public Member Functions
	FIFO (unsigned int depth=0)
	FIFO (const FIFO &f)
bool	push (const _T &x)
_T	pop ()
_T &	front ()
_T &	back ()
const _T &	front () const
const _T &	back () const
bool	empty () const
unsigned int	maxSize () const
unsigned int	size () const
void	clear ()
void	printOn (std::ostream &out=cout)
bool	full () const
bool	avail () const
	FIFO (unsigned int depth=0)
	FIFO (const FIFO &f)
bool	push (const _T &x)
_T	pop ()
_T &	front ()
_T &	back ()
const _T &	front () const
const _T &	back () const
bool	empty () const
unsigned int	maxSize () const
unsigned int	size () const
void	clear ()
void	printOn (std::ostream &out=cout)
bool	full () const
bool	avail () const
	FIFO (unsigned int depth=0)
	FIFO (const FIFO &f)
bool	push (const _T &x)
_T	pop ()
_T &	front ()
_T &	back ()
const _T &	front () const
const _T &	back () const
bool	empty () const
unsigned int	maxSize () const
unsigned int	size () const
void	clear ()
void	printOn (std::ostream &out=cout)
bool	full () const
bool	avail () const

Detailed Description

template<class _T>
class FIFO< _T >

Definition at line 20 of file Calibration/facilities/include/facilities/FIFO.h.

Constructor & Destructor Documentation

◆ FIFO() [1/6]

template<class _T>

FIFO< _T >::FIFO ( unsigned int depth = 0 )

inline

Definition at line 23 of file Calibration/facilities/include/facilities/FIFO.h.

                               : vector<_T>(), m_depth( depth ) {
    if ( depth > 0 ) reserve( depth );
 
    // if the depth of the fifo is fixed, then reserve enough space to contain it entirely
    // FIFO operates in two modes: one for a fixed depth,
    // and another for a non-fixed depth (unlimited)
  }

Referenced by FIFO().

◆ FIFO() [2/6]

template<class _T>

FIFO< _T >::FIFO ( const FIFO< _T > & f )

inline

Definition at line 31 of file Calibration/facilities/include/facilities/FIFO.h.

31: vector<_T>( f ), m_depth( f.m_depth ) {}

◆ FIFO() [3/6]

template<class _T>

FIFO< _T >::FIFO ( unsigned int depth = 0 )

inline

Definition at line 23 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

                               : vector<_T>(), m_depth( depth ) {
    if ( depth > 0 ) reserve( depth );
 
    // if the depth of the fifo is fixed, then reserve enough space to contain it entirely
    // FIFO operates in two modes: one for a fixed depth,
    // and another for a non-fixed depth (unlimited)
  }

◆ FIFO() [4/6]

template<class _T>

FIFO< _T >::FIFO ( const FIFO< _T > & f )

inline

Definition at line 31 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

31: vector<_T>( f ), m_depth( f.m_depth ) {}

◆ FIFO() [5/6]

template<class _T>

FIFO< _T >::FIFO ( unsigned int depth = 0 )

inline

Definition at line 23 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

                               : vector<_T>(), m_depth( depth ) {
    if ( depth > 0 ) reserve( depth );
 
    // if the depth of the fifo is fixed, then reserve enough space to contain it entirely
    // FIFO operates in two modes: one for a fixed depth,
    // and another for a non-fixed depth (unlimited)
  }

◆ FIFO() [6/6]

template<class _T>

FIFO< _T >::FIFO ( const FIFO< _T > & f )

inline

Definition at line 31 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

31: vector<_T>( f ), m_depth( f.m_depth ) {}

Member Function Documentation

◆ avail() [1/3]

template<class _T>

bool FIFO< _T >::avail ( ) const

inline

Definition at line 86 of file Calibration/facilities/include/facilities/FIFO.h.

86{ return size() < m_depth; }

FIFO::size

unsigned int size() const

Definition Calibration/facilities/include/facilities/FIFO.h:68

◆ avail() [2/3]

template<class _T>

bool FIFO< _T >::avail ( ) const

inline

Definition at line 86 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

86{ return size() < m_depth; }

◆ avail() [3/3]

template<class _T>

bool FIFO< _T >::avail ( ) const

inline

Definition at line 86 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

86{ return size() < m_depth; }

◆ back() [1/6]

template<class _T>

_T & FIFO< _T >::back ( )

inline

Definition at line 57 of file Calibration/facilities/include/facilities/FIFO.h.

57{ return vector<_T>::back(); }

◆ back() [2/6]

template<class _T>

_T & FIFO< _T >::back ( )

inline

Definition at line 57 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

57{ return vector<_T>::back(); }

◆ back() [3/6]

template<class _T>

_T & FIFO< _T >::back ( )

inline

Definition at line 57 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

57{ return vector<_T>::back(); }

◆ back() [4/6]

template<class _T>

const _T & FIFO< _T >::back ( ) const

inline

Definition at line 60 of file Calibration/facilities/include/facilities/FIFO.h.

60{ return vector<_T>::back(); }

◆ back() [5/6]

template<class _T>

const _T & FIFO< _T >::back ( ) const

inline

Definition at line 60 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

60{ return vector<_T>::back(); }

◆ back() [6/6]

template<class _T>

const _T & FIFO< _T >::back ( ) const

inline

Definition at line 60 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

60{ return vector<_T>::back(); }

◆ clear() [1/3]

template<class _T>

void FIFO< _T >::clear ( )

inline

Definition at line 70 of file Calibration/facilities/include/facilities/FIFO.h.

70{ vector<_T>::clear(); }

◆ clear() [2/3]

template<class _T>

void FIFO< _T >::clear ( )

inline

Definition at line 70 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

70{ vector<_T>::clear(); }

◆ clear() [3/3]

template<class _T>

void FIFO< _T >::clear ( )

inline

Definition at line 70 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

70{ vector<_T>::clear(); }

◆ empty() [1/3]

template<class _T>

bool FIFO< _T >::empty ( ) const

inline

Definition at line 62 of file Calibration/facilities/include/facilities/FIFO.h.

62{ return ( size() == 0 ); }

◆ empty() [2/3]

template<class _T>

bool FIFO< _T >::empty ( ) const

inline

Definition at line 62 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

62{ return ( size() == 0 ); }

◆ empty() [3/3]

template<class _T>

bool FIFO< _T >::empty ( ) const

inline

Definition at line 62 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

62{ return ( size() == 0 ); }

◆ front() [1/6]

template<class _T>

_T & FIFO< _T >::front ( )

inline

Definition at line 56 of file Calibration/facilities/include/facilities/FIFO.h.

56{ return vector<_T>::front(); }

◆ front() [2/6]

template<class _T>

_T & FIFO< _T >::front ( )

inline

Definition at line 56 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

56{ return vector<_T>::front(); }

◆ front() [3/6]

template<class _T>

_T & FIFO< _T >::front ( )

inline

Definition at line 56 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

56{ return vector<_T>::front(); }

◆ front() [4/6]

template<class _T>

const _T & FIFO< _T >::front ( ) const

inline

Definition at line 59 of file Calibration/facilities/include/facilities/FIFO.h.

59{ return vector<_T>::front(); }

◆ front() [5/6]

template<class _T>

const _T & FIFO< _T >::front ( ) const

inline

Definition at line 59 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

59{ return vector<_T>::front(); }

◆ front() [6/6]

template<class _T>

const _T & FIFO< _T >::front ( ) const

inline

Definition at line 59 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

59{ return vector<_T>::front(); }

◆ full() [1/3]

template<class _T>

bool FIFO< _T >::full ( ) const

inline

Definition at line 84 of file Calibration/facilities/include/facilities/FIFO.h.

84{ return size() == m_depth; }

◆ full() [2/3]

template<class _T>

bool FIFO< _T >::full ( ) const

inline

Definition at line 84 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

84{ return size() == m_depth; }

◆ full() [3/3]

template<class _T>

bool FIFO< _T >::full ( ) const

inline

Definition at line 84 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

84{ return size() == m_depth; }

◆ maxSize() [1/3]

template<class _T>

unsigned int FIFO< _T >::maxSize ( ) const

inline

Definition at line 65 of file Calibration/facilities/include/facilities/FIFO.h.

65{ return m_depth; }

◆ maxSize() [2/3]

template<class _T>

unsigned int FIFO< _T >::maxSize ( ) const

inline

Definition at line 65 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

65{ return m_depth; }

◆ maxSize() [3/3]

template<class _T>

unsigned int FIFO< _T >::maxSize ( ) const

inline

Definition at line 65 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

65{ return m_depth; }

◆ pop() [1/3]

template<class _T>

_T FIFO< _T >::pop ( )

inline

Definition at line 46 of file Calibration/facilities/include/facilities/FIFO.h.

           {
    assert( size() > 0 );
    _T value( *begin() );
    erase( begin() );
 
    // limited depth mode
 
    return value;
  }

◆ pop() [2/3]

template<class _T>

_T FIFO< _T >::pop ( )

inline

Definition at line 46 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

           {
    assert( size() > 0 );
    _T value( *begin() );
    erase( begin() );
 
    // limited depth mode
 
    return value;
  }

◆ pop() [3/3]

template<class _T>

_T FIFO< _T >::pop ( )

inline

Definition at line 46 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

           {
    assert( size() > 0 );
    _T value( *begin() );
    erase( begin() );
 
    // limited depth mode
 
    return value;
  }

◆ printOn() [1/3]

template<class _T>

void FIFO< _T >::printOn ( std::ostream & out = cout )

inline

Definition at line 73 of file Calibration/facilities/include/facilities/FIFO.h.

                                       {
    short i = 1;
    for ( vector<_T>::reverse_iterator it = rbegin(); it != rend(); ++it )
    {
      out << ( *it )();
      if ( ( i % 8 ) == 0 ) out << "\n";
      else out << "\t";
      i++;
    }
  }

◆ printOn() [2/3]

template<class _T>

void FIFO< _T >::printOn ( std::ostream & out = cout )

inline

Definition at line 73 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

                                       {
    short i = 1;
    for ( vector<_T>::reverse_iterator it = rbegin(); it != rend(); ++it )
    {
      out << ( *it )();
      if ( ( i % 8 ) == 0 ) out << "\n";
      else out << "\t";
      i++;
    }
  }

◆ printOn() [3/3]

template<class _T>

void FIFO< _T >::printOn ( std::ostream & out = cout )

inline

Definition at line 73 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

                                       {
    short i = 1;
    for ( vector<_T>::reverse_iterator it = rbegin(); it != rend(); ++it )
    {
      out << ( *it )();
      if ( ( i % 8 ) == 0 ) out << "\n";
      else out << "\t";
      i++;
    }
  }

◆ push() [1/3]

template<class _T>

bool FIFO< _T >::push ( const _T & x )

inline

Definition at line 35 of file Calibration/facilities/include/facilities/FIFO.h.

                           {
    if ( ( m_depth != 0 ) && ( size() >= m_depth ) ) return false;
 
    push_back( x );
 
    return true;
  }

◆ push() [2/3]

template<class _T>

bool FIFO< _T >::push ( const _T & x )

inline

Definition at line 35 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

                           {
    if ( ( m_depth != 0 ) && ( size() >= m_depth ) ) return false;
 
    push_back( x );
 
    return true;
  }

◆ push() [3/3]

template<class _T>

bool FIFO< _T >::push ( const _T & x )

inline

Definition at line 35 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

                           {
    if ( ( m_depth != 0 ) && ( size() >= m_depth ) ) return false;
 
    push_back( x );
 
    return true;
  }

◆ size() [1/3]

template<class _T>

unsigned int FIFO< _T >::size ( ) const

inline

Definition at line 68 of file Calibration/facilities/include/facilities/FIFO.h.

68{ return vector<_T>::size(); }

Referenced by avail(), empty(), full(), pop(), and push().

◆ size() [2/3]

template<class _T>

unsigned int FIFO< _T >::size ( ) const

inline

Definition at line 68 of file InstallArea/x86_64-el9-gcc13-dbg/include/facilities/FIFO.h.

68{ return vector<_T>::size(); }

◆ size() [3/3]

template<class _T>

unsigned int FIFO< _T >::size ( ) const

inline

Definition at line 68 of file InstallArea/x86_64-el9-gcc13-opt/include/facilities/FIFO.h.

68{ return vector<_T>::size(); }

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FIFO() [1/6]

◆ FIFO() [2/6]

◆ FIFO() [3/6]

◆ FIFO() [4/6]

◆ FIFO() [5/6]

◆ FIFO() [6/6]

Member Function Documentation

◆ avail() [1/3]

◆ avail() [2/3]

◆ avail() [3/3]

◆ back() [1/6]

◆ back() [2/6]

◆ back() [3/6]

◆ back() [4/6]

◆ back() [5/6]

◆ back() [6/6]

◆ clear() [1/3]

◆ clear() [2/3]

◆ clear() [3/3]

◆ empty() [1/3]

◆ empty() [2/3]

◆ empty() [3/3]

◆ front() [1/6]

◆ front() [2/6]

◆ front() [3/6]

◆ front() [4/6]

◆ front() [5/6]

◆ front() [6/6]

◆ full() [1/3]

◆ full() [2/3]

◆ full() [3/3]

◆ maxSize() [1/3]

◆ maxSize() [2/3]

◆ maxSize() [3/3]

◆ pop() [1/3]

◆ pop() [2/3]

◆ pop() [3/3]

◆ printOn() [1/3]

◆ printOn() [2/3]

◆ printOn() [3/3]

◆ push() [1/3]

◆ push() [2/3]

◆ push() [3/3]

◆ size() [1/3]

◆ size() [2/3]

◆ size() [3/3]