c++ - GMP 文档中的命名约定

Question

目前我正在查看 GMP 库的文档，我在理解函数规范中列出的变量的命名约定时遇到了一些困难。

特别是 rop 和 op 的使用让我感到困惑。

这是列出导入和导出函数的页面，由于我对命名约定的混淆，我很难理解它们到底要做什么。

https://gmplib.org/manual/Integer-Import-and-Export.html

是否可以获得关于变量命名约定的解释，以及函数作用的解释(希望我能更好地理解仅仅知道命名约定就可以提供)？

Answer 1

GMP 库的命名约定是rop 表示结果操作数 或输出操作数。而 op 是一个输入操作数。请注意，您可能以这种方式为每个函数设置多个 rop。

GMP 的 API 函数经过设计，因此 rop 始终位于之前 op。关于其文档，§3.4 Variable Conventions :

GMP functions generally have output arguments before input arguments. This notation is by analogy with the assignment operator.

例如，要计算大整数的平方根，您可以使用原型(prototype)声明函数:

void mpz_sqrt (mpz t rop, const mpz t op);

rop 存储 sqrt(op) 的结果。