C++函数对象-运算符函数对象-算术运算-实现 x % y 的函数对象（std::modulus）

任何定义了函数调用操作符的对象都是函数对象。C++ 支持创建、操作新的函数对象，同时也提供了许多内置的函数对象。

运算符函数对象

C++ 针对常用的算术和逻辑运算定义了很多函数对象：

算术运算

实现 x % y 的函数对象

std::modulus

template< class T > struct modulus;		(C++14 前)
template< class T = void > struct modulus;		(C++14 起)

计算除法余数的函数对象。为类型 T 实现 operator% 。

特化

标准库提供 std::modulus 在不指定 T 时的特化，使参数类型和返回类型留待推导。 modulus<void> 实现 x % y 并推导参数和返回类型的函数对象 (类模板特化)

(C++14 起)

成员类型 类型 定义 result_type(C++17 中弃用) T first_argument_type(C++17 中弃用) T second_argument_type(C++17 中弃用) T

(C++20 前)

成员函数

operator()

返回首参数除以第二参数的余数 (公开成员函数)

std::modulus::operator()

T operator()( const T& lhs, const T& rhs ) const;		(C++14 前)
constexpr T operator()( const T& lhs, const T& rhs ) const;		(C++14 起)

返回 lhs 除以 rhs 的余数。

参数

lhs, rhs

-

以一个除另一个的值

返回值

lhs % rhs 的结果。

异常

（无）

 

可能的实现

constexpr T operator()(const T &lhs, const T &rhs) const 
{
    return lhs % rhs;
}

 

调用示例

#include <iostream>
#include <functional>

struct Cell
{
    int x;
    int y;

    Cell() = default;
    Cell(int a, int b): x(a), y(b) {}
    Cell(const Cell &cell)
    {
        x = cell.x;
        y = cell.y;
    }

    bool operator <(const Cell &cell) const
    {
        if (x == cell.x)
        {
            return y < cell.y;
        }
        else
        {
            return x < cell.x;
        }
    }

    Cell &operator+(const Cell &cell)
    {
        x += cell.x;
        y += cell.y;
        return *this;
    }

    Cell &operator+=(const Cell &cell)
    {
        x += cell.x;
        y += cell.y;
        return *this;
    }

    Cell &operator*=(int n)
    {
        x *= n;
        y *= n;
        return *this;
    }

    Cell &operator++()
    {
        x += 1;
        y += 1;
        return *this;
    }

    friend Cell operator +(const Cell &cell1, const Cell &cell2)
    {
        Cell cell = cell1;
        cell += cell2;
        return cell;
    }

    friend Cell operator *(const Cell &cell1, const Cell &cell2)
    {
        Cell cell = {cell1.x * cell2.x, cell1.y * cell2.y};
        return cell;
    }

    friend Cell operator /(const Cell &cell1, const Cell &cell2)
    {
        Cell cell = {cell1.x / cell2.x, cell1.y / cell2.y};
        return cell;
    }

    friend Cell operator %(const Cell &cell1, const Cell &cell2)
    {
        Cell cell = {cell1.x % cell2.x, cell1.y % cell2.y};
        return cell;
    }
};

std::ostream &operator<<(std::ostream &os, const Cell &cell)
{
    os << "{" << cell.x << "," << cell.y << "}";
    return os;
}

int main()
{
    std::cout << "std::modulus<char>()(50, 2):             "
              << std::modulus<char>()(50, 2) << std::endl;
    std::cout << "std::modulus<int>()(1023, 1024):         "
              << std::modulus<int>()(1023, 1024) << std::endl;
    std::cout << "std::modulus<long>()(1023, 1024):        "
              << std::modulus<long>()(1023, 1024) << std::endl;
    std::cout << "std::modulus<long long>()(1023, 1024):   "
              << std::modulus<long long>()(1023, 1024) << std::endl;

    std::cout << "std::modulus<uint8_t>()(1023, 1024):     "
              << std::modulus<uint8_t>()(8, 32) << std::endl;
    std::cout << "std::modulus<uint16_t>()(123, 456):      "
              << std::modulus<uint16_t>()(123, 456) << std::endl;
    std::cout << "std::modulus<uint32_t>()(101, 202):      "
              << std::modulus<uint32_t>()(101, 202) << std::endl;
    std::cout << "std::modulus<uint64_t>()(10230, 10240):  "
              << std::modulus<uint64_t>()(10230, 10240) << std::endl;

    std::cout << "std::modulus<int8_t>()(1023, 1024):      "
              << std::modulus<int8_t>()(8, 32) << std::endl;
    std::cout << "std::modulus<int16_t>()(123, 456):       "
              << std::modulus<int16_t>()(123, 456) << std::endl;
    std::cout << "std::modulus<int32_t>()(101, 202):       "
              << std::modulus<int32_t>()(101, 202) << std::endl;
    std::cout << "std::modulus<int64_t>()(10230, 10240):   "
              << std::modulus<int64_t>()(10230, 10240) << std::endl;

    //浮点型不能取余
//    std::cout << "std::modulus<double>()(3.14, 3.14):      "
//              << std::modulus<double>()(3.14, 3.14) << std::endl;
//    std::cout << "std::modulus<float>()(3.14, 3.14):       "
//              << std::modulus<float>()(3.14, 3.14) << std::endl;
//    std::cout << "std::modulus<float>()(3, 3):             "
//              << std::modulus<float>()(3, 3) << std::endl;
//    std::cout << "std::modulus<float>()(3.56, 3.14):       "
//              << std::modulus<float>()(3.56, 3.14) << std::endl;
//    std::cout << "std::modulus<int>()(3.14, 3.14):         "
//              << std::modulus<int>()(3.34, 3.34) << std::endl;

    std::cout << "std::modulus<Cell>()(Cell{101, 101}, Cell{202, 202}):       "
              << std::modulus<Cell>()(Cell{101, 101}, Cell{202, 202}) << std::endl;

    //编译失败
//    std::cout << "std::modulus<std::string>()(\"I am a \", \"handsome programmer\"):"
//              << std::modulus<std::string>()("I am a ", "handsome programmer") << std::endl;
    return 0;
}

输出

std::modulus<char>()(50, 2):
std::modulus<int>()(1023, 1024):         1023
std::modulus<long>()(1023, 1024):        1023
std::modulus<long long>()(1023, 1024):   1023
std::modulus<uint8_t>()(1023, 1024):
std::modulus<uint16_t>()(123, 456):      123
std::modulus<uint32_t>()(101, 202):      101
std::modulus<uint64_t>()(10230, 10240):  10230
std::modulus<int8_t>()(1023, 1024):
std::modulus<int16_t>()(123, 456):       123
std::modulus<int32_t>()(101, 202):       101
std::modulus<int64_t>()(10230, 10240):   10230
std::modulus<Cell>()(Cell{101, 101}, Cell{202, 202}):       {101,101}