Skip to content

A
abseil-cpp
Commit c22c032a by Abseil Team Committed by dinord
Options

Export of internal Abseil changes 

--
4fd27d1c0fda72a8772f2779714c327b18ae657b by Derek Mauro <dmauro@google.com>:

Adds missing documentation for btree's lower_bound and upper_bound methods

PiperOrigin-RevId: 395777262
GitOrigin-RevId: 4fd27d1c0fda72a8772f2779714c327b18ae657b
Change-Id: Ife2f9149bcf30523be93ee9d8919c7085a9d3a29
parent 8c800bb0
Showing with 118 additions and 24 deletions
absl/container/btree_map.h
...@@ -366,8 +366,8 @@ class btree_map ...@@ -366,8 +366,8 @@ class btree_map
// Determines whether an element comparing equal to the given `key` exists // Determines whether an element comparing equal to the given `key` exists
// within the `btree_map`, returning `true` if so or `false` otherwise. // within the `btree_map`, returning `true` if so or `false` otherwise.
// //
// Supports heterogeneous lookup, provided that the map is provided a // Supports heterogeneous lookup, provided that the map has a compatible
// compatible heterogeneous comparator. // heterogeneous comparator.
using Base::contains; using Base::contains;
// btree_map::count() // btree_map::count()
...@@ -378,8 +378,8 @@ class btree_map ...@@ -378,8 +378,8 @@ class btree_map
// the `btree_map`. Note that this function will return either `1` or `0` // the `btree_map`. Note that this function will return either `1` or `0`
// since duplicate elements are not allowed within a `btree_map`. // since duplicate elements are not allowed within a `btree_map`.
// //
// Supports heterogeneous lookup, provided that the map is provided a // Supports heterogeneous lookup, provided that the map has a compatible
// compatible heterogeneous comparator. // heterogeneous comparator.
using Base::count; using Base::count;
// btree_map::equal_range() // btree_map::equal_range()
...@@ -395,10 +395,34 @@ class btree_map ...@@ -395,10 +395,34 @@ class btree_map
// //
// Finds an element with the passed `key` within the `btree_map`. // Finds an element with the passed `key` within the `btree_map`.
// //
// Supports heterogeneous lookup, provided that the map is provided a // Supports heterogeneous lookup, provided that the map has a compatible
// compatible heterogeneous comparator. // heterogeneous comparator.
using Base::find; using Base::find;
// btree_map::lower_bound()
//
// template <typename K> iterator lower_bound(const K& key):
// template <typename K> const_iterator lower_bound(const K& key) const:
//
// Finds the first element with a key that is not less than `key` within the
// `btree_map`.
//
// Supports heterogeneous lookup, provided that the map has a compatible
// heterogeneous comparator.
using Base::lower_bound;
// btree_map::upper_bound()
//
// template <typename K> iterator upper_bound(const K& key):
// template <typename K> const_iterator upper_bound(const K& key) const:
//
// Finds the first element with a key that is greater than `key` within the
// `btree_map`.
//
// Supports heterogeneous lookup, provided that the map has a compatible
// heterogeneous comparator.
using Base::upper_bound;
// btree_map::operator[]() // btree_map::operator[]()
// //
// Returns a reference to the value mapped to the passed key within the // Returns a reference to the value mapped to the passed key within the
...@@ -691,8 +715,8 @@ class btree_multimap ...@@ -691,8 +715,8 @@ class btree_multimap
// Determines whether an element comparing equal to the given `key` exists // Determines whether an element comparing equal to the given `key` exists
// within the `btree_multimap`, returning `true` if so or `false` otherwise. // within the `btree_multimap`, returning `true` if so or `false` otherwise.
// //
// Supports heterogeneous lookup, provided that the map is provided a // Supports heterogeneous lookup, provided that the map has a compatible
// compatible heterogeneous comparator. // heterogeneous comparator.
using Base::contains; using Base::contains;
// btree_multimap::count() // btree_multimap::count()
...@@ -702,8 +726,8 @@ class btree_multimap ...@@ -702,8 +726,8 @@ class btree_multimap
// Returns the number of elements comparing equal to the given `key` within // Returns the number of elements comparing equal to the given `key` within
// the `btree_multimap`. // the `btree_multimap`.
// //
// Supports heterogeneous lookup, provided that the map is provided a // Supports heterogeneous lookup, provided that the map has a compatible
// compatible heterogeneous comparator. // heterogeneous comparator.
using Base::count; using Base::count;
// btree_multimap::equal_range() // btree_multimap::equal_range()
...@@ -720,10 +744,34 @@ class btree_multimap ...@@ -720,10 +744,34 @@ class btree_multimap
// //
// Finds an element with the passed `key` within the `btree_multimap`. // Finds an element with the passed `key` within the `btree_multimap`.
// //
// Supports heterogeneous lookup, provided that the map is provided a // Supports heterogeneous lookup, provided that the map has a compatible
// compatible heterogeneous comparator. // heterogeneous comparator.
using Base::find; using Base::find;
// btree_multimap::lower_bound()
//
// template <typename K> iterator lower_bound(const K& key):
// template <typename K> const_iterator lower_bound(const K& key) const:
//
// Finds the first element with a key that is not less than `key` within the
// `btree_multimap`.
//
// Supports heterogeneous lookup, provided that the map has a compatible
// heterogeneous comparator.
using Base::lower_bound;
// btree_multimap::upper_bound()
//
// template <typename K> iterator upper_bound(const K& key):
// template <typename K> const_iterator upper_bound(const K& key) const:
//
// Finds the first element with a key that is greater than `key` within the
// `btree_multimap`.
//
// Supports heterogeneous lookup, provided that the map has a compatible
// heterogeneous comparator.
using Base::upper_bound;
// btree_multimap::get_allocator() // btree_multimap::get_allocator()
// //
// Returns the allocator function associated with this `btree_multimap`. // Returns the allocator function associated with this `btree_multimap`.
......
absl/container/btree_set.h
...@@ -300,8 +300,8 @@ class btree_set ...@@ -300,8 +300,8 @@ class btree_set
// Determines whether an element comparing equal to the given `key` exists // Determines whether an element comparing equal to the given `key` exists
// within the `btree_set`, returning `true` if so or `false` otherwise. // within the `btree_set`, returning `true` if so or `false` otherwise.
// //
// Supports heterogeneous lookup, provided that the set is provided a // Supports heterogeneous lookup, provided that the set has a compatible
// compatible heterogeneous comparator. // heterogeneous comparator.
using Base::contains; using Base::contains;
// btree_set::count() // btree_set::count()
...@@ -312,8 +312,8 @@ class btree_set ...@@ -312,8 +312,8 @@ class btree_set
// the `btree_set`. Note that this function will return either `1` or `0` // the `btree_set`. Note that this function will return either `1` or `0`
// since duplicate elements are not allowed within a `btree_set`. // since duplicate elements are not allowed within a `btree_set`.
// //
// Supports heterogeneous lookup, provided that the set is provided a // Supports heterogeneous lookup, provided that the set has a compatible
// compatible heterogeneous comparator. // heterogeneous comparator.
using Base::count; using Base::count;
// btree_set::equal_range() // btree_set::equal_range()
...@@ -330,10 +330,32 @@ class btree_set ...@@ -330,10 +330,32 @@ class btree_set
// //
// Finds an element with the passed `key` within the `btree_set`. // Finds an element with the passed `key` within the `btree_set`.
// //
// Supports heterogeneous lookup, provided that the set is provided a // Supports heterogeneous lookup, provided that the set has a compatible
// compatible heterogeneous comparator. // heterogeneous comparator.
using Base::find; using Base::find;
// btree_set::lower_bound()
//
// template <typename K> iterator lower_bound(const K& key):
// template <typename K> const_iterator lower_bound(const K& key) const:
//
// Finds the first element that is not less than `key` within the `btree_set`.
//
// Supports heterogeneous lookup, provided that the set has a compatible
// heterogeneous comparator.
using Base::lower_bound;
// btree_set::upper_bound()
//
// template <typename K> iterator upper_bound(const K& key):
// template <typename K> const_iterator upper_bound(const K& key) const:
//
// Finds the first element that is greater than `key` within the `btree_set`.
//
// Supports heterogeneous lookup, provided that the set has a compatible
// heterogeneous comparator.
using Base::upper_bound;
// btree_set::get_allocator() // btree_set::get_allocator()
// //
// Returns the allocator function associated with this `btree_set`. // Returns the allocator function associated with this `btree_set`.
...@@ -604,8 +626,8 @@ class btree_multiset ...@@ -604,8 +626,8 @@ class btree_multiset
// Determines whether an element comparing equal to the given `key` exists // Determines whether an element comparing equal to the given `key` exists
// within the `btree_multiset`, returning `true` if so or `false` otherwise. // within the `btree_multiset`, returning `true` if so or `false` otherwise.
// //
// Supports heterogeneous lookup, provided that the set is provided a // Supports heterogeneous lookup, provided that the set has a compatible
// compatible heterogeneous comparator. // heterogeneous comparator.
using Base::contains; using Base::contains;
// btree_multiset::count() // btree_multiset::count()
...@@ -615,8 +637,8 @@ class btree_multiset ...@@ -615,8 +637,8 @@ class btree_multiset
// Returns the number of elements comparing equal to the given `key` within // Returns the number of elements comparing equal to the given `key` within
// the `btree_multiset`. // the `btree_multiset`.
// //
// Supports heterogeneous lookup, provided that the set is provided a // Supports heterogeneous lookup, provided that the set has a compatible
// compatible heterogeneous comparator. // heterogeneous comparator.
using Base::count; using Base::count;
// btree_multiset::equal_range() // btree_multiset::equal_range()
...@@ -633,10 +655,34 @@ class btree_multiset ...@@ -633,10 +655,34 @@ class btree_multiset
// //
// Finds an element with the passed `key` within the `btree_multiset`. // Finds an element with the passed `key` within the `btree_multiset`.
// //
// Supports heterogeneous lookup, provided that the set is provided a // Supports heterogeneous lookup, provided that the set has a compatible
// compatible heterogeneous comparator. // heterogeneous comparator.
using Base::find; using Base::find;
// btree_multiset::lower_bound()
//
// template <typename K> iterator lower_bound(const K& key):
// template <typename K> const_iterator lower_bound(const K& key) const:
//
// Finds the first element that is not less than `key` within the
// `btree_multiset`.
//
// Supports heterogeneous lookup, provided that the set has a compatible
// heterogeneous comparator.
using Base::lower_bound;
// btree_multiset::upper_bound()
//
// template <typename K> iterator upper_bound(const K& key):
// template <typename K> const_iterator upper_bound(const K& key) const:
//
// Finds the first element that is greater than `key` within the
// `btree_multiset`.
//
// Supports heterogeneous lookup, provided that the set has a compatible
// heterogeneous comparator.
using Base::upper_bound;
// btree_multiset::get_allocator() // btree_multiset::get_allocator()
// //
// Returns the allocator function associated with this `btree_multiset`. // Returns the allocator function associated with this `btree_multiset`.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment