TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType > Class Template Reference

Helper class which adds a range check to an array access if NDEBUG is not defined. More...

#include <TargetBuffer_t.h>

Collaboration diagram for TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >:

Public Member Functions
	BufferBase_t (T_VectorType &buffer)
const T_BaseType &	operator[] (typename std::vector< T_BaseType >::size_type idx) const
const T_BaseType &	upper_bound_at (typename std::vector< T_BaseType >::size_type idx) const

Protected Member Functions
template<typename T1 , typename T2 , typename T3 >
	BufferBase_t (const BufferBase_t< T1, T2, T3 > &buffer)
template<typename T1 , typename T2 , typename T3 >
BufferBase_t &	operator= (const BufferBase_t< T1, T2, T3 > &buffer)
	BufferBase_t (T_BufferType *buffer, typename std::vector< T_BaseType >::size_type max_idx[[maybe_unused]], const std::vector< double > &full_vector[[maybe_unused]])
std::vector< T_BaseType >::size_type	optionalRangeCheck (typename std::vector< T_BaseType >::size_type idx) const
std::vector< T_BaseType >::size_type	optionalRangeCheckUpperBound (typename std::vector< T_BaseType >::size_type idx) const
void	throwRangeError (typename std::vector< T_BaseType >::size_type idx) const

Protected Attributes
T_BufferType *	m_ptr
std::vector< T_BaseType >::size_type	m_maxIndex
const T_BaseType *	m_bufferStart
const T_BaseType *	m_bufferEnd

Friends
class	DoubleBuffer_t
template<typename T1 , typename T2 , typename T3 >
class	BufferBase_t

Detailed Description

template<typename T_BaseType, typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>
class TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >

Helper class which adds a range check to an array access if NDEBUG is not defined.

The helper class only provides read only access to the array, but allows a derived class to add write access if permitted by the base type.

Definition at line 22 of file TargetBuffer_t.h.

Constructor & Destructor Documentation

BufferBase_t() [1/3]

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >::BufferBase_t ( T_VectorType &  buffer )

inline

Definition at line 27 of file TargetBuffer_t.h.

      : m_ptr (&(buffer[0]))
#ifndef NDEBUG
        // debug code
        , m_maxIndex(buffer.size())
        , m_bufferStart(buffer.data())
        , m_bufferEnd(m_bufferStart + buffer.size())//assumed contiguous
#endif
    {
      // cppcheck-suppress missingReturn; false positive
    }

BufferBase_t() [2/3]

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

template<typename T1 , typename T2 , typename T3 >

TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >::BufferBase_t ( const BufferBase_t< T1, T2, T3 > &  buffer )

inlineprotected

Definition at line 42 of file TargetBuffer_t.h.

      : m_ptr(buffer.m_ptr)
#ifndef NDEBUG
      , m_maxIndex(buffer.m_maxIndex)
      , m_bufferStart(buffer.m_bufferStart)
      , m_bufferEnd(buffer.m_bufferEnd)
#endif
    {
      // cppcheck-suppress missingReturn; false positive
    }

BufferBase_t() [3/3]

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >::BufferBase_t ( T_BufferType *  buffer, typename std::vector< T_BaseType >::size_type max_idx]  [[maybe_unused], const std::vector< double > &full_vector]  [[maybe_unused]  )

inlineprotected

Definition at line 67 of file TargetBuffer_t.h.

      : m_ptr(buffer)
#ifndef NDEBUG
        // debug code
        , m_maxIndex(max_idx)
        , m_bufferStart(full_vector.data())
        , m_bufferEnd(m_bufferStart+full_vector.size())//assumed contiguous
#endif
    {
    }

Member Function Documentation

operator=()

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

template<typename T1 , typename T2 , typename T3 >

BufferBase_t& TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >::operator= ( const BufferBase_t< T1, T2, T3 > &  buffer )

inlineprotected

Definition at line 55 of file TargetBuffer_t.h.

    {
      m_ptr=buffer.m_ptr;
#ifndef NDEBUG
      m_maxIndex=buffer.m_maxIndex;
      m_bufferStart=buffer.m_bufferStart;
      m_bufferEnd=buffer.m_bufferEnd;
#endif
      return *this;
    }

operator[]()

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

const T_BaseType& TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >::operator[] ( typename std::vector< T_BaseType >::size_type  idx ) const

inline

Definition at line 81 of file TargetBuffer_t.h.

                                                                                     {
      return m_ptr[optionalRangeCheck(idx)];
    }

optionalRangeCheck()

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

std::vector<T_BaseType>::size_type TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >::optionalRangeCheck ( typename std::vector< T_BaseType >::size_type  idx ) const

inlineprotected

Definition at line 100 of file TargetBuffer_t.h.

                                                                                                                  {
      if (idx>=m_maxIndex || &(m_ptr[idx])<m_bufferStart || &(m_ptr[idx])>=m_bufferEnd) {
        throwRangeError(idx);
      }
      return idx;
    }

optionalRangeCheckUpperBound()

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

std::vector<T_BaseType>::size_type TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >::optionalRangeCheckUpperBound ( typename std::vector< T_BaseType >::size_type  idx ) const

inlineprotected

Definition at line 106 of file TargetBuffer_t.h.

                                                                                                                            {
      // allow for idx==0
      if (idx>0 && (idx-1>=m_maxIndex || &(m_ptr[idx-1])<m_bufferStart || &(m_ptr[idx-1])>=m_bufferEnd)) {
        throwRangeError(idx);
      }
      return idx;
    }

throwRangeError()

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

void TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >::throwRangeError ( typename std::vector< T_BaseType >::size_type  idx ) const

protected

upper_bound_at()

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

const T_BaseType& TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >::upper_bound_at ( typename std::vector< T_BaseType >::size_type  idx ) const

inline

Definition at line 85 of file TargetBuffer_t.h.

                                                                                        {
      return m_ptr[optionalRangeCheckUpperBound(idx)];
    }

Friends And Related Function Documentation

BufferBase_t

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

template<typename T1 , typename T2 , typename T3 >

friend class BufferBase_t

friend

Definition at line 24 of file TargetBuffer_t.h.

DoubleBuffer_t

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

friend class DoubleBuffer_t

friend

Definition at line 23 of file TargetBuffer_t.h.

Member Data Documentation

m_bufferEnd

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

const T_BaseType* TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >::m_bufferEnd

protected

Definition at line 117 of file TargetBuffer_t.h.

m_bufferStart

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

const T_BaseType* TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >::m_bufferStart

protected

Definition at line 116 of file TargetBuffer_t.h.

m_maxIndex

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

std::vector<T_BaseType>::size_type TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >::m_maxIndex

protected

Definition at line 115 of file TargetBuffer_t.h.

m_ptr

template<typename T_BaseType , typename T_BufferType = const T_BaseType, typename T_VectorType = const std::vector<T_BaseType>>

T_BufferType* TTN::BufferBase_t< T_BaseType, T_BufferType, T_VectorType >::m_ptr

protected

Definition at line 90 of file TargetBuffer_t.h.

---

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

• TargetBuffer_t.h