min()

Library:  Algorithms

Function

• Local Index
• Summary
• Synopsis
• Description
• Example
• See Also
• Standards Conformance

Algorithm that returns the minimum of a pair of values

#include <algorithm>

namespace std {
  template <class T>
  const T& min(const T&, const T&);

  template <class T, class Compare>
  const T& min(const T& a, const T&, Compare);
}

The min() algorithm determines and returns the minimum of a pair of values. In the second version of the algorithm, the argument Compare defines a function object that can be used in place of operator<().

min() returns the first argument when the two arguments are equal.

//
//  max.cpp
//

#include <algorithm>    // for max, min
#include <functional>   // for greater
#include <iostream>     // for cout


int main ()
{
    double d1 = 10.0, d2 = 20.0;

    // Find minimum.
    double val1 = std::min (d1, d2);

    // The greater comparator returns the greater of 
    // the two values.
    double val2 = std::min (d1, d2, std::greater<double>());

    // Find minimum.
    double val3 = std::max (d1, d2);

    // The less comparator returns the smaller of 
    // the two values.

    // Note that, like every comparison in the library, max is
    // defined in terms of the < operator, so using less here
    // is the same as using the max algorithm with a default
    // comparator.
    double val4 = std::max(d1, d2, std::less<double>());

    std::cout << val1 << " " << val2 << " "
              << val3 << " " << val4 << std::endl;

    return 0;
}


Program Output:

10 20 20 20

max(), max_element(), min_element()

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