Top of document
©Copyright 1999 Rogue Wave Software

divides


     Function Object

Summary

Returns the result of dividing its first argument by its second.

Contents

Synopsis

#include <functional>
template <class T>
struct divides;

Description

divides is a binary function object. Its operator() returns the result of dividing x by y. You can pass a divides object to any algorithm that requires a binary function. For example, the transform algorithm applies a binary operation to corresponding values in two collections and stores the result. divides would be used in that algorithm in the following manner:

vector<int> vec1;
vector<int> vec2;
vector<int> vecResult;
.
.
.
transform(vec1.begin(), vec1.end(),          vec2.begin(), vecResult.begin(), 
          divides<int>());

After this call to transform, vecResult[n] will contain vec1[n] divided by vec2[n].

Interface

template <class T>
   struct divides : binary_function<T, T, T> 
{
  typedef typename binary_function<T, T, T>::second_argument_type
                                             second_argument_type;
  typedef typename binary_function<T, T, T>::first_argument_type 
                                             first_argument_type;
  typedef typename binary_function<T, T, T>::result_type  
                                             result_type;
  T operator() (const T&, const T&) const;
};

See Also

binary_function, Function Objects


Top of document