modulus Struct

The struct provides a predefined function object that performs the modular operation of calculating the remainder after division between elements.

template<class Type>
   struct modulus : public binary_function <Type, Type, Type> 
   {
      Type operator()(
         const Type& _Left, 
         const Type& _Right
      ) const;
   };

Parameters

• _Left
  A number that is of the parameter type Type into which another number is to be divided by the function object.

• _Right
  A number that is of the parameter type Type that is to be divided into another by the function object.

Return Value

The remainder of the division _Left / _Right.

Remarks

The modulus<Type> operator is restricted to integral types for the basic data types, or to any user-defined type that implements operator%.

Example

// functional_modulus.cpp
// compile with: /EHsc
#include <vector>
#include <functional>
#include <algorithm>
#include <iostream>

using namespace std;

int main( )
{
   vector <int> v1, v2, v3 ( 6 );
   vector <int>::iterator Iter1, Iter2, Iter3;
   
   int i;
   for ( i = 1 ; i <= 6 ; i++ )
   {
      v1.push_back( 5 * i );
   }

   int j;
   for ( j = 1 ; j <= 6 ; j++ )
   {
      v2.push_back( 3 * j );
   }

   cout << "The vector v1 = ( " ;
   for ( Iter1 = v1.begin( ) ; Iter1 != v1.end( ) ; Iter1++ )
      cout << *Iter1 << " ";
   cout << ")" << endl;

   cout << "The vector v2 = ( " ;
   for ( Iter2 = v2.begin( ) ; Iter2 != v2.end( ) ; Iter2++ )
      cout << *Iter2 << " ";
   cout << ")" << endl;

   // Finding the element-wise remainders of the elements of v1 & v2
   transform (v1.begin( ),  v1.end( ), v2.begin( ), v3.begin ( ), 
      modulus<int>() );

   cout << "The element-wise remainders of the modular division\n are: ( " ;
   for ( Iter3 = v3.begin( ) ; Iter3 != v3.end( ) ; Iter3++ )
      cout << *Iter3 << " ";
   cout << ")" << endl;
}

The vector v1 = ( 5 10 15 20 25 30 )
The vector v2 = ( 3 6 9 12 15 18 )
The element-wise remainders of the modular division
 are: ( 2 4 6 8 10 12 )

Requirements

Header: <functional>

Namespace: std

See Also

Concepts

<functional> Members

Thread Safety in the Standard C++ Library

Standard Template Library