boostorg/unordered
1
0
Fork 1
mirror of https://github.com/boostorg/unordered.git synced 2025-07-30 11:27:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Remove some of the old doxygen stuff from the unordered container header files

Browse Source 
as I'm not using doxygen.


[SVN r3618]
This commit is contained in:
Daniel James
2007-01-10 00:03:26 +00:00
parent 70797d159a
commit 9e51e23cea
2 changed files with 45 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
include/boost/unordered_map.hpp
View File

@ -21,11 +21,6 @@
namespace boost namespace boost
{ {
//! An unordered associative container that associates unique keys with another value.
/*! For full details see chapter 23 of the draft C++ standard.
* http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2009.pdf
*/
template <class Key, template <class Key,
class T, class T,
class Hash = hash<Key>, class Hash = hash<Key>,
@ -33,27 +28,20 @@ namespace boost
class Alloc = std::allocator<std::pair<const Key, T> > > class Alloc = std::allocator<std::pair<const Key, T> > >
class unordered_map class unordered_map
{ {
// Named for the benefit of Doxygen.
typedef boost::unordered_detail::hash_types_unique_keys< typedef boost::unordered_detail::hash_types_unique_keys<
std::pair<const Key, T>, Key, Hash, Pred, Alloc std::pair<const Key, T>, Key, Hash, Pred, Alloc
> implementation_defined; > implementation;
typename implementation_defined::hash_table base; typename implementation::hash_table base;
public: public:
// types // types
/*! Key must be Assignable and CopyConstructible.
*/
typedef Key key_type; typedef Key key_type;
typedef std::pair<const Key, T> value_type; typedef std::pair<const Key, T> value_type;
typedef T mapped_type; typedef T mapped_type;
/*! Hash is a unary function object type such for hf of type hasher
* hf(x) has type std::size_t.
*/
typedef Hash hasher; typedef Hash hasher;
/*! Pred is a binary predicate that takes two arguments of type Key.
* Pred is an equivalence realtion
*/
typedef Pred key_equal; typedef Pred key_equal;
typedef Alloc allocator_type; typedef Alloc allocator_type;
@ -62,29 +50,16 @@ namespace boost
typedef typename allocator_type::reference reference; typedef typename allocator_type::reference reference;
typedef typename allocator_type::const_reference const_reference; typedef typename allocator_type::const_reference const_reference;
typedef typename implementation_defined::size_type size_type; typedef typename implementation::size_type size_type;
typedef typename implementation_defined::difference_type difference_type; typedef typename implementation::difference_type difference_type;
typedef typename implementation_defined::iterator iterator; typedef typename implementation::iterator iterator;
typedef typename implementation_defined::const_iterator const_iterator; typedef typename implementation::const_iterator const_iterator;
typedef typename implementation::local_iterator local_iterator;
/*! A local_iterator object may be used to iterate through a single typedef typename implementation::const_local_iterator const_local_iterator;
* bucket, but may not be used to iterate across buckets.
*/
typedef typename implementation_defined::local_iterator local_iterator;
/*! A const_local_iterator object may be used to iterate through a single
* bucket, but may not be used to iterate across buckets.
*/
typedef typename implementation_defined::const_local_iterator
const_local_iterator;
// construct/destroy/copy // construct/destroy/copy
/*! Constructs an empty container with at least n buckets, using hf as
* the hash function and eq as the key equality predicate. a is used
* as the allocator.
*/
explicit unordered_map( explicit unordered_map(
size_type n = boost::unordered_detail::default_initial_bucket_count, size_type n = boost::unordered_detail::default_initial_bucket_count,
const hasher &hf = hasher(), const hasher &hf = hasher(),
@ -94,10 +69,6 @@ namespace boost
{ {
} }
/*! Constructs an empty container with at least n buckets, using hf as
* the hash function and eq as the key equality predicate, and inserts
* elements from [i,j) into it. a is used as the allocator.
*/
template <class InputIterator> template <class InputIterator>
unordered_map(InputIterator f, InputIterator l) unordered_map(InputIterator f, InputIterator l)
: base(f, l, boost::unordered_detail::default_initial_bucket_count, : base(f, l, boost::unordered_detail::default_initial_bucket_count,
@ -117,7 +88,7 @@ namespace boost
private: private:
typename implementation_defined::iterator_base const& typename implementation::iterator_base const&
get(const_iterator const& it) get(const_iterator const& it)
{ {
return boost::unordered_detail::iterator_access::get(it); return boost::unordered_detail::iterator_access::get(it);
@ -333,7 +304,7 @@ namespace boost
{ {
return const_local_iterator(base.begin(n)); return const_local_iterator(base.begin(n));
} }
const_local_iterator cend(size_type n) const const_local_iterator cend(size_type n) const
{ {
return const_local_iterator(base.end(n)); return const_local_iterator(base.end(n));
@ -370,11 +341,6 @@ namespace boost
m1.swap(m2); m1.swap(m2);
} }
//! An unordered associative container that associates equivalent keys with another value.
/*! For full details see chapter 23 of the draft C++ standard.
* http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2009.pdf
*/
template <class Key, template <class Key,
class T, class T,
class Hash = hash<Key>, class Hash = hash<Key>,
@ -382,15 +348,16 @@ namespace boost
class Alloc = std::allocator<std::pair<const Key, T> > > class Alloc = std::allocator<std::pair<const Key, T> > >
class unordered_multimap class unordered_multimap
{ {
// Named for the benefit of Doxygen.
typedef boost::unordered_detail::hash_types_equivalent_keys< typedef boost::unordered_detail::hash_types_equivalent_keys<
std::pair<const Key, T>, Key, Hash, Pred, Alloc std::pair<const Key, T>, Key, Hash, Pred, Alloc
> implementation_defined; > implementation;
typename implementation_defined::hash_table base; typename implementation::hash_table base;
public: public:
// types // types
typedef Key key_type; typedef Key key_type;
typedef std::pair<const Key, T> value_type; typedef std::pair<const Key, T> value_type;
typedef T mapped_type; typedef T mapped_type;
@ -403,13 +370,13 @@ namespace boost
typedef typename allocator_type::reference reference; typedef typename allocator_type::reference reference;
typedef typename allocator_type::const_reference const_reference; typedef typename allocator_type::const_reference const_reference;
typedef typename implementation_defined::size_type size_type; typedef typename implementation::size_type size_type;
typedef typename implementation_defined::difference_type difference_type; typedef typename implementation::difference_type difference_type;
typedef typename implementation_defined::iterator iterator; typedef typename implementation::iterator iterator;
typedef typename implementation_defined::const_iterator const_iterator; typedef typename implementation::const_iterator const_iterator;
typedef typename implementation_defined::local_iterator local_iterator; typedef typename implementation::local_iterator local_iterator;
typedef typename implementation_defined::const_local_iterator const_local_iterator; typedef typename implementation::const_local_iterator const_local_iterator;
// construct/destroy/copy // construct/destroy/copy
@ -441,7 +408,7 @@ namespace boost
private: private:
typename implementation_defined::iterator_base const& typename implementation::iterator_base const&
get(const_iterator const& it) get(const_iterator const& it)
{ {
return boost::unordered_detail::iterator_access::get(it); return boost::unordered_detail::iterator_access::get(it);

52
include/boost/unordered_set.hpp
View File

@ -21,26 +21,22 @@
namespace boost namespace boost
{ {
//! An unordered associative container that stores unique values.
/*! For full details see chapter 23 of the draft C++ standard.
* http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2009.pdf
*/
template <class Value, template <class Value,
class Hash = hash<Value>, class Hash = hash<Value>,
class Pred = std::equal_to<Value>, class Pred = std::equal_to<Value>,
class Alloc = std::allocator<Value> > class Alloc = std::allocator<Value> >
class unordered_set class unordered_set
{ {
// Named for the benefit of Doxygen.
typedef boost::unordered_detail::hash_types_unique_keys< typedef boost::unordered_detail::hash_types_unique_keys<
Value, Value, Hash, Pred, Alloc Value, Value, Hash, Pred, Alloc
> implementation_defined; > implementation;
typename implementation_defined::hash_table base; typename implementation::hash_table base;
public: public:
// types // types
typedef Value key_type; typedef Value key_type;
typedef Value value_type; typedef Value value_type;
typedef Hash hasher; typedef Hash hasher;
@ -52,13 +48,13 @@ namespace boost
typedef typename allocator_type::reference reference; typedef typename allocator_type::reference reference;
typedef typename allocator_type::const_reference const_reference; typedef typename allocator_type::const_reference const_reference;
typedef typename implementation_defined::size_type size_type; typedef typename implementation::size_type size_type;
typedef typename implementation_defined::difference_type difference_type; typedef typename implementation::difference_type difference_type;
typedef typename implementation_defined::const_iterator iterator; typedef typename implementation::const_iterator iterator;
typedef typename implementation_defined::const_iterator const_iterator; typedef typename implementation::const_iterator const_iterator;
typedef typename implementation_defined::const_local_iterator local_iterator; typedef typename implementation::const_local_iterator local_iterator;
typedef typename implementation_defined::const_local_iterator const_local_iterator; typedef typename implementation::const_local_iterator const_local_iterator;
// construct/destroy/copy // construct/destroy/copy
@ -89,7 +85,7 @@ namespace boost
private: private:
typename implementation_defined::iterator_base const& typename implementation::iterator_base const&
get(const_iterator const& it) get(const_iterator const& it)
{ {
return boost::unordered_detail::iterator_access::get(it); return boost::unordered_detail::iterator_access::get(it);
@ -310,26 +306,22 @@ namespace boost
m1.swap(m2); m1.swap(m2);
} }
//! An unordered associative container that stores equivalent values.
/*! For full details see chapter 23 of the draft C++ standard.
* http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2009.pdf
*/
template <class Value, template <class Value,
class Hash = hash<Value>, class Hash = hash<Value>,
class Pred = std::equal_to<Value>, class Pred = std::equal_to<Value>,
class Alloc = std::allocator<Value> > class Alloc = std::allocator<Value> >
class unordered_multiset class unordered_multiset
{ {
// Named for the benefit of Doxygen.
typedef boost::unordered_detail::hash_types_equivalent_keys< typedef boost::unordered_detail::hash_types_equivalent_keys<
Value, Value, Hash, Pred, Alloc Value, Value, Hash, Pred, Alloc
> implementation_defined; > implementation;
typename implementation_defined::hash_table base; typename implementation::hash_table base;
public: public:
//types //types
typedef Value key_type; typedef Value key_type;
typedef Value value_type; typedef Value value_type;
typedef Hash hasher; typedef Hash hasher;
@ -341,13 +333,13 @@ namespace boost
typedef typename allocator_type::reference reference; typedef typename allocator_type::reference reference;
typedef typename allocator_type::const_reference const_reference; typedef typename allocator_type::const_reference const_reference;
typedef typename implementation_defined::size_type size_type; typedef typename implementation::size_type size_type;
typedef typename implementation_defined::difference_type difference_type; typedef typename implementation::difference_type difference_type;
typedef typename implementation_defined::const_iterator iterator; typedef typename implementation::const_iterator iterator;
typedef typename implementation_defined::const_iterator const_iterator; typedef typename implementation::const_iterator const_iterator;
typedef typename implementation_defined::const_local_iterator local_iterator; typedef typename implementation::const_local_iterator local_iterator;
typedef typename implementation_defined::const_local_iterator const_local_iterator; typedef typename implementation::const_local_iterator const_local_iterator;
// construct/destroy/copy // construct/destroy/copy
@ -378,7 +370,7 @@ namespace boost
private: private:
typename implementation_defined::iterator_base const& typename implementation::iterator_base const&
get(const_iterator const& it) get(const_iterator const& it)
{ {
return boost::unordered_detail::iterator_access::get(it); return boost::unordered_detail::iterator_access::get(it);