eformat::PagedMemory< TMAXPAGES >::const_iterator Class Reference

#include <PagedMemory.h>

Public Member Functions
	const_iterator ()
	const_iterator (const const_iterator &other)
	~const_iterator ()
const_iterator &	operator= (const const_iterator &other)
bool	operator!= (const const_iterator &other) const
bool	operator== (const const_iterator &other) const
uint32_t	operator[] (size_t pos) const
uint32_t	at (size_t pos) const
uint32_t	operator* (void) const
const_iterator &	operator++ (void)
const_iterator &	operator-- ()
const_iterator &	operator+= (size_t offset)
const_iterator &	operator-= (size_t offset)
bool	operator< (const const_iterator &other) const
bool	operator> (const const_iterator &other) const
int32_t	operator- (const const_iterator &other) const

Friends
class	PagedMemory

Detailed Description

template<unsigned int TMAXPAGES = 128>
class eformat::PagedMemory< TMAXPAGES >::const_iterator

Defines an iterator-like type for this type of memory. There are no guarantees on the iteration. The user should test and only iterate from begin() till end()

Definition at line 101 of file PagedMemory.h.

Constructor & Destructor Documentation

const_iterator() [1/2]

template<unsigned int TMAXPAGES = 128>

eformat::PagedMemory< TMAXPAGES >::const_iterator::const_iterator ( )

inline

Returns an iterator that points nowhere, to fake similar behaviour as the normal pointers.

Definition at line 125 of file PagedMemory.h.

: m_node(), m_off() {}

const_iterator() [2/2]

template<unsigned int TMAXPAGES = 128>

eformat::PagedMemory< TMAXPAGES >::const_iterator::const_iterator ( const const_iterator &  other )

inline

Copies the value of an iterator

Parameters

other

The iterator to copy the data from

Definition at line 132 of file PagedMemory.h.

    : m_node(other.m_node), m_off(other.m_off) {}

~const_iterator()

template<unsigned int TMAXPAGES = 128>

eformat::PagedMemory< TMAXPAGES >::const_iterator::~const_iterator ( )

inline

Destroys an iterator

Definition at line 138 of file PagedMemory.h.

{}

Member Function Documentation

at()

template<unsigned int TMAXPAGES>

uint32_t eformat::PagedMemory< TMAXPAGES >::const_iterator::at

(

size_t

pos

)

const

Gets a value away N positions from this iterator, checked and may throw an exception

Parameters

pos	The number "N" of positions away from this iterator

Definition at line 330 of file PagedMemory.h.

{
  //immediate return (most of the cases)
  if (m_off + pos < m_node->end) { //trying to reach data on the current page
    return CAST32(m_node->page->iov_base)[(m_off+pos)-m_node->start];
  }
 
  //immediate points of failure
  if (!m_node || (m_node->next == 0 && (m_off+pos) >= m_node->end))
    throw EFORMAT_OUT_OF_BOUNDS(0, pos << 2);
 
  //if I get here, the data is on another page and the request might still be
  //out of bounds, so watch.
  const_iterator it = *this;
  it += pos;
  return it.at(0);
}

Referenced by eformat::PagedMemory< TMAXPAGES >::const_iterator::at().

operator!=()

template<unsigned int TMAXPAGES = 128>

bool eformat::PagedMemory< TMAXPAGES >::const_iterator::operator!=

(

const const_iterator &

other

)

const

Compares two pointers

Parameters

other

The other iterator to compare this one with.

Definition at line 310 of file PagedMemory.h.

{
  return (m_node == other.m_node && m_off == other.m_off)?false:true;
}

operator*()

template<unsigned int TMAXPAGES = 128>

uint32_t eformat::PagedMemory< TMAXPAGES >::const_iterator::operator* ( void  ) const

inline

Gets the current value for the pointed position, as a 32-bit integer. This is unchecked so you have to make sure you are before end().

Definition at line 182 of file PagedMemory.h.

      { return CAST32(m_node->page->iov_base)[m_off-m_node->start]; }

operator++()

template<unsigned int TMAXPAGES>

eformat::PagedMemory< TMAXPAGES >::const_iterator & eformat::PagedMemory< TMAXPAGES >::const_iterator::operator++

(

void

)

Advances forward on the pointing place, 4 bytes or 1 word. This is the prefix operator.

Definition at line 349 of file PagedMemory.h.

{ 
  ++m_off;
  if ( m_off >= (m_node->end) ) {
    if (!m_node->next) { //it was the last
      m_off = m_node->end;
      return *this;
    }
    m_node = m_node->next;
    m_off = m_node->start;
  }
  return *this; 
}

operator+=()

template<unsigned int TMAXPAGES>

eformat::PagedMemory< TMAXPAGES >::const_iterator & eformat::PagedMemory< TMAXPAGES >::const_iterator::operator+=

(

size_t

offset

)

Advances forward on the pointing place, by a number of (32-bit) words

Parameters

offset

The amount of words to advance

Definition at line 379 of file PagedMemory.h.

{
  size_t aim = offset + m_off;
  while (aim >= (m_node->end)) {
    if (m_node->next) m_node = m_node->next;
    else { //it was the last
      m_off = m_node->end;
      return *this;
    }
  }
  m_off = aim;
  return *this;
}

operator-()

template<unsigned int TMAXPAGES = 128>

int32_t eformat::PagedMemory< TMAXPAGES >::const_iterator::operator- ( const const_iterator &  other ) const

inline

Returns the difference in position between two iterators

Parameters

other

The other iterator to compare to

Definition at line 232 of file PagedMemory.h.

      { return (int32_t)m_off - (int32_t)other.m_off; }

operator--()

template<unsigned int TMAXPAGES>

eformat::PagedMemory< TMAXPAGES >::const_iterator & eformat::PagedMemory< TMAXPAGES >::const_iterator::operator--

(

void

)

Step back on the pointing place, 4 bytes or 1 word. This is the prefix operator.

Definition at line 364 of file PagedMemory.h.

{ 
  --m_off;
  if ( m_off < (m_node->start) ) {
    if (!m_node->previous) { //it was the last
      m_off = m_node->start;
      return *this;
    }
    m_node = m_node->previous;
    m_off = m_node->end - 1;
  }
  return *this; 
}

operator-=()

template<unsigned int TMAXPAGES>

eformat::PagedMemory< TMAXPAGES >::const_iterator & eformat::PagedMemory< TMAXPAGES >::const_iterator::operator-=

(

size_t

offset

)

Retrocesses on the pointing place, by a number of (32-bit) words

Parameters

offset

The amount of words to advance

Definition at line 394 of file PagedMemory.h.

{
  size_t aim = m_off - offset;
  while (aim < (m_node->start)) {
    if (m_node->previous) m_node = m_node->previous;
    else { //it was the first
      m_off = m_node->start;
      return *this;
    }
  }
  m_off = aim;
  return *this;
}

operator<()

template<unsigned int TMAXPAGES = 128>

bool eformat::PagedMemory< TMAXPAGES >::const_iterator::operator< ( const const_iterator &  other ) const

inline

Compares two operators (offset comparison)

Parameters

other

The other iterator to compare to

Definition at line 216 of file PagedMemory.h.

      { return m_off < other.m_off; }

operator=()

template<unsigned int TMAXPAGES = 128>

eformat::PagedMemory< TMAXPAGES >::const_iterator & eformat::PagedMemory< TMAXPAGES >::const_iterator::operator=

(

const const_iterator &

other

)

Copies the value of an iterator

Parameters

other

The iterator to copy the data from

Definition at line 301 of file PagedMemory.h.

{
  m_node = other.m_node;
  m_off = other.m_off;
  return *this;
}

operator==()

template<unsigned int TMAXPAGES = 128>

bool eformat::PagedMemory< TMAXPAGES >::const_iterator::operator== ( const const_iterator &  other ) const

inline

Compares two pointers

Parameters

other

The other iterator to compare this one with.

Definition at line 159 of file PagedMemory.h.

      { return !(*this != other); }

operator>()

template<unsigned int TMAXPAGES = 128>

bool eformat::PagedMemory< TMAXPAGES >::const_iterator::operator> ( const const_iterator &  other ) const

inline

Compares two operators (offset comparison)

Parameters

other

The other iterator to compare to

Definition at line 224 of file PagedMemory.h.

      { return m_off > other.m_off; }

operator[]()

template<unsigned int TMAXPAGES>

uint32_t eformat::PagedMemory< TMAXPAGES >::const_iterator::operator[]

(

size_t

pos

)

const

Gets a value away N positions from this iterator, unchecked

Parameters

pos	The number "N" of positions away from this iterator

Definition at line 317 of file PagedMemory.h.

{
  if (m_off + pos < m_node->end) { //trying to reach data on the current page
    return CAST32(m_node->page->iov_base)[(m_off+pos)-m_node->start];
  }
  //otherwise it is not on this page, I have to find the page
  const_iterator it = *this;
  it += pos;
  return *it;
}

Friends And Related Function Documentation

PagedMemory

template<unsigned int TMAXPAGES = 128>

friend class PagedMemory

friend

Definition at line 105 of file PagedMemory.h.

---

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

• PagedMemory.h