Previous fileTop of DocumentContentsIndex pageNext file
Apache C++ Standard Library Reference Guide

max_element()

Library:  Algorithms


Function

Local Index

No Entries

Summary

An algorithm that finds the maximum value in a range

Synopsis

#include <algorithm>

namespace std {
  template <class ForwardIterator>
  ForwardIterator
  max_element(ForwardIterator start, ForwardIterator finish);

  template <class ForwardIterator, class Compare>
  ForwardIterator
  max_element(ForwardIterator start, ForwardIterator finish,
              Compare comp);
}

Description

The max_element() algorithm returns an iterator that denotes the maximum element in a sequence. If the sequence contains more than one copy of the element, the iterator points to its first occurrence. The optional argument comp defines a function object that can be used in place of operator<().

Algorithm max_element() returns the first iterator i in the range [start, finish) such that for any iterator j in the same range either of the following conditions hold:

!(*i < *j)

or

comp(*i, *j) == false.

Complexity

Exactly max((finish - start) - 1, 0) applications of the corresponding comparisons are done for max_element().

Example

See Also

max(), min(), min_element()

Standards Conformance

ISO/IEC 14882:1998 -- International Standard for Information Systems -- Programming Language C++, Section 25.3.7



Previous fileTop of DocumentContentsIndex pageNext file