CaloCompactCellContainer::compact_input_iterator Class Reference

Simple iterator-like object for reading from the container. More...

#include <CaloCompactCellContainer.h>

Collaboration diagram for CaloCompactCellContainer::compact_input_iterator:

Public Member Functions
	compact_input_iterator (std::vector< value_type >::const_iterator it)
	Constructor.
CaloCompactCell::value_type	next ()
	Return the current value and advance to the next one.
std::vector< value_type >::const_iterator	base () const
	Return the underlying container iterator.

Private Attributes
std::vector< value_type >::const_iterator	m_it
	The iterator in the underlying container type.
value_type	m_word
	The current word.
int	m_count
	Count; used to tell how many more times we need to shift m_word.

Detailed Description

Simple iterator-like object for reading from the container.

This allows reading one CaloCompactCell::value_type object at a time from the container. There is only one method, next(), which returns the next value (and advances the iterator).

Definition at line 155 of file CaloCompactCellContainer.h.

Constructor & Destructor Documentation

compact_input_iterator()

CaloCompactCellContainer::compact_input_iterator::compact_input_iterator ( std::vector< value_type >::const_iterator it )

inline

Constructor.

Parameters

it	value_type iterator at the start of the data (after the header).

Definition at line 287 of file CaloCompactCellContainer.h.

  : m_it (it),
    m_word(0),
    m_count (0)
{
}

Member Function Documentation

base()

std::vector< CaloCompactCellContainer::value_type >::const_iterator CaloCompactCellContainer::compact_input_iterator::base ( ) const

inline

Return the underlying container iterator.

Definition at line 329 of file CaloCompactCellContainer.h.

{
  return m_it;
}

next()

CaloCompactCell::value_type CaloCompactCellContainer::compact_input_iterator::next ( )

inline

Return the current value and advance to the next one.

Definition at line 298 of file CaloCompactCellContainer.h.

{
  // Constants.
  const int mask = static_cast<CaloCompactCell::value_type>(-1);
  const int shift = 8*sizeof (CaloCompactCell::value_type);
  const int ratio =
    sizeof(value_type) / sizeof(CaloCompactCell::value_type);
 
  // Fetch the next @c value_type, if needed.
  if (m_count % ratio == 0)
    m_word = *m_it;
 
  // Mask off the current value.
  CaloCompactCell::value_type ret = m_word & mask;
 
  // Bump the count.
  if (((++m_count)%ratio) == 0) {
    // We wrapped to a new @c value_type.  Bump the underlying iterator.
    ++m_it;
  }
  else {
    // Same @c value_type --- shift the word over.
    m_word >>= shift;
  }
 
  return ret;
}

Member Data Documentation

m_count

int CaloCompactCellContainer::compact_input_iterator::m_count

private

Count; used to tell how many more times we need to shift m_word.

Definition at line 187 of file CaloCompactCellContainer.h.

m_it

std::vector<value_type>::const_iterator CaloCompactCellContainer::compact_input_iterator::m_it

private

The iterator in the underlying container type.

Definition at line 180 of file CaloCompactCellContainer.h.

m_word

value_type CaloCompactCellContainer::compact_input_iterator::m_word

private

The current word.

This gets shifted to the right as we consume values from it.

Definition at line 184 of file CaloCompactCellContainer.h.

---

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

• CaloCompactCellContainer.h