Libosmium  2.4.1
Fast and flexible C++ library for working with OpenStreetMap data
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Types | Public Member Functions | Private Attributes | Static Private Attributes | List of all members
osmium::index::multimap::SparseMemMultimap< TId, TValue > Class Template Reference

#include <sparse_mem_multimap.hpp>

Inheritance diagram for osmium::index::multimap::SparseMemMultimap< TId, TValue >:
Inheritance graph
[legend]
Collaboration diagram for osmium::index::multimap::SparseMemMultimap< TId, TValue >:
Collaboration graph
[legend]

Public Types

typedef std::multimap< const
TId, TValue > 
collection_type
 
typedef collection_type::iterator iterator
 
typedef
collection_type::const_iterator 
const_iterator
 
typedef collection_type::value_type value_type
 
typedef std::pair< TId, TValue > element_type
 
- Public Types inherited from osmium::index::multimap::Multimap< TId, TValue >
typedef TId key_type
 The "key" type, usually osmium::unsigned_object_id_type. More...
 
typedef TValue value_type
 The "value" type, usually a Location or size_t. More...
 
typedef element_typeiterator
 

Public Member Functions

 SparseMemMultimap ()=default
 
 ~SparseMemMultimap () noexceptoverridefinal=default
 
void unsorted_set (const TId id, const TValue value)
 
void set (const TId id, const TValue value) overridefinal
 Set the field with id to value. More...
 
std::pair< iterator, iteratorget_all (const TId id)
 
std::pair< const_iterator,
const_iterator
get_all (const TId id) const
 
void remove (const TId id, const TValue value)
 
iterator begin ()
 
iterator end ()
 
size_t size () const overridefinal
 
size_t used_memory () const overridefinal
 
void clear () overridefinal
 
void consolidate ()
 
void dump_as_list (const int fd) overridefinal
 
- Public Member Functions inherited from osmium::index::multimap::Multimap< TId, TValue >
 Multimap ()=default
 
virtual ~Multimap () noexcept=default
 
virtual void sort ()
 

Private Attributes

collection_type m_elements
 

Static Private Attributes

static constexpr size_t element_size = sizeof(TId) + sizeof(TValue) + sizeof(void*) * 4
 

Additional Inherited Members

- Protected Member Functions inherited from osmium::index::multimap::Multimap< TId, TValue >
 Multimap (Multimap &&)=default
 
Multimapoperator= (Multimap &&)=default
 

Detailed Description

template<typename TId, typename TValue>
class osmium::index::multimap::SparseMemMultimap< TId, TValue >

This implementation uses std::multimap internally. It uses rather a lot of memory, but might make sense for small maps.

Member Typedef Documentation

template<typename TId , typename TValue >
typedef std::multimap<const TId, TValue> osmium::index::multimap::SparseMemMultimap< TId, TValue >::collection_type
template<typename TId , typename TValue >
typedef collection_type::const_iterator osmium::index::multimap::SparseMemMultimap< TId, TValue >::const_iterator
template<typename TId , typename TValue >
typedef std::pair<TId, TValue> osmium::index::multimap::SparseMemMultimap< TId, TValue >::element_type
template<typename TId , typename TValue >
typedef collection_type::iterator osmium::index::multimap::SparseMemMultimap< TId, TValue >::iterator
template<typename TId , typename TValue >
typedef collection_type::value_type osmium::index::multimap::SparseMemMultimap< TId, TValue >::value_type

Constructor & Destructor Documentation

template<typename TId , typename TValue >
osmium::index::multimap::SparseMemMultimap< TId, TValue >::SparseMemMultimap ( )
default
template<typename TId , typename TValue >
osmium::index::multimap::SparseMemMultimap< TId, TValue >::~SparseMemMultimap ( )
finaloverridedefaultnoexcept

Member Function Documentation

template<typename TId , typename TValue >
iterator osmium::index::multimap::SparseMemMultimap< TId, TValue >::begin ( )
inline
template<typename TId , typename TValue >
void osmium::index::multimap::SparseMemMultimap< TId, TValue >::clear ( )
inlinefinaloverridevirtual

Clear memory used for this storage. After this you can not use the storage container any more.

Implements osmium::index::multimap::Multimap< TId, TValue >.

template<typename TId , typename TValue >
void osmium::index::multimap::SparseMemMultimap< TId, TValue >::consolidate ( )
inline
template<typename TId , typename TValue >
void osmium::index::multimap::SparseMemMultimap< TId, TValue >::dump_as_list ( const int  fd)
inlinefinaloverridevirtual
template<typename TId , typename TValue >
iterator osmium::index::multimap::SparseMemMultimap< TId, TValue >::end ( )
inline
template<typename TId , typename TValue >
std::pair<iterator, iterator> osmium::index::multimap::SparseMemMultimap< TId, TValue >::get_all ( const TId  id)
inline
template<typename TId , typename TValue >
std::pair<const_iterator, const_iterator> osmium::index::multimap::SparseMemMultimap< TId, TValue >::get_all ( const TId  id) const
inline
template<typename TId , typename TValue >
void osmium::index::multimap::SparseMemMultimap< TId, TValue >::remove ( const TId  id,
const TValue  value 
)
inline
template<typename TId , typename TValue >
void osmium::index::multimap::SparseMemMultimap< TId, TValue >::set ( const TId  id,
const TValue  value 
)
inlinefinaloverridevirtual

Set the field with id to value.

Implements osmium::index::multimap::Multimap< TId, TValue >.

template<typename TId , typename TValue >
size_t osmium::index::multimap::SparseMemMultimap< TId, TValue >::size ( ) const
inlinefinaloverridevirtual

Get the approximate number of items in the storage. The storage might allocate memory in blocks, so this size might not be accurate. You can not use this to find out how much memory the storage uses. Use used_memory() for that.

Implements osmium::index::multimap::Multimap< TId, TValue >.

template<typename TId , typename TValue >
void osmium::index::multimap::SparseMemMultimap< TId, TValue >::unsorted_set ( const TId  id,
const TValue  value 
)
inline
template<typename TId , typename TValue >
size_t osmium::index::multimap::SparseMemMultimap< TId, TValue >::used_memory ( ) const
inlinefinaloverridevirtual

Get the memory used for this storage in bytes. Note that this is not necessarily entirely accurate but an approximation. For storage classes that store the data in memory, this is the main memory used, for storage classes storing data on disk this is the memory used on disk.

Implements osmium::index::multimap::Multimap< TId, TValue >.

Member Data Documentation

template<typename TId , typename TValue >
constexpr size_t osmium::index::multimap::SparseMemMultimap< TId, TValue >::element_size = sizeof(TId) + sizeof(TValue) + sizeof(void*) * 4
staticprivate
template<typename TId , typename TValue >
collection_type osmium::index::multimap::SparseMemMultimap< TId, TValue >::m_elements
private

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