Class template iset_index

Boost C++ Libraries

Class template iset_index

boost::interprocess::iset_index

Synopsis

// In header: <boost/interprocess/indexes/iset_index.hpp>

template<typename MapConfig> 
class iset_index {
public:
  // types
  typedef index_type::iterator           iterator;          
  typedef index_type::const_iterator     const_iterator;    
  typedef index_type::insert_commit_data insert_commit_data;
  typedef index_type::value_type         value_type;        

  // construct/copy/destruct
  iset_index(typename MapConfig::segment_manager_base *);

  // public member functions
  void reserve(typename MapConfig::segment_manager_base::size_type);
  void shrink_to_fit();
  iterator find(const intrusive_compare_key_type &);
  const_iterator find(const intrusive_compare_key_type &) const;
  std::pair< iterator, bool > 
  insert_check(const intrusive_compare_key_type &, insert_commit_data &);
};

Description

Index type based in boost::intrusive::set. Just derives from boost::intrusive::set and defines the interface needed by managed memory segments

`iset_index` public construct/copy/destruct

```
iset_index(typename MapConfig::segment_manager_base *);
```
Constructor. Takes a pointer to the segment manager. Can throw

`iset_index` public member functions

```
void reserve(typename MapConfig::segment_manager_base::size_type);
```
This reserves memory to optimize the insertion of n elements in the index
```
void shrink_to_fit();
```
This frees all unnecessary memory.

iterator find(const intrusive_compare_key_type & key);

const_iterator find(const intrusive_compare_key_type & key) const;

std::pair< iterator, bool > 
insert_check(const intrusive_compare_key_type & key, 
             insert_commit_data & commit_data);