Spatial C++ Library
Generic Multi-Dimensional Containers and Spatial Operations
spatial::box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc > Class Template Reference

A mapped containers to store values in space that can be represented as boxes. More...

#include <box_multimap.hpp>

Inherits spatial::details::Relaxed_kdtree< details::Static_rank< Rank >, const Key, std::pair< const Key, Mapped >, Compare, BalancingPolicy, Alloc >.

Public Types

typedef Mapped mapped_type
 
- Public Types inherited from spatial::details::Relaxed_kdtree< details::Static_rank< Rank >, const Key, std::pair< const Key, Mapped >, Compare, BalancingPolicy, Alloc >
typedef details::Static_rank< Rank > rank_type
 
typedef mutate< const Key >::type key_type
 
typedef mutate< std::pair< const Key, Mapped > >::type value_type
 
typedef Relaxed_kdtree_link< const Key, std::pair< const Key, Mapped > > mode_type
 
typedef Compare key_compare
 
typedef ValueCompare< value_type, key_comparevalue_compare
 
typedef Alloc allocator_type
 
typedef BalancingPolicy balancing_policy
 
typedef std::pair< const Key, Mapped > * pointer
 
typedef const std::pair< const Key, Mapped > * const_pointer
 
typedef std::pair< const Key, Mapped > & reference
 
typedef const std::pair< const Key, Mapped > & const_reference
 
typedef std::size_t size_type
 
typedef std::ptrdiff_t difference_type
 
typedef Node_iterator< mode_typeiterator
 
typedef Const_node_iterator< mode_typeconst_iterator
 
typedef std::reverse_iterator< iteratorreverse_iterator
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 

Public Member Functions

 box_multimap ()
 
 box_multimap (const Compare &compare)
 
 box_multimap (const Compare &compare, const BalancingPolicy &balancing)
 
 box_multimap (const Compare &compare, const BalancingPolicy &balancing, const Alloc &alloc)
 
 box_multimap (const box_multimap &other)
 
box_multimapoperator= (const box_multimap &other)
 
- Public Member Functions inherited from spatial::details::Relaxed_kdtree< details::Static_rank< Rank >, const Key, std::pair< const Key, Mapped >, Compare, BalancingPolicy, Alloc >
iterator begin ()
 
const_iterator begin () const
 
const_iterator cbegin () const
 
iterator end ()
 
const_iterator end () const
 
const_iterator cend () const
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
const_reverse_iterator crbegin () const
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
const_reverse_iterator crend () const
 
balancing_policy balancing () const
 Returns the balancing policy for the container. More...
 
rank_type rank () const
 Returns the rank type used internally to get the number of dimensions in the container. More...
 
dimension_type dimension () const
 Returns the dimension of the container. More...
 
key_compare key_comp () const
 Returns the compare function used for the key. More...
 
value_compare value_comp () const
 Returns the compare function used for the value. More...
 
allocator_type get_allocator () const
 Returns the allocator used by the tree. More...
 
bool empty () const
 True if the tree is empty. More...
 
size_type size () const
 Returns the number of elements in the K-d tree. More...
 
size_type count () const
 Returns the number of elements in the K-d tree. More...
 
size_type max_size () const
 The maximum number of elements that can be allocated. More...
 
 Relaxed_kdtree ()
 
 Relaxed_kdtree (const rank_type &rank_)
 
 Relaxed_kdtree (const rank_type &rank_, const key_compare &compare_)
 
 Relaxed_kdtree (const rank_type &rank_, const key_compare &compare_, const balancing_policy &balancing_)
 
 Relaxed_kdtree (const rank_type &rank_, const key_compare &compare_, const balancing_policy &balancing_, const allocator_type &allocator_)
 
 Relaxed_kdtree (const Relaxed_kdtree &other)
 Deep copy of other into the new tree. More...
 
Relaxed_kdtreeoperator= (const Relaxed_kdtree &other)
 Assignment of other into the tree, with deep copy. More...
 
 ~Relaxed_kdtree ()
 Deallocate all nodes in the destructor. More...
 
void swap (Self &other)
 Swap the K-d tree content with others. More...
 
void clear ()
 Erase all elements in the K-d tree. More...
 
iterator insert (const value_type &value)
 Insert a single key key in the tree. More...
 
void insert (InputIterator first, InputIterator last)
 Insert a serie of values in the tree at once. More...
 
void erase (iterator position)
 Deletes the node pointed to by the iterator. More...
 
size_type erase (const key_type &key)
 Deletes all nodes that match key value. More...
 
iterator find (const key_type &key)
 Find the first node that matches with key and returns an iterator to it found, otherwise it returns an iterator to the element past the end of the container. More...
 
const_iterator find (const key_type &key) const
 Find the first node that matches with key and returns an iterator to it found, otherwise it returns an iterator to the element past the end of the container. More...
 

Private Types

typedef enable_if_c<(Rank &1u)==0 >::type check_concept_dimension_is_even
 
typedef details::Relaxed_kdtree< details::Static_rank< Rank >, const Key, std::pair< const Key, Mapped >, Compare, BalancingPolicy, Alloc > base_type
 
typedef box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc > Self
 

Detailed Description

template<dimension_type Rank, typename Key, typename Mapped, typename Compare = bracket_less<Key>, typename BalancingPolicy = loose_balancing, typename Alloc = std::allocator<std::pair<const Key, Mapped> >>
class spatial::box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc >

A mapped containers to store values in space that can be represented as boxes.

Definition at line 33 of file box_multimap.hpp.

Member Typedef Documentation

template<dimension_type Rank, typename Key , typename Mapped , typename Compare = bracket_less<Key>, typename BalancingPolicy = loose_balancing, typename Alloc = std::allocator<std::pair<const Key, Mapped> >>
typedef details::Relaxed_kdtree<details::Static_rank<Rank>, const Key, std::pair<const Key, Mapped>, Compare, BalancingPolicy, Alloc> spatial::box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc >::base_type
private

Definition at line 44 of file box_multimap.hpp.

template<dimension_type Rank, typename Key , typename Mapped , typename Compare = bracket_less<Key>, typename BalancingPolicy = loose_balancing, typename Alloc = std::allocator<std::pair<const Key, Mapped> >>
typedef enable_if_c<(Rank & 1u) == 0>::type spatial::box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc >::check_concept_dimension_is_even
private

Definition at line 40 of file box_multimap.hpp.

template<dimension_type Rank, typename Key , typename Mapped , typename Compare = bracket_less<Key>, typename BalancingPolicy = loose_balancing, typename Alloc = std::allocator<std::pair<const Key, Mapped> >>
typedef Mapped spatial::box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc >::mapped_type

Definition at line 49 of file box_multimap.hpp.

template<dimension_type Rank, typename Key , typename Mapped , typename Compare = bracket_less<Key>, typename BalancingPolicy = loose_balancing, typename Alloc = std::allocator<std::pair<const Key, Mapped> >>
typedef box_multimap<Rank, Key, Mapped, Compare, BalancingPolicy, Alloc> spatial::box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc >::Self
private

Definition at line 46 of file box_multimap.hpp.

Constructor & Destructor Documentation

template<dimension_type Rank, typename Key , typename Mapped , typename Compare = bracket_less<Key>, typename BalancingPolicy = loose_balancing, typename Alloc = std::allocator<std::pair<const Key, Mapped> >>
spatial::box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc >::box_multimap ( )

Definition at line 51 of file box_multimap.hpp.

template<dimension_type Rank, typename Key , typename Mapped , typename Compare = bracket_less<Key>, typename BalancingPolicy = loose_balancing, typename Alloc = std::allocator<std::pair<const Key, Mapped> >>
spatial::box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc >::box_multimap ( const Compare &  compare)
explicit

Definition at line 53 of file box_multimap.hpp.

template<dimension_type Rank, typename Key , typename Mapped , typename Compare = bracket_less<Key>, typename BalancingPolicy = loose_balancing, typename Alloc = std::allocator<std::pair<const Key, Mapped> >>
spatial::box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc >::box_multimap ( const Compare &  compare,
const BalancingPolicy &  balancing 
)

Definition at line 57 of file box_multimap.hpp.

template<dimension_type Rank, typename Key , typename Mapped , typename Compare = bracket_less<Key>, typename BalancingPolicy = loose_balancing, typename Alloc = std::allocator<std::pair<const Key, Mapped> >>
spatial::box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc >::box_multimap ( const Compare &  compare,
const BalancingPolicy &  balancing,
const Alloc &  alloc 
)

Definition at line 61 of file box_multimap.hpp.

template<dimension_type Rank, typename Key , typename Mapped , typename Compare = bracket_less<Key>, typename BalancingPolicy = loose_balancing, typename Alloc = std::allocator<std::pair<const Key, Mapped> >>
spatial::box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc >::box_multimap ( const box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc > &  other)

Definition at line 66 of file box_multimap.hpp.

Member Function Documentation

template<dimension_type Rank, typename Key , typename Mapped , typename Compare = bracket_less<Key>, typename BalancingPolicy = loose_balancing, typename Alloc = std::allocator<std::pair<const Key, Mapped> >>
box_multimap& spatial::box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc >::operator= ( const box_multimap< Rank, Key, Mapped, Compare, BalancingPolicy, Alloc > &  other)

Definition at line 71 of file box_multimap.hpp.


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