Multi-dimensional array with a compile-time number of dimensions, and a run-time complete freedom over the size of the dimensions. More...

#include <MultiDimArray.h>

Collaboration diagram for MultiDimArray< T, N >:

Public Types
typedef MultiDimArray< T, N >	ThisType
typedef MultiDimArrayTypes< T, N >::SubType	SubType
typedef T::ValueType	ValueType

Public Member Functions
	MultiDimArray ()
	~MultiDimArray ()
	MultiDimArray (const MultiDimArray &)
MultiDimArray &	operator= (const MultiDimArray &)
void	clear ()
SubType &	operator[] (int index)
const SubType &	operator[] (int index) const
int	minIndex () const
int	maxIndex () const
unsigned int	size () const
	Size of this field.
unsigned int	depth () const
	Depth of this field, i.e.
bool	isInRange (int index) const
	Check that an index is in the range of the this field.
unsigned int	totalSize () const
	The total number of elements, including invalid (=default) holes, from this field downwards.
unsigned int	validSize () const
	The total number of valid (=non-default) elements from this field downwards.
void	dump (std::ostream &os=std::cout) const
	Dump the complete table to an output stream.
void	dump (const std::string &prefix, std::ostream &os=std::cout) const
	Dump the complete table to an output stream, with an additional prefix before each line.
std::string	dumpToString () const
	Dump the complete table into a string.
std::string	dumpToString (const std::string &prefix) const
	Dump the complete table into a string, with an additional prefix before each line.
template<class K>
void	dumpOneEntry (const K &indices, std::ostream &os=std::cout) const
	Dump one entry with given indices to an output stream.
template<class K>
std::string	dumpOneEntryToString (const K &indices) const
	Dump one entry with given indices into a string.

Static Public Member Functions
static SubType	defaultSubType ()
static ValueType	defaultValueType ()
static const SubType &	invalidSubType ()

Private Attributes
SubType *	m_data
int	m_minIndex
unsigned int	m_size

Static Private Attributes
static SubType	s_invalidSubType

Detailed Description

template<class T, unsigned int N>
class MultiDimArray< T, N >

Multi-dimensional array with a compile-time number of dimensions, and a run-time complete freedom over the size of the dimensions.

It is used by IdentifierToHash to provide fast access in identifier to hash conversions. It is obtained as a vector of pointers to MultiDimArrayTypes<T,N>.

Definition at line 73 of file MultiDimArray.h.

Member Typedef Documentation

◆ SubType

template<class T, unsigned int N>

typedef MultiDimArrayTypes<T,N>::SubType MultiDimArray< T, N >::SubType

Definition at line 79 of file MultiDimArray.h.

◆ ThisType

template<class T, unsigned int N>

typedef MultiDimArray<T,N> MultiDimArray< T, N >::ThisType

Definition at line 78 of file MultiDimArray.h.

◆ ValueType

template<class T, unsigned int N>

typedef T::ValueType MultiDimArray< T, N >::ValueType

Definition at line 80 of file MultiDimArray.h.

Constructor & Destructor Documentation

◆ MultiDimArray() [1/2]

template<class T, unsigned int N>

MultiDimArray< T, N >::MultiDimArray ( )

inline

Definition at line 162 of file MultiDimArray.h.

   : m_data(0), m_minIndex(0), m_size(0)
{
#ifdef MULTIDIMARRAY_DEBUG
   ++s_objectCount;
   MsgStream log(Athena::getMessageSvc(),"MultiDimArray<T,N>");
   log<<MSG::DEBUG<<"Creating MultiDimArray<" << N << ">" << " at " << this << " #objects: " << s_objectCount<<endmsg;
#endif
}

◆ ~MultiDimArray()

template<class T, unsigned int N>

MultiDimArray< T, N >::~MultiDimArray ( )

inline

Definition at line 173 of file MultiDimArray.h.

                                          {
#ifdef MULTIDIMARRAY_DEBUG
   --s_objectCount;
   MsgStream log(Athena::getMessageSvc(),"MultiDimArray<T,N>");
   log<<MSG::DEBUG<<"Deleting MultiDimArray<" << N << ">" << " at " << this << " #objects: " << s_objectCount<<endmsg;
#endif
   delete[] m_data;
}

◆ MultiDimArray() [2/2]

template<class T, unsigned int N>

MultiDimArray< T, N >::MultiDimArray ( const MultiDimArray< T, N > & rhs )

inline

Definition at line 183 of file MultiDimArray.h.

   : m_data(0), m_minIndex(0), m_size(0)
{
#ifdef MULTIDIMARRAY_DEBUG
   ++s_objectCount;
   MsgStream log(Athena::getMessageSvc(),"MultiDimArray<T,N>");
   log<<MSG::DEBUG<<"Copying  MultiDimArray<" << N << ">" << " at " << this << " #objects: " << s_objectCount<<endmsg;
#endif
   operator=( rhs );
}

Member Function Documentation

◆ clear()

template<class T, unsigned int N>

void MultiDimArray< T, N >::clear ( )

inline

Definition at line 195 of file MultiDimArray.h.

                                      {
   delete[] m_data;
   m_data = 0;
   m_size = 0;
   m_minIndex = 0;
}

◆ defaultSubType()

template<class T, unsigned int N>

MultiDimArray< T, N >::SubType MultiDimArray< T, N >::defaultSubType ( )

inlinestatic

Definition at line 147 of file MultiDimArray.h.

                                                                             {
   return MultiDimArrayTypes<T,N-1>::defaultThisType();
}

◆ defaultValueType()

template<class T, unsigned int N>

MultiDimArray< T, N >::ValueType MultiDimArray< T, N >::defaultValueType ( )

inlinestatic

Definition at line 152 of file MultiDimArray.h.

                                                                                 {
   return MultiDimArrayTypes<T,0>::defaultThisType();
}

◆ depth()

template<class T, unsigned int N>

unsigned int MultiDimArray< T, N >::depth ( ) const

inline

Depth of this field, i.e.

the number of fields from this fields downwards, including this field. It is equal to this field number plus one.

Definition at line 218 of file MultiDimArray.h.

                                                    {
   return N;
}

◆ dump() [1/2]

template<class T, unsigned int N>

void MultiDimArray< T, N >::dump	(	const std::string &	prefix,
		std::ostream &	os = std::cout ) const

inline

Dump the complete table to an output stream, with an additional prefix before each line.

Definition at line 386 of file MultiDimArray.h.

                                                                                    {
   ::dump( *this, os, prefix + "(" );
   os.flush();
}

◆ dump() [2/2]

template<class T, unsigned int N>

void MultiDimArray< T, N >::dump ( std::ostream & os = std::cout ) const

inline

Dump the complete table to an output stream.

Definition at line 380 of file MultiDimArray.h.

                                                           {
   ::dump( *this, os );
   os.flush();
}

◆ dumpOneEntry()

template<class T, unsigned int N>

template<class K>

void MultiDimArray< T, N >::dumpOneEntry	(	const K &	indices,
		std::ostream &	os = std::cout ) const

inline

Dump one entry with given indices to an output stream.

Definition at line 423 of file MultiDimArray.h.

                                                                                     {
   ::dumpOneEntry( *this, indices, os );
}

◆ dumpOneEntryToString()

template<class T, unsigned int N>

template<class K>

std::string MultiDimArray< T, N >::dumpOneEntryToString ( const K & indices ) const

Dump one entry with given indices into a string.

Definition at line 429 of file MultiDimArray.h.

                                                                           {
   std::ostringstream oss;
   dumpOneEntry( indices, oss );
   return oss.str();
}

◆ dumpToString() [1/2]

template<class T, unsigned int N>

std::string MultiDimArray< T, N >::dumpToString ( ) const

inline

Dump the complete table into a string.

Definition at line 392 of file MultiDimArray.h.

                                                        {
   std::ostringstream oss;
   dump( oss );
   return oss.str();
}

◆ dumpToString() [2/2]

template<class T, unsigned int N>

std::string MultiDimArray< T, N >::dumpToString ( const std::string & prefix ) const

inline

Dump the complete table into a string, with an additional prefix before each line.

Definition at line 399 of file MultiDimArray.h.

                                                                                 {
   std::ostringstream oss;
   dump( prefix, oss );
   return oss.str();
}

◆ invalidSubType()

template<class T, unsigned int N>

const MultiDimArray< T, N >::SubType & MultiDimArray< T, N >::invalidSubType ( )

inlinestatic

Definition at line 157 of file MultiDimArray.h.

                                                                                    {
   return s_invalidSubType;
}

◆ isInRange()

template<class T, unsigned int N>

bool MultiDimArray< T, N >::isInRange ( int index ) const

inline

Check that an index is in the range of the this field.

Definition at line 223 of file MultiDimArray.h.

                                                           {
   return index >= minIndex() && index <= maxIndex();
}

◆ maxIndex()

template<class T, unsigned int N>

int MultiDimArray< T, N >::maxIndex ( ) const

inline

Definition at line 208 of file MultiDimArray.h.

                                              {
   return m_minIndex + m_size - 1;
}

◆ minIndex()

template<class T, unsigned int N>

int MultiDimArray< T, N >::minIndex ( ) const

inline

Definition at line 203 of file MultiDimArray.h.

                                              {
   return m_minIndex;
}

◆ operator=()

template<class T, unsigned int N>

MultiDimArray< T, N > & MultiDimArray< T, N >::operator= ( const MultiDimArray< T, N > & rhs )

Definition at line 228 of file MultiDimArray.h.

                                                                                 {
#ifdef MULTIDIMARRAY_DEBUG
   MsgStream log(Athena::getMessageSvc(),"MultiDimArray<T,N>");
   log<<MSG::DEBUG<<"Assigning MultiDimArray<" << N << ">" << " to " << this << " from " << &rhs<<endmsg;
#endif
   // ensure equal data size
   if ( m_size != rhs.m_size ) {
      delete[] m_data;
      m_size = rhs.m_size;
      if ( m_size ) {
     m_data = new SubType[m_size];
      } else {
     m_data = 0;
      }
   }
   // copy the data
   for ( unsigned int i = 0; i < m_size; ++i ) m_data[i] = rhs.m_data[i];
   // set others
   m_minIndex = rhs.m_minIndex;
   
   return *this;
}

◆ operator[]() [1/2]

template<class T, unsigned int N>

MultiDimArray< T, N >::SubType & MultiDimArray< T, N >::operator[] ( int index )

Definition at line 262 of file MultiDimArray.h.

                                                                              {
#ifdef MULTIDIMARRAY_DEBUG
      MsgStream log(Athena::getMessageSvc(),"MultiDimArray<T,N>");
#endif   if ( !m_data ) {
      m_minIndex = index;
      m_size = 1;
      m_data = new SubType[1];
      m_data[0] = s_invalidSubType;
#ifdef MULTIDIMARRAY_DEBUG
      log<<MSG::DEBUG<<"MultiDimArray<" << N << ">::operator["<< index << "]" << " at " << this << ":" << " new data array. size=" << m_size << " range=(" << minIndex() << "," << maxIndex() << ")"<<endmsg;
#endif
   } else if ( index > maxIndex() ) {
      // add to vector at back
      unsigned int oldSize = m_size;
      int nAdd = index - maxIndex();
      m_size += nAdd;
      SubType* newData = new SubType[m_size];
      // copy old data and set new data to invalid
      unsigned int i = 0;
      for ( ; i < oldSize; ++i ) newData[i] = m_data[i];
      for ( ; i < m_size ; ++i ) newData[i] = s_invalidSubType;
      delete[] m_data;
      m_data = newData;
#ifdef MULTIDIMARRAY_DEBUG
      log<<MSG::DEBUG<<"MultiDimArray<" << N << ">::operator["<< index << "]" << " at " << this << ":" << " added " << nAdd << " at back. size=" << m_size << " range=(" << minIndex() << "," << maxIndex() << ")"<<endmsg;
#endif
   } else if ( index < minIndex() ) {
      // add to vector at front
      unsigned int nAdd = minIndex() - index;
      m_size += nAdd;
      SubType* newData = new SubType[m_size];
      // copy old data and set new data to invalid
      unsigned int i = 0;
      for ( ; i < nAdd  ; ++i ) newData[i] = s_invalidSubType;
      for ( ; i < m_size; ++i ) newData[i] = m_data[i-nAdd];
      delete[] m_data;
      m_data = newData;
      m_minIndex = index;
#ifdef MULTIDIMARRAY_DEBUG
      log<<MSG::DEBUG<<"MultiDimArray<" << N << ">::operator["<< index << "]" << " at " << this << ":" << " added " << nAdd << " at front. size=" << m_size << " range=(" << minIndex() << "," << maxIndex() << ")"<<endmsg;
#endif
   }
   // return ref to indexed value
   return m_data[index - m_minIndex];
}

◆ operator[]() [2/2]

template<class T, unsigned int N>

const MultiDimArray< T, N >::SubType & MultiDimArray< T, N >::operator[] ( int index ) const

inline

Definition at line 252 of file MultiDimArray.h.

                                                                                                 {
   if ( !isInRange( index ) ) {
      MsgStream log(Athena::getMessageSvc(),"MultiDimArray<T,N>");
      log<<MSG::WARNING<<"MultiDimArray<" << N << ">::operator["<< index << "]" << " index out of range (" << minIndex() << "," << maxIndex() << ")"<<endmsg;
      return s_invalidSubType;
   }
   return m_data[index - m_minIndex];
}

◆ size()

template<class T, unsigned int N>

unsigned int MultiDimArray< T, N >::size ( ) const

inline

Size of this field.

Definition at line 213 of file MultiDimArray.h.

                                                   {
   return m_size;
}

◆ totalSize()

template<class T, unsigned int N>

unsigned int MultiDimArray< T, N >::totalSize ( ) const

inline

The total number of elements, including invalid (=default) holes, from this field downwards.

Definition at line 348 of file MultiDimArray.h.

                                                        {
   return ::totalSize( *this );
}

◆ validSize()

template<class T, unsigned int N>

unsigned int MultiDimArray< T, N >::validSize ( ) const

inline

The total number of valid (=non-default) elements from this field downwards.

Definition at line 353 of file MultiDimArray.h.

                                                        {
   return ::validSize( *this );
}

Member Data Documentation

◆ m_data

template<class T, unsigned int N>

SubType* MultiDimArray< T, N >::m_data

private

Definition at line 127 of file MultiDimArray.h.

◆ m_minIndex

template<class T, unsigned int N>

int MultiDimArray< T, N >::m_minIndex

private

Definition at line 128 of file MultiDimArray.h.

◆ m_size

template<class T, unsigned int N>

unsigned int MultiDimArray< T, N >::m_size

private

Definition at line 129 of file MultiDimArray.h.

◆ s_invalidSubType

template<class T, unsigned int N>

SubType MultiDimArray< T, N >::s_invalidSubType

staticprivate

Definition at line 130 of file MultiDimArray.h.

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

MultiDimArray.h

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ SubType

◆ ThisType

◆ ValueType

Constructor & Destructor Documentation

◆ MultiDimArray() [1/2]

◆ ~MultiDimArray()

◆ MultiDimArray() [2/2]

Member Function Documentation

◆ clear()

◆ defaultSubType()

◆ defaultValueType()

◆ depth()

◆ dump() [1/2]

◆ dump() [2/2]

◆ dumpOneEntry()

◆ dumpOneEntryToString()

◆ dumpToString() [1/2]

◆ dumpToString() [2/2]

◆ invalidSubType()

◆ isInRange()

◆ maxIndex()

◆ minIndex()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ size()

◆ totalSize()

◆ validSize()

Member Data Documentation

◆ m_data

◆ m_minIndex

◆ m_size

◆ s_invalidSubType