cplusplus.com cplusplus.com
cplusplus.com   C++ : Reference : STL Containers : map : rbegin
- -
C++
Information
Documentation
Reference
Articles
Sourcecode
Forum
Reference
C Library
IOstream Library
Strings library
STL Containers
STL Algorithms
STL Containers
bitset
deque
list
map
multimap
multiset
priority_queue
queue
set
stack
vector
map
comparison operators
map::map
map::~map
member functions:
· map::begin
· map::clear
· map::count
· map::empty
· map::end
· map::equal_range
· map::erase
· map::find
· map::get_allocator
· map::insert
· map::key_comp
· map::lower_bound
· map::max_size
· map::operator=
· map::operator[]
· map::rbegin
· map::rend
· map::size
· map::swap
· map::upper_bound
· map::value_comp

-

map::rbegin public member function
      reverse_iterator rbegin();
const_reverse_iterator rbegin() const;

Return reverse iterator to reverse beginning

Returns a reverse iterator referring to the last element in the map container.

Internally, map containers keep their elements ordered by their key from lower to higher, therefore rbegin returns the element with the highest key in the map.

Notice that rbegin does not refer to the same element as end, but to the element right before it.

Parameters

none

Return Value

A reverse iterator to the reverse beginning of the sequence.

Both reverse_iterator and const_reverse_iterator are member types. In the map class template, these are reverse bidirectional iterators, defined as reverse_iterator<iterator> and reverse_iterator<const_iterator> respectivelly.

Dereferencing this iterator accesses the element's value, which is of type pair<const Key,T>.

Example

// map::rbegin/rend
#include <iostream>
#include <map>
using namespace std;

int main ()
{
  map<char,int> mymap;
  map<char,int>::reverse_iterator rit;

  mymap['x'] = 100;
  mymap['y'] = 200;
  mymap['z'] = 300;

  // show content:
  for ( rit=mymap.rbegin() ; rit != mymap.rend(); rit++ )
    cout << rit->first << " => " << rit->second << endl;

  return 0;
}

Output:

z => 300
y => 200
x => 100

Complexity

Constant.

See also

map::rend Return reverse iterator to reverse end (public member function)
map::begin Return iterator to beginning (public member function)
map::end Return iterator to end (public member function)

© The C++ Resources Network, 2000-2007 - All rights reserved
Spotted an error? - contact us