modulus

Category: functors		Component type: type

Description

Modulus<T> is a functors. Specifically, it is an AdaptableBinaryFunction. If f is an object of class modulus<T> and x and y are objects of class T, then f(x,y) returns xy.

Example

Each element in V3 will be the modulus of the corresponding elements in V1 and V2

const int N = 1000;
Vector<double> V1(N);
Vector<double> V2(N);
Vector<double> V3(N);

iota(V1.begin(), V1.end(), 1);
fill(V2.begin(), V2.end(), 75);

assert(V2.size() >= V1.size() && V3.size() >= V1.size());
transform(V1.begin(), V1.end(), V2.begin(), V3.begin(),
          modulus<int>());

Definition

Defined in the standard header functional, and in the nonstandard backward-compatibility header function.h.

Template parameters

Parameter	Description	Default
T	The function object's argument type and result type.

Model of

AdaptableBinaryFunction, DefaultConstructible

Type requirements

T must be an integral type; if x and y are objects of type T, then xy must be defined and must have a return type that is convertible to T. T must be Assignable.

Public base classes

binary_function<T, T, T>

Members

Member	Where defined	Description
first_argument_type	AdaptableBinaryFunction	The type of the first argument: T
second_argument_type	AdaptableBinaryFunction	The type of the second argument: T
result_type	AdaptableBinaryFunction	The type of the result: T
T operator()(const T& x, const T& y)	AdaptableBinaryFunction	Function call operator. The return value is x % y.
modulus()	DefaultConstructible	The default constructor.

New members

All of modulus's members are defined in the AdaptableBinaryFunction and DefaultConstructible requirements. Modulus does not introduce any new members.

Notes

See also

The functors overview, AdaptableBinaryFunction, binary_function, plus, minus, multiplies, divides, negate