hidden_key_map< KeyT, ValueT > Class Template Reference

STL-like map where the key is automatically deduced from the value object (hence 'hidden'). More...

#include <hidden_key_map.hpp>

Public Types
typedef hidden_key_map_const_iterator < SelfType >	const_iterator
typedef const value_type *	const_pointer
typedef const value_type &	const_reference
typedef hidden_key_map_const_reverse_iterator < SelfType >	const_reverse_iterator
typedef std::map< KeyT, ValueT >	container_type
typedef hidden_key_map_iterator < SelfType >	iterator
typedef KeyT	key_type
typedef value_type *	pointer
typedef value_type &	reference
typedef hidden_key_map_reverse_iterator < SelfType >	reverse_iterator
typedef container_type::size_type	size_type
typedef ValueT	value_type
Public Member Functions
iterator	begin ()
const_iterator	begin () const
void	clear ()
bool	empty () const
iterator	end ()
const_iterator	end () const
iterator	erase (iterator to_erase)
iterator	find (const value_type &element)
const_iterator	find (const value_type &element) const
std::pair< iterator, bool >	insert (const value_type &element)
size_type	size () const
Friends
class	hidden_key_map_const_iterator< SelfType >
class	hidden_key_map_const_reverse_iterator< SelfType >
class	hidden_key_map_iterator< SelfType >
class	hidden_key_map_reverse_iterator< SelfType >

---

Detailed Description

template<typename KeyT, typename ValueT>
class viennagrid::hidden_key_map< KeyT, ValueT >

STL-like map where the key is automatically deduced from the value object (hence 'hidden').

Template Parameters:

KeyT	The key functor type which extracts the key from the value object
ValueT	The value type, i.e. the element stored inside the map.

---

Member Typedef Documentation

typedef hidden_key_map_const_iterator<SelfType> const_iterator

Reimplemented in container_base< hidden_key_map< KeyT, ElementT >, handle_tag >.

typedef const value_type* const_pointer

Reimplemented in handled_container< hidden_key_map< KeyT, ElementT >, handle_tag >, and container_base< hidden_key_map< KeyT, ElementT >, handle_tag >.

typedef const value_type& const_reference

Reimplemented in handled_container< hidden_key_map< KeyT, ElementT >, handle_tag >, and container_base< hidden_key_map< KeyT, ElementT >, handle_tag >.

typedef hidden_key_map_const_reverse_iterator<SelfType> const_reverse_iterator

typedef std::map< KeyT, ValueT > container_type

Reimplemented in handled_container< hidden_key_map< KeyT, ElementT >, handle_tag >, and container_base< hidden_key_map< KeyT, ElementT >, handle_tag >.

typedef hidden_key_map_iterator<SelfType> iterator

Reimplemented in container_base< hidden_key_map< KeyT, ElementT >, handle_tag >.

typedef KeyT key_type

typedef value_type* pointer

Reimplemented in handled_container< hidden_key_map< KeyT, ElementT >, handle_tag >, and container_base< hidden_key_map< KeyT, ElementT >, handle_tag >.

typedef value_type& reference

Reimplemented in handled_container< hidden_key_map< KeyT, ElementT >, handle_tag >, and container_base< hidden_key_map< KeyT, ElementT >, handle_tag >.

typedef hidden_key_map_reverse_iterator<SelfType> reverse_iterator

typedef container_type::size_type size_type

typedef ValueT value_type

Reimplemented in handled_container< hidden_key_map< KeyT, ElementT >, handle_tag >, and container_base< hidden_key_map< KeyT, ElementT >, handle_tag >.

---

Member Function Documentation

iterator begin

(

)

[inline]

const_iterator begin

(

)

const [inline]

void clear

(

)

[inline]

bool empty

(

)

const [inline]

iterator end

(

)

[inline]

const_iterator end

(

)

const [inline]

iterator erase

(

iterator

to_erase

)

[inline]

iterator find

(

const value_type &

element

)

[inline]

const_iterator find

(

const value_type &

element

)

const [inline]

Reimplemented in container_base< hidden_key_map< KeyT, ElementT >, handle_tag >.

std::pair<iterator, bool> insert

(

const value_type &

element

)

[inline]

Reimplemented in container_base< hidden_key_map< KeyT, ElementT >, handle_tag >.

size_type size

(

)

const [inline]

---

Friends And Related Function Documentation

friend class hidden_key_map_const_iterator< SelfType > [friend]

friend class hidden_key_map_const_reverse_iterator< SelfType > [friend]

friend class hidden_key_map_iterator< SelfType > [friend]

friend class hidden_key_map_reverse_iterator< SelfType > [friend]

---

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

• viennagrid/storage/hidden_key_map.hpp