olb::utilities::TypeIndexedMap< VALUE, CONTEXT > Class Template Reference

(Time) efficient mapping between TYPEs and VALUEs More...

#include <typeIndexedContainers.h>

Inheritance diagram for olb::utilities::TypeIndexedMap< VALUE, CONTEXT >:

Collaboration diagram for olb::utilities::TypeIndexedMap< VALUE, CONTEXT >:

Public Member Functions
	TypeIndexedMap ()
template<typename TYPE >
bool	provides () const
template<typename TYPE >
std::size_t	index () const
template<typename TYPE >
const VALUE &	get () const
template<typename TYPE >
VALUE &	get ()
template<typename TYPE >
void	set (VALUE value)

Detailed Description

template<typename VALUE, typename CONTEXT = void>
class olb::utilities::TypeIndexedMap< VALUE, CONTEXT >

(Time) efficient mapping between TYPEs and VALUEs

CONTEXT should be set to the containing type / some one-of identifier to restrict the index space to the types that are actually used in the specific context.

Definition at line 72 of file typeIndexedContainers.h.

Constructor & Destructor Documentation

TypeIndexedMap()

template<typename VALUE , typename CONTEXT = void>

olb::utilities::TypeIndexedMap< VALUE, CONTEXT >::TypeIndexedMap ( )

inline

Definition at line 81 of file typeIndexedContainers.h.

                   {
    _index.resize(1);
  }

Member Function Documentation

get() [1/2]

template<typename VALUE , typename CONTEXT >

template<typename TYPE >

VALUE & olb::utilities::TypeIndexedMap< VALUE, CONTEXT >::get

(

)

Definition at line 156 of file typeIndexedContainers.h.

{
  const std::size_t index = get_index<TYPE>();
  if (auto& value = _index[index]) {
    return value.value();
  } else {
    throw std::out_of_range("VALUE for TYPE doesn't exist as it was not set.");
  }
}

get() [2/2]

template<typename VALUE , typename CONTEXT >

template<typename TYPE >

const VALUE & olb::utilities::TypeIndexedMap< VALUE, CONTEXT >::get

(

)

const

Definition at line 144 of file typeIndexedContainers.h.

{
  const std::size_t index = get_index<TYPE>();
  if (auto& value = _index[index]) {
    return value.value();
  } else {
    throw std::out_of_range("VALUE for TYPE doesn't exist as it was not set.");
  }
}

index()

template<typename VALUE , typename CONTEXT >

template<typename TYPE >

std::size_t olb::utilities::TypeIndexedMap< VALUE, CONTEXT >::index

(

)

const

Definition at line 137 of file typeIndexedContainers.h.

{
  return get_index<TYPE>();
}

provides()

template<typename VALUE , typename CONTEXT >

template<typename TYPE >

bool olb::utilities::TypeIndexedMap< VALUE, CONTEXT >::provides

(

)

const

Definition at line 125 of file typeIndexedContainers.h.

{
  const std::size_t index = get_index<TYPE>();
  if (index >= _index.size()) {
    return false;
  } else {
    return _index[index].has_value();
  }
}

set()

template<typename VALUE , typename CONTEXT >

template<typename TYPE >

void olb::utilities::TypeIndexedMap< VALUE, CONTEXT >::set

(

VALUE

value

)

Definition at line 168 of file typeIndexedContainers.h.

{
  const std::size_t index = get_index<TYPE>();
  if (index >= _index.size()) {
    _index.resize(2*index);
  }
  _index[index] = value;
}

---

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

• src/utilities/typeIndexedContainers.h