lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t Struct Reference

Structure with the index of the counter, split as needed. More...

#include "CountersMap.h"

Public Member Functions
	CounterKey_t ()
	CounterKey_t (BlockKey_t major, CounterIndex_t minor)
	Constructor from a pair. More...
	CounterKey_t (Key_t key)
	Initialize from a mangled key. More...
Key_t	Key () const
	Returns the full key. More...
	operator Key_t () const
	Conversion of this key into a number (. More...
CounterKey_t &	operator++ ()
CounterKey_t &	operator-- ()
CounterKey_t &	operator++ (int)
CounterKey_t &	operator-- (int)
CounterKey_t &	start_block ()
	Skips to the beginning of this block. More...
CounterKey_t &	prev_block ()
	Skips to the beginning of the previous block. More...
CounterKey_t &	next_block ()
	Skips to the beginning of the next block. More...

Public Attributes
BlockKey_t	block
	key of the counter block More...
CounterIndex_t	counter
	index of the counter in the block More...

Static Public Attributes
static constexpr Key_t	MinorKeyRange = NSubcounters
	Number of values of the minor key. More...
static constexpr Key_t	MinorKeyBits = LowestSetBit(MinorKeyRange)
	Number of bits for the minor key. More...
static constexpr Key_t	MinorKeyMask = MinorKeyRange - 1
	Bit mask for the minor key. More...

Detailed Description

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>
struct lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t

Structure with the index of the counter, split as needed.

Definition at line 275 of file CountersMap.h.

Constructor & Destructor Documentation

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::CounterKey_t ( )

inline

Definition at line 280 of file CountersMap.h.

: block(0), counter(0) {}

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::CounterKey_t ( BlockKey_t  major, CounterIndex_t  minor  )

inline

Constructor from a pair.

Definition at line 283 of file CountersMap.h.

: block(major), counter(minor) {}

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::CounterKey_t ( Key_t  key )

inline

Initialize from a mangled key.

Definition at line 286 of file CountersMap.h.

        : //    CounterKey_t(key >> MinorKeyBits, key & MinorKeyMask) {}
        CounterKey_t(key & ~MinorKeyMask, key & MinorKeyMask)
      {}

Member Function Documentation

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

Key_t lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::Key ( ) const

inline

Returns the full key.

Definition at line 293 of file CountersMap.h.

References util::counter().

{ return block + counter; }

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

CounterKey_t& lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::next_block ( )

inline

Skips to the beginning of the next block.

Definition at line 339 of file CountersMap.h.

      {
        block += MinorKeyRange;
        return start_block();
      }

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::operator Key_t ( ) const

inline

Conversion of this key into a number (.

See also

Key())

Definition at line 296 of file CountersMap.h.

{ return Key(); }

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

CounterKey_t& lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::operator++ ( )

inline

Definition at line 298 of file CountersMap.h.

      {
        if (++counter == MinorKeyRange) next_block();
        return *this;
      }

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

CounterKey_t& lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::operator++ ( int  )

inline

Definition at line 311 of file CountersMap.h.

      {
        CounterKey_t old(*this);
        this->operator++();
        return old;
      }

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

CounterKey_t& lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::operator-- ( )

inline

Definition at line 303 of file CountersMap.h.

      {
        if (counter-- == 0) {
          prev_block();
          counter = MinorKeyRange - 1;
        }
        return *this;
      } // operator--()

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

CounterKey_t& lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::operator-- ( int  )

inline

Definition at line 317 of file CountersMap.h.

      {
        CounterKey_t old(*this);
        this->operator--();
        return old;
      }

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

CounterKey_t& lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::prev_block ( )

inline

Skips to the beginning of the previous block.

Definition at line 332 of file CountersMap.h.

      {
        block -= MinorKeyRange;
        return start_block();
      }

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

CounterKey_t& lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::start_block ( )

inline

Skips to the beginning of this block.

Definition at line 325 of file CountersMap.h.

      {
        counter = 0;
        return *this;
      }

Member Data Documentation

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

BlockKey_t lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::block

key of the counter block

Definition at line 276 of file CountersMap.h.

Referenced by lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::GetCounter(), lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::GetOrCreateCounter(), lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::unchecked_add(), and lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::unchecked_set().

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

CounterIndex_t lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::counter

index of the counter in the block

Definition at line 277 of file CountersMap.h.

Referenced by lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::GetCounter(), lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::GetOrCreateCounter(), lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::unchecked_add(), and lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::unchecked_set().

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

constexpr Key_t lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::MinorKeyBits = LowestSetBit(MinorKeyRange)

static

Number of bits for the minor key.

Definition at line 349 of file CountersMap.h.

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

constexpr Key_t lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::MinorKeyMask = MinorKeyRange - 1

static

Bit mask for the minor key.

Definition at line 352 of file CountersMap.h.

template<typename KEY, typename COUNTER, size_t SIZE, typename ALLOC = typename details::CountersMapTraits<KEY, COUNTER, SIZE>::DefaultAllocator_t, unsigned int SUBCOUNTERS = 1>

constexpr Key_t lar::CountersMap< KEY, COUNTER, SIZE, ALLOC, SUBCOUNTERS >::CounterKey_t::MinorKeyRange = NSubcounters

static

Number of values of the minor key.

Definition at line 346 of file CountersMap.h.

---

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

• lardata/v09_16_03/source/lardata/Utilities/CountersMap.h