util::VectorMap< _Key, _Tp, _Compare > Class Template Reference

#include "VectorMap.h"

Classes
class	value_compare

Public Types
typedef _Key	key_type
typedef _Tp	mapped_type
typedef std::pair< _Key, _Tp >	value_type
typedef _Compare	key_compare
typedef std::allocator< std::pair< _Key, _Tp > >	allocator_type
typedef std::vector< value_type >	vector_type
typedef vector_type::pointer	pointer
typedef vector_type::const_pointer	const_pointer
typedef vector_type::reference	reference
typedef vector_type::const_reference	const_reference
typedef vector_type::iterator	iterator
typedef vector_type::const_iterator	const_iterator
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
typedef std::reverse_iterator< iterator >	reverse_iterator
typedef size_t	size_type
typedef ptrdiff_t	difference_type

Public Member Functions
allocator_type	get_allocator () const
	Don't write this to the ROOT file. More...
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
reverse_iterator	rbegin ()
const_reverse_iterator	rbegin () const
reverse_iterator	rend ()
const_reverse_iterator	rend () const
bool	empty () const
size_t	size () const
size_t	max_size () const
mapped_type &	operator[] (const key_type &key)
const mapped_type &	operator[] (const key_type &__k) const
mapped_type &	at (const key_type &__k)
const mapped_type &	at (const key_type &__k) const
std::pair< iterator, bool >	insert (const value_type &entry)
iterator	insert (iterator, const value_type &entry)
template<typename _InputIterator >
void	insert (_InputIterator __first, _InputIterator __last)
void	erase (iterator __position)
size_type	erase (const key_type &key)
void	erase (iterator __first, iterator __last)
void	swap (VectorMap &other)
void	clear ()
key_compare	key_comp () const
value_compare	value_comp () const
iterator	find (const key_type &key)
const_iterator	find (const key_type &key) const
size_type	count (const key_type &__x) const
iterator	lower_bound (const key_type &__x)
const_iterator	lower_bound (const key_type &__x) const
iterator	upper_bound (const key_type &__x)
const_iterator	upper_bound (const key_type &__x) const
std::pair< iterator, iterator >	equal_range (const key_type &key)
const mapped_type &	operator() (const size_type &index) const
const mapped_type &	Data (const size_type &index) const
const key_type &	Key (const size_type &index) const
void	reserve (size_type i)
size_type	capacity ()

Private Attributes
vector_type	sortedVectorMap
value_compare	valueCompare

Friends
template<typename _K1 , typename _T1 , typename _C1 >
bool	operator== (const VectorMap< _K1, _T1, _C1 > &, const VectorMap< _K1, _T1, _C1 > &)
template<typename _K1 , typename _T1 , typename _C1 >
bool	operator< (const VectorMap< _K1, _T1, _C1 > &, const VectorMap< _K1, _T1, _C1 > &)

Detailed Description

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>
class util::VectorMap< _Key, _Tp, _Compare >

Definition at line 104 of file VectorMap.h.

Member Typedef Documentation

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef std::allocator<std::pair<_Key, _Tp> > util::VectorMap< _Key, _Tp, _Compare >::allocator_type

Definition at line 112 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef vector_type::const_iterator util::VectorMap< _Key, _Tp, _Compare >::const_iterator

Definition at line 121 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef vector_type::const_pointer util::VectorMap< _Key, _Tp, _Compare >::const_pointer

Definition at line 117 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef vector_type::const_reference util::VectorMap< _Key, _Tp, _Compare >::const_reference

Definition at line 119 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef std::reverse_iterator<const_iterator> util::VectorMap< _Key, _Tp, _Compare >::const_reverse_iterator

Definition at line 122 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef ptrdiff_t util::VectorMap< _Key, _Tp, _Compare >::difference_type

Definition at line 125 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef vector_type::iterator util::VectorMap< _Key, _Tp, _Compare >::iterator

Definition at line 120 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef _Compare util::VectorMap< _Key, _Tp, _Compare >::key_compare

Definition at line 111 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef _Key util::VectorMap< _Key, _Tp, _Compare >::key_type

Definition at line 108 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef _Tp util::VectorMap< _Key, _Tp, _Compare >::mapped_type

Definition at line 109 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef vector_type::pointer util::VectorMap< _Key, _Tp, _Compare >::pointer

Definition at line 116 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef vector_type::reference util::VectorMap< _Key, _Tp, _Compare >::reference

Definition at line 118 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef std::reverse_iterator<iterator> util::VectorMap< _Key, _Tp, _Compare >::reverse_iterator

Definition at line 123 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef size_t util::VectorMap< _Key, _Tp, _Compare >::size_type

Definition at line 124 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef std::pair<_Key, _Tp> util::VectorMap< _Key, _Tp, _Compare >::value_type

Definition at line 110 of file VectorMap.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

typedef std::vector<value_type> util::VectorMap< _Key, _Tp, _Compare >::vector_type

Definition at line 114 of file VectorMap.h.

Member Function Documentation

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

mapped_type& util::VectorMap< _Key, _Tp, _Compare >::at ( const key_type &  __k )

inline

Definition at line 234 of file VectorMap.h.

Referenced by sim::LArVoxelData::at(), and sim::LArVoxelData::operator[]().

    {
      iterator __i = lower_bound(__k);
      if (__i == end() || key_comp()(__k, (*__i).first))
        throw std::out_of_range("Utilities/VectorMap::at");
      return (*__i).second;
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

const mapped_type& util::VectorMap< _Key, _Tp, _Compare >::at ( const key_type &  __k ) const

inline

Definition at line 242 of file VectorMap.h.

    {
      const_iterator __i = lower_bound(__k);
      if (__i == end() || key_comp()(__k, (*__i).first))
        throw std::out_of_range("Utilities/VectorMap::at");
      return (*__i).second;
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

iterator util::VectorMap< _Key, _Tp, _Compare >::begin ( )

inline

Definition at line 183 of file VectorMap.h.

Referenced by sim::LArVoxelData::AssignedEnergy(), sim::LArVoxelData::begin(), sim::LArVoxelData::Energy(), util::VectorMap< int, double >::equal_range(), util::VectorMap< int, double >::lower_bound(), sim::LArVoxelData::operator*=(), sim::LArVoxelData::TrackID(), and util::VectorMap< int, double >::upper_bound().

{ return sortedVectorMap.begin(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

const_iterator util::VectorMap< _Key, _Tp, _Compare >::begin ( ) const

inline

Definition at line 185 of file VectorMap.h.

{ return sortedVectorMap.begin(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

size_type util::VectorMap< _Key, _Tp, _Compare >::capacity ( )

inline

Definition at line 400 of file VectorMap.h.

{ return sortedVectorMap.capacity(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

void util::VectorMap< _Key, _Tp, _Compare >::clear ( )

inline

Definition at line 320 of file VectorMap.h.

Referenced by sim::LArVoxelData::clear(), and sim::LArVoxelData::RemoveAllTracks().

{ sortedVectorMap.clear(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

size_type util::VectorMap< _Key, _Tp, _Compare >::count ( const key_type &  __x ) const

inline

Definition at line 347 of file VectorMap.h.

{ return find(__x) == end() ? 0 : 1; }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

const mapped_type& util::VectorMap< _Key, _Tp, _Compare >::Data ( const size_type &  index ) const

inline

Definition at line 394 of file VectorMap.h.

{ return sortedVectorMap[index].second; }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

bool util::VectorMap< _Key, _Tp, _Compare >::empty ( ) const

inline

Definition at line 199 of file VectorMap.h.

Referenced by sim::LArVoxelData::empty().

{ return sortedVectorMap.empty(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

iterator util::VectorMap< _Key, _Tp, _Compare >::end ( )

inline

Definition at line 187 of file VectorMap.h.

Referenced by sim::LArVoxelData::AssignedEnergy(), util::VectorMap< int, double >::at(), util::VectorMap< int, double >::count(), sim::LArVoxelData::end(), sim::LArVoxelData::Energy(), util::VectorMap< int, double >::equal_range(), util::VectorMap< int, double >::erase(), util::VectorMap< int, double >::find(), util::VectorMap< int, double >::insert(), util::VectorMap< int, double >::lower_bound(), sim::LArVoxelData::operator*=(), util::VectorMap< int, double >::operator[](), sim::LArVoxelData::RemoveTrack(), and util::VectorMap< int, double >::upper_bound().

{ return sortedVectorMap.end(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

const_iterator util::VectorMap< _Key, _Tp, _Compare >::end ( ) const

inline

Definition at line 189 of file VectorMap.h.

{ return sortedVectorMap.end(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

std::pair<iterator, iterator> util::VectorMap< _Key, _Tp, _Compare >::equal_range ( const key_type &  key )

inline

Definition at line 369 of file VectorMap.h.

    {
      return std::equal_range(begin(), end(), key, valueCompare);
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

void util::VectorMap< _Key, _Tp, _Compare >::erase ( iterator  __position )

inline

Definition at line 293 of file VectorMap.h.

Referenced by util::VectorMap< int, double >::erase(), and sim::LArVoxelData::RemoveTrack().

{ sortedVectorMap.erase(__position); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

size_type util::VectorMap< _Key, _Tp, _Compare >::erase ( const key_type &  key )

inline

Definition at line 297 of file VectorMap.h.

    {
      iterator i = find(key);
      if (i == end()) return 0;
      erase(i);
      return 1;
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

void util::VectorMap< _Key, _Tp, _Compare >::erase ( iterator  __first, iterator  __last  )

inline

Definition at line 306 of file VectorMap.h.

{ sortedVectorMap.erase(__first, __last); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

iterator util::VectorMap< _Key, _Tp, _Compare >::find ( const key_type &  key )

inline

Definition at line 329 of file VectorMap.h.

Referenced by util::VectorMap< int, double >::count(), util::VectorMap< int, double >::erase(), sim::LArVoxelData::find(), and sim::LArVoxelData::RemoveTrack().

    {
      iterator i = lower_bound(key);
      if (i == end() || key_comp()(key, (*i).first)) return end();

      return i;
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

const_iterator util::VectorMap< _Key, _Tp, _Compare >::find ( const key_type &  key ) const

inline

Definition at line 337 of file VectorMap.h.

    {
      const_iterator i = lower_bound(key);
      if (i == end() || key_comp()(key, (*i).first)) return end();

      return i;
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

allocator_type util::VectorMap< _Key, _Tp, _Compare >::get_allocator ( ) const

inline

Don't write this to the ROOT file.

Definition at line 181 of file VectorMap.h.

{ return sortedVectorMap.get_allocator(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

std::pair<iterator, bool> util::VectorMap< _Key, _Tp, _Compare >::insert ( const value_type &  entry )

inline

Definition at line 259 of file VectorMap.h.

Referenced by util::VectorMap< int, double >::insert().

    {
      const key_type& key = entry.first;
      iterator i = lower_bound(key);
      if (i == end() || key_comp()(key, (*i).first)) {
        // The entry was not found.  In that case, lower_bound has
        // already found the correct point at which we want to insert
        // the entry to maintain the sort.
        i = sortedVectorMap.insert(i, entry);
        return std::make_pair(i, true);
      }

      // If we get here, the entry was found.  Return failure.
      return std::make_pair(i, false);
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

iterator util::VectorMap< _Key, _Tp, _Compare >::insert ( iterator  , const value_type &  entry  )

inline

Definition at line 279 of file VectorMap.h.

    {
      std::pair<iterator, bool> result = insert(entry);
      return result.first;
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

template<typename _InputIterator >

void util::VectorMap< _Key, _Tp, _Compare >::insert ( _InputIterator  __first, _InputIterator  __last  )

inline

Definition at line 287 of file VectorMap.h.

    {
      for (; __first != __last; ++__first)
        insert(*__first);
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

const key_type& util::VectorMap< _Key, _Tp, _Compare >::Key ( const size_type &  index ) const

inline

Definition at line 396 of file VectorMap.h.

{ return sortedVectorMap[index].first; }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

key_compare util::VectorMap< _Key, _Tp, _Compare >::key_comp ( ) const

inline

Definition at line 323 of file VectorMap.h.

Referenced by util::VectorMap< int, double >::at(), util::VectorMap< int, double >::find(), util::VectorMap< int, double >::insert(), and util::VectorMap< int, double >::operator[]().

{ return valueCompare.GetCompare(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

iterator util::VectorMap< _Key, _Tp, _Compare >::lower_bound ( const key_type &  __x )

inline

Definition at line 349 of file VectorMap.h.

Referenced by util::VectorMap< int, double >::at(), util::VectorMap< int, double >::find(), util::VectorMap< int, double >::insert(), sim::LArVoxelData::lower_bound(), and util::VectorMap< int, double >::operator[]().

    {
      return std::lower_bound(begin(), end(), __x, valueCompare);
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

const_iterator util::VectorMap< _Key, _Tp, _Compare >::lower_bound ( const key_type &  __x ) const

inline

Definition at line 354 of file VectorMap.h.

    {
      return std::lower_bound(begin(), end(), __x, valueCompare);
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

size_t util::VectorMap< _Key, _Tp, _Compare >::max_size ( ) const

inline

Definition at line 203 of file VectorMap.h.

{ return sortedVectorMap.max_size(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

const mapped_type& util::VectorMap< _Key, _Tp, _Compare >::operator() ( const size_type &  index ) const

inline

Definition at line 389 of file VectorMap.h.

    {
      return sortedVectorMap[index].second;
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

mapped_type& util::VectorMap< _Key, _Tp, _Compare >::operator[] ( const key_type &  key )

inline

Definition at line 205 of file VectorMap.h.

    {
      // Do a binary search for the key.
      iterator i = lower_bound(key);

      // If the key is not found, or i->first is less than key, then
      // the key is not found.
      if (i == end() || key_comp()(key, (*i).first))
        // Insert this key into the map, with a default value.  Thanks
        // to the lower_bound call above, i already points to correct
        // place to insert the value in the sorted vector.
        i = sortedVectorMap.insert(i, value_type(key, mapped_type()));

      return (*i).second;
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

const mapped_type& util::VectorMap< _Key, _Tp, _Compare >::operator[] ( const key_type &  __k ) const

inline

Definition at line 224 of file VectorMap.h.

    {
      const_iterator __i = lower_bound(__k);
      if (__i == end() || key_comp()(__k, (*__i).first))
        throw std::out_of_range("Utilities/VectorMap::operator[]");
      return (*__i).second;
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

reverse_iterator util::VectorMap< _Key, _Tp, _Compare >::rbegin ( )

inline

Definition at line 191 of file VectorMap.h.

Referenced by sim::LArVoxelData::rbegin().

{ return sortedVectorMap.rbegin(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

const_reverse_iterator util::VectorMap< _Key, _Tp, _Compare >::rbegin ( ) const

inline

Definition at line 193 of file VectorMap.h.

{ return sortedVectorMap.rbegin(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

reverse_iterator util::VectorMap< _Key, _Tp, _Compare >::rend ( )

inline

Definition at line 195 of file VectorMap.h.

Referenced by sim::LArVoxelData::rend().

{ return sortedVectorMap.rend(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

const_reverse_iterator util::VectorMap< _Key, _Tp, _Compare >::rend ( ) const

inline

Definition at line 197 of file VectorMap.h.

{ return sortedVectorMap.rend(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

void util::VectorMap< _Key, _Tp, _Compare >::reserve ( size_type  i )

inline

Definition at line 399 of file VectorMap.h.

{ sortedVectorMap.reserve(i); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

size_t util::VectorMap< _Key, _Tp, _Compare >::size ( ) const

inline

Definition at line 201 of file VectorMap.h.

Referenced by sim::LArVoxelData::size().

{ return sortedVectorMap.size(); }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

void util::VectorMap< _Key, _Tp, _Compare >::swap ( VectorMap< _Key, _Tp, _Compare > &  other )

inline

Definition at line 312 of file VectorMap.h.

Referenced by sim::LArVoxelData::swap(), and util::swap().

    {
      sortedVectorMap.swap(other.sortedVectorMap);
      value_compare temp(valueCompare);
      valueCompare = other.valueCompare;
      other.valueCompare = temp;
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

iterator util::VectorMap< _Key, _Tp, _Compare >::upper_bound ( const key_type &  __x )

inline

Definition at line 359 of file VectorMap.h.

Referenced by sim::LArVoxelData::upper_bound().

    {
      return std::upper_bound(begin(), end(), __x, valueCompare);
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

const_iterator util::VectorMap< _Key, _Tp, _Compare >::upper_bound ( const key_type &  __x ) const

inline

Definition at line 364 of file VectorMap.h.

    {
      return std::upper_bound(begin(), end(), __x, valueCompare);
    }

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

value_compare util::VectorMap< _Key, _Tp, _Compare >::value_comp ( ) const

inline

Definition at line 327 of file VectorMap.h.

{ return valueCompare; }

Friends And Related Function Documentation

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

template<typename _K1 , typename _T1 , typename _C1 >

bool operator< ( const VectorMap< _K1, _T1, _C1 > &  , const VectorMap< _K1, _T1, _C1 > &    )

friend

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

template<typename _K1 , typename _T1 , typename _C1 >

bool operator== ( const VectorMap< _K1, _T1, _C1 > &  , const VectorMap< _K1, _T1, _C1 > &    )

friend

Referenced by util::VectorMap< int, double >::capacity().

Member Data Documentation

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

vector_type util::VectorMap< _Key, _Tp, _Compare >::sortedVectorMap

private

Definition at line 170 of file VectorMap.h.

Referenced by util::operator==(), and util::VectorMap< int, double >::swap().

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>>

value_compare util::VectorMap< _Key, _Tp, _Compare >::valueCompare

private

Definition at line 173 of file VectorMap.h.

Referenced by util::VectorMap< int, double >::swap(), and util::VectorMap< int, double >::value_comp().

---

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

• lardataobj/v09_18_03/source/lardataobj/Utilities/VectorMap.h