Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of boost. Click here for the latest Boost documentation.

Struct template minimum

boost::mpi::minimum — Compute the minimum of two values.

Synopsis

// In header: <boost/mpi/operations.hpp>

template<typename T> 
struct minimum {
  // types
  typedef T first_argument_type; 
  typedef T second_argument_type;
  typedef T result_type;         

  // public member functions
  const T & operator()(const T &, const T &) const;
};

Description

This binary function object computes the minimum of the two values it is given. When used with MPI and a type T that has an associated, built-in MPI data type, translates to MPI_MIN.

`minimum` public member functions

const T & operator()(const T & x, const T & y) const;

Returns:

the minimum of x and y.