numpy.i: NumPy 的 SWIG 接口文件#

引言#

简单包装器和接口生成器（或 SWIG）是一个强大的工具，用于生成包装器代码，以与各种脚本语言进行接口。 SWIG 可以解析头文件，并仅使用代码原型创建与目标语言的接口。但 SWIG 并非无所不能。例如，它无法从原型中得知

double rms(double* seq, int n);

seq 到底是什么。它是一个要就地更改的单个值吗？它是一个数组吗，如果是，它的长度是多少？它是只输入吗？只输出吗？输入-输出？ SWIG 无法确定这些细节，也不试图这样做。

如果我们设计 rms，我们可能会将其设计为一个例程，接受一个名为 seq 的长度为 n 的 double 值只输入数组，并返回均方根。然而，SWIG 的默认行为是创建一个包装函数，该函数可以编译，但几乎无法以 C 例程预期的方式从脚本语言中使用。

对于 Python，处理连续（或技术上，*跨步*）同构数据块的首选方式是使用 NumPy，它提供了对多维数据数组的完全面向对象访问。因此，rms 函数最合乎逻辑的 Python 接口将是（包括文档字符串）

def rms(seq):
    """
    rms: return the root mean square of a sequence
    rms(numpy.ndarray) -> double
    rms(list) -> double
    rms(tuple) -> double
    """

其中 seq 将是一个 double 值 NumPy 数组，其长度 n 将在内部从 seq 中提取，然后传递给 C 例程。更好的是，由于 NumPy 支持从任意 Python 序列构造数组，seq 本身可以是一个几乎任意的序列（只要每个元素都可以转换为 double），并且包装器代码将在内部将其转换为 NumPy 数组，然后提取其数据和长度。

SWIG 允许通过一种称为 *类型映射* 的机制定义这些类型的转换。本文档提供了如何使用 numpy.i 的信息，numpy.i 是一个 SWIG 接口文件，它定义了一系列类型映射，旨在使上述数组相关转换的实现相对简单。例如，假设上面定义的 rms 函数原型位于名为 rms.h 的头文件中。要获得上面讨论的 Python 接口，您的 SWIG 接口文件需要以下内容

%{
#define SWIG_FILE_WITH_INIT
#include "rms.h"
%}

%include "numpy.i"

%init %{
import_array();
%}

%apply (double* IN_ARRAY1, int DIM1) {(double* seq, int n)};
%include "rms.h"

类型映射根据一个或多个函数参数的列表进行键控，可以是按类型或按类型和名称。我们将这些列表称为 *签名*。上面使用的一个由 numpy.i 定义的许多类型映射，其签名是 (double* IN_ARRAY1, int DIM1)。参数名称旨在表明 double* 参数是一个一维输入数组，而 int 代表该维度的尺寸。这正是 rms 原型中的模式。

最有可能的是，要包装的实际原型不会有参数名称 IN_ARRAY1 和 DIM1。我们使用 SWIG 的 %apply 指令将类型为 double 的一维输入数组的类型映射应用于 rms 所使用的实际原型。因此，有效地使用 numpy.i 需要了解有哪些类型映射可用以及它们的作用。

包含上述 SWIG 指令的 SWIG 接口文件将生成类似于以下的包装器代码

PyObject *_wrap_rms(PyObject *args) {
 PyObject *resultobj = 0;
 double *arg1 = (double *) 0 ;
 int arg2 ;
 double result;
 PyArrayObject *array1 = NULL ;
 int is_new_object1 = 0 ;
 PyObject * obj0 = 0 ;
 9
 if (!PyArg_ParseTuple(args,(char *)"O:rms",&obj0)) SWIG_fail;
 {
   array1 = obj_to_array_contiguous_allow_conversion(
                obj0, NPY_DOUBLE, &is_new_object1);
   npy_intp size[1] = {
     -1
   };
   if (!array1 || !require_dimensions(array1, 1) ||
       !require_size(array1, size, 1)) SWIG_fail;
   arg1 = (double*) array1->data;
   arg2 = (int) array1->dimensions[0];
 }
 result = (double)rms(arg1,arg2);
 resultobj = SWIG_From_double((double)(result));
 {
   if (is_new_object1 && array1) Py_DECREF(array1);
 }
 return resultobj;
fail:
 {
   if (is_new_object1 && array1) Py_DECREF(array1);
 }
 return NULL;
}

numpy.i 中的类型映射负责以下代码行：12-20、25 和 30。第 10 行解析 rms 函数的输入。从格式字符串 "O:rms" 中，我们可以看到参数列表预期是一个单一的 Python 对象（由冒号前的 O 指定），其指针存储在 obj0 中。调用 numpy.i 提供的多个函数来执行和检查从通用 Python 对象到 NumPy 数组的（可能）转换。这些函数在辅助函数部分进行了解释，但希望它们的名称是自解释的。在第 12 行，我们使用 obj0 构造一个 NumPy 数组。在第 17 行，我们检查结果的有效性：它非空且具有任意长度的单维度。一旦这些状态得到验证，我们在第 19 和 20 行提取数据缓冲区和长度，以便在第 22 行调用底层的 C 函数。第 25 行执行内存管理，以处理我们创建了一个不再需要的新数组的情况。

这段代码包含大量的错误处理。请注意，SWIG_fail 是 goto fail 的宏，指向第 28 行的标签。如果用户提供了错误的参数数量，这将在第 10 行被捕获。如果 NumPy 数组的构造失败或生成了错误维度的数组，这些错误将在第 17 行被捕获。最后，如果检测到错误，内存仍然在第 30 行得到正确管理。

请注意，如果 C 函数签名顺序不同

double rms(int n, double* seq);

SWIG 将不会将上面给出的类型映射签名与 rms 的参数列表匹配。幸运的是，numpy.i 有一组数据指针位于末尾的类型映射

%apply (int DIM1, double* IN_ARRAY1) {(int n, double* seq)};

这仅仅是导致上面生成的代码中第 3 和 4 行的 arg1 和 arg2 的定义互换，以及第 19 和 20 行的赋值互换。

使用 numpy.i#

numpy.i 文件目前位于 numpy 安装目录下的 tools/swig 子目录中。通常，您会希望将其复制到您开发包装器的目录中。

一个只使用单个 SWIG 接口文件的简单模块应包含以下内容

%{
#define SWIG_FILE_WITH_INIT
%}
%include "numpy.i"
%init %{
import_array();
%}

在一个已编译的 Python 模块中，import_array() 只应该被调用一次。这可能在您编写并链接到模块的 C/C++ 文件中。如果是这种情况，那么您的任何接口文件都不应该 #define SWIG_FILE_WITH_INIT 或调用 import_array()。或者，这个初始化调用可能在 SWIG 从具有如上 %init 块的接口文件生成的包装器文件中。如果是这种情况，并且您有多个 SWIG 接口文件，那么只有一个接口文件应该 #define SWIG_FILE_WITH_INIT 并调用 import_array()。

可用的类型映射#

numpy.i 为不同数据类型（例如 double 和 int）和不同类型维度（例如 int 或 long）的数组提供的类型映射指令除了 C 和 NumPy 类型规范外，彼此相同。因此，这些类型映射是通过宏（通常是幕后）实现的

%numpy_typemaps(DATA_TYPE, DATA_TYPECODE, DIM_TYPE)

可以为适当的 (DATA_TYPE, DATA_TYPECODE, DIM_TYPE) 三元组调用。例如

%numpy_typemaps(double, NPY_DOUBLE, int)
%numpy_typemaps(int,    NPY_INT   , int)

numpy.i 接口文件使用 %numpy_typemaps 宏来实现以下 C 数据类型和 int 维度类型的类型映射

signed char
unsigned char
short
unsigned short
int
unsigned int
long
unsigned long
long long
unsigned long long
float
double

在下面的描述中，我们引用了一个通用的 DATA_TYPE，它可以是上面列出的任何 C 数据类型，以及 DIM_TYPE，它应该是多种整数类型之一。

类型映射签名主要通过缓冲区指针的名称来区分。FARRAY 名称用于 Fortran 顺序数组，ARRAY 名称用于 C 顺序（或一维数组）。

输入数组#

输入数组被定义为传入例程但不会就地更改或返回给用户的数据数组。因此，Python 输入数组可以是几乎任何可以转换为所需数组类型的 Python 序列（例如列表）。输入数组签名如下：

一维

( DATA_TYPE IN_ARRAY1[ANY] )
( DATA_TYPE* IN_ARRAY1, int DIM1 )
( int DIM1, DATA_TYPE* IN_ARRAY1 )

二维

( DATA_TYPE IN_ARRAY2[ANY][ANY] )
( DATA_TYPE* IN_ARRAY2, int DIM1, int DIM2 )
( int DIM1, int DIM2, DATA_TYPE* IN_ARRAY2 )
( DATA_TYPE* IN_FARRAY2, int DIM1, int DIM2 )
( int DIM1, int DIM2, DATA_TYPE* IN_FARRAY2 )

三维

( DATA_TYPE IN_ARRAY3[ANY][ANY][ANY] )
( DATA_TYPE* IN_ARRAY3, int DIM1, int DIM2, int DIM3 )
( int DIM1, int DIM2, int DIM3, DATA_TYPE* IN_ARRAY3 )
( DATA_TYPE* IN_FARRAY3, int DIM1, int DIM2, int DIM3 )
( int DIM1, int DIM2, int DIM3, DATA_TYPE* IN_FARRAY3 )

四维

(DATA_TYPE IN_ARRAY4[ANY][ANY][ANY][ANY])
(DATA_TYPE* IN_ARRAY4, DIM_TYPE DIM1, DIM_TYPE DIM2, DIM_TYPE DIM3, DIM_TYPE DIM4)
(DIM_TYPE DIM1, DIM_TYPE DIM2, DIM_TYPE DIM3, , DIM_TYPE DIM4, DATA_TYPE* IN_ARRAY4)
(DATA_TYPE* IN_FARRAY4, DIM_TYPE DIM1, DIM_TYPE DIM2, DIM_TYPE DIM3, DIM_TYPE DIM4)
(DIM_TYPE DIM1, DIM_TYPE DIM2, DIM_TYPE DIM3, DIM_TYPE DIM4, DATA_TYPE* IN_FARRAY4)

列出的第一个签名 ( DATA_TYPE IN_ARRAY[ANY] ) 用于具有硬编码维度的一维数组。同样，( DATA_TYPE IN_ARRAY2[ANY][ANY] ) 用于具有硬编码维度的二维数组，三维数组以此类推。

就地数组#

就地数组定义为就地修改的数组。输入值可能使用也可能不使用，但函数返回时的值很重要。因此，提供的 Python 参数必须是所需类型的 NumPy 数组。就地签名如下：

一维

( DATA_TYPE INPLACE_ARRAY1[ANY] )
( DATA_TYPE* INPLACE_ARRAY1, int DIM1 )
( int DIM1, DATA_TYPE* INPLACE_ARRAY1 )

二维

( DATA_TYPE INPLACE_ARRAY2[ANY][ANY] )
( DATA_TYPE* INPLACE_ARRAY2, int DIM1, int DIM2 )
( int DIM1, int DIM2, DATA_TYPE* INPLACE_ARRAY2 )
( DATA_TYPE* INPLACE_FARRAY2, int DIM1, int DIM2 )
( int DIM1, int DIM2, DATA_TYPE* INPLACE_FARRAY2 )

三维

( DATA_TYPE INPLACE_ARRAY3[ANY][ANY][ANY] )
( DATA_TYPE* INPLACE_ARRAY3, int DIM1, int DIM2, int DIM3 )
( int DIM1, int DIM2, int DIM3, DATA_TYPE* INPLACE_ARRAY3 )
( DATA_TYPE* INPLACE_FARRAY3, int DIM1, int DIM2, int DIM3 )
( int DIM1, int DIM2, int DIM3, DATA_TYPE* INPLACE_FARRAY3 )

四维

(DATA_TYPE INPLACE_ARRAY4[ANY][ANY][ANY][ANY])
(DATA_TYPE* INPLACE_ARRAY4, DIM_TYPE DIM1, DIM_TYPE DIM2, DIM_TYPE DIM3, DIM_TYPE DIM4)
(DIM_TYPE DIM1, DIM_TYPE DIM2, DIM_TYPE DIM3, , DIM_TYPE DIM4, DATA_TYPE* INPLACE_ARRAY4)
(DATA_TYPE* INPLACE_FARRAY4, DIM_TYPE DIM1, DIM_TYPE DIM2, DIM_TYPE DIM3, DIM_TYPE DIM4)
(DIM_TYPE DIM1, DIM_TYPE DIM2, DIM_TYPE DIM3, DIM_TYPE DIM4, DATA_TYPE* INPLACE_FARRAY4)

这些类型映射现在会检查以确保 INPLACE_ARRAY 参数使用原生字节顺序。如果不是，则会引发异常。

还有一种“扁平”就地数组，适用于您希望修改或处理每个元素的情况，无论维度数量如何。一个例子是“量化”函数，它就地量化数组的每个元素，无论是 1D、2D 还是其他。这种形式会检查连续性，但允许 C 或 Fortran 顺序。

ND

(DATA_TYPE* INPLACE_ARRAY_FLAT, DIM_TYPE DIM_FLAT)

Argout 数组#

Argout 数组是在 C 语言中作为输入参数出现，但实际上是输出数组的数组。当有多个输出变量且单个返回参数不足时，这种模式经常出现。在 Python 中，返回多个参数的传统方法是将它们打包成一个序列（元组、列表等）并返回该序列。这就是 argout 类型映射的作用。如果一个使用这些 argout 类型映射的包装函数有多个返回参数，它们将被打包成一个元组或列表，具体取决于 Python 版本。Python 用户无需传入这些数组，它们只会被返回。对于指定了维度的情况，Python 用户必须将该维度作为参数提供。argout 签名如下：

一维

( DATA_TYPE ARGOUT_ARRAY1[ANY] )
( DATA_TYPE* ARGOUT_ARRAY1, int DIM1 )
( int DIM1, DATA_TYPE* ARGOUT_ARRAY1 )

二维

( DATA_TYPE ARGOUT_ARRAY2[ANY][ANY] )

三维

( DATA_TYPE ARGOUT_ARRAY3[ANY][ANY][ANY] )

四维

( DATA_TYPE ARGOUT_ARRAY4[ANY][ANY][ANY][ANY] )

这些通常用于 C/C++ 中，您会在堆上分配数组，并调用函数来填充数组值的情况。在 Python 中，数组会为您分配，并作为新的数组对象返回。

请注意，我们支持一维的 DATA_TYPE* argout 类型映射，但不支持二维或三维的。这是因为 SWIG 类型映射语法的一个怪癖，无法避免。请注意，对于这些类型的一维类型映射，Python 函数将接受一个表示 DIM1 的单个参数。

Argout 视图数组#

Argout 视图数组适用于您的 C 代码提供其内部数据的视图，并且不需要用户分配任何内存的情况。这可能很危险。几乎无法保证 C 代码的内部数据在封装它的 NumPy 数组的整个生命周期内都存在。如果用户在销毁 NumPy 数组之前销毁了提供数据视图的对象，那么使用该数组可能会导致错误的内存引用或分段错误。尽管如此，在处理大型数据集时，有时您别无选择。

用于 argout 视图数组的 C 代码的特点是指针：指向维度和数据双重指针，以便这些值可以传递回给用户。因此，argout 视图类型映射签名为：

一维

( DATA_TYPE** ARGOUTVIEW_ARRAY1, DIM_TYPE* DIM1 )
( DIM_TYPE* DIM1, DATA_TYPE** ARGOUTVIEW_ARRAY1 )

二维

( DATA_TYPE** ARGOUTVIEW_ARRAY2, DIM_TYPE* DIM1, DIM_TYPE* DIM2 )
( DIM_TYPE* DIM1, DIM_TYPE* DIM2, DATA_TYPE** ARGOUTVIEW_ARRAY2 )
( DATA_TYPE** ARGOUTVIEW_FARRAY2, DIM_TYPE* DIM1, DIM_TYPE* DIM2 )
( DIM_TYPE* DIM1, DIM_TYPE* DIM2, DATA_TYPE** ARGOUTVIEW_FARRAY2 )

三维

( DATA_TYPE** ARGOUTVIEW_ARRAY3, DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3)
( DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DATA_TYPE** ARGOUTVIEW_ARRAY3)
( DATA_TYPE** ARGOUTVIEW_FARRAY3, DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3)
( DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DATA_TYPE** ARGOUTVIEW_FARRAY3)

四维

(DATA_TYPE** ARGOUTVIEW_ARRAY4, DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DIM_TYPE* DIM4)
(DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DIM_TYPE* DIM4, DATA_TYPE** ARGOUTVIEW_ARRAY4)
(DATA_TYPE** ARGOUTVIEW_FARRAY4, DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DIM_TYPE* DIM4)
(DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DIM_TYPE* DIM4, DATA_TYPE** ARGOUTVIEW_FARRAY4)

请注意，不支持带有硬编码维度的数组。它们不能遵循这些类型映射的双指针签名。

内存管理的 Argout 视图数组#

numpy.i 最近新增的类型映射允许 argout 数组拥有对已管理内存的视图。

一维

(DATA_TYPE** ARGOUTVIEWM_ARRAY1, DIM_TYPE* DIM1)
(DIM_TYPE* DIM1, DATA_TYPE** ARGOUTVIEWM_ARRAY1)

二维

(DATA_TYPE** ARGOUTVIEWM_ARRAY2, DIM_TYPE* DIM1, DIM_TYPE* DIM2)
(DIM_TYPE* DIM1, DIM_TYPE* DIM2, DATA_TYPE** ARGOUTVIEWM_ARRAY2)
(DATA_TYPE** ARGOUTVIEWM_FARRAY2, DIM_TYPE* DIM1, DIM_TYPE* DIM2)
(DIM_TYPE* DIM1, DIM_TYPE* DIM2, DATA_TYPE** ARGOUTVIEWM_FARRAY2)

三维

(DATA_TYPE** ARGOUTVIEWM_ARRAY3, DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3)
(DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DATA_TYPE** ARGOUTVIEWM_ARRAY3)
(DATA_TYPE** ARGOUTVIEWM_FARRAY3, DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3)
(DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DATA_TYPE** ARGOUTVIEWM_FARRAY3)

四维

(DATA_TYPE** ARGOUTVIEWM_ARRAY4, DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DIM_TYPE* DIM4)
(DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DIM_TYPE* DIM4, DATA_TYPE** ARGOUTVIEWM_ARRAY4)
(DATA_TYPE** ARGOUTVIEWM_FARRAY4, DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DIM_TYPE* DIM4)
(DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DIM_TYPE* DIM4, DATA_TYPE** ARGOUTVIEWM_FARRAY4)

输出数组#

numpy.i 接口文件不支持输出数组的类型映射，原因有几个。首先，C/C++ 的返回参数仅限于单个值。这阻碍了以通用方式获取维度信息。其次，不允许将具有硬编码长度的数组作为返回参数。换句话说，

double[3] newVector(double x, double y, double z);

不是合法的 C/C++ 语法。因此，我们无法提供以下形式的类型映射

%typemap(out) (TYPE[ANY]);

如果您遇到函数或方法返回数组指针的情况，最好的办法是编写自己的包装函数版本，对于类方法可以使用 %extend，对于函数则使用 %ignore 和 %rename。

其他常见类型：布尔值#

请注意，可用类型映射部分中列出的类型不支持 C++ 类型 bool。NumPy 布尔值是一个字节，而 C++ bool 是四个字节（至少在我的系统上）。因此

%numpy_typemaps(bool, NPY_BOOL, int)

将导致类型映射生成引用不正确数据长度的代码。您可以实现以下宏扩展

%numpy_typemaps(bool, NPY_UINT, int)

来修复数据长度问题，输入数组将正常工作，但就地数组可能会在类型检查时失败。

其他常见类型：复数#

复浮点类型的类型映射转换也不受自动支持。这是因为 Python 和 NumPy 是用 C 编写的，而 C 没有原生的复数类型。Python 和 NumPy 都实现了它们自己的（基本上等效的）复数变量 struct 定义

/* Python */
typedef struct {double real; double imag;} Py_complex;

/* NumPy */
typedef struct {float  real, imag;} npy_cfloat;
typedef struct {double real, imag;} npy_cdouble;

我们本可以实现

%numpy_typemaps(Py_complex , NPY_CDOUBLE, int)
%numpy_typemaps(npy_cfloat , NPY_CFLOAT , int)
%numpy_typemaps(npy_cdouble, NPY_CDOUBLE, int)

这将为类型为 Py_complex、npy_cfloat 和 npy_cdouble 的数组提供自动类型转换。然而，似乎不太可能有任何独立的（非 Python、非 NumPy）应用程序代码会使用 SWIG 来生成 Python 接口，并且也使用这些定义来表示复杂类型。更有可能的是，这些应用程序代码将定义自己的复杂类型，或者在 C++ 的情况下，使用 std::complex。假设这些数据结构与 Python 和 NumPy 的复杂类型兼容，那么像上面那样（用用户的复杂类型替换第一个参数）的 %numpy_typemap 扩展应该会起作用。

NumPy 数组标量和 SWIG#

SWIG 对数值类型有复杂的类型检查。例如，如果您的 C/C++ 例程期望整数作为输入，则 SWIG 生成的代码将检查 Python 整数和 Python 长整数，如果提供的 Python 整数太大而无法转换为 C 整数，则会引发溢出错误。随着 NumPy 标量数组引入到您的 Python 代码中，您可能会从 NumPy 数组中提取一个整数，并尝试将其传递给期望 int 的 SWIG 包装的 C/C++ 函数，但是 SWIG 类型检查将不会将 NumPy 数组标量识别为整数。（通常，这实际上是有效的——这取决于 NumPy 是否将您使用的整数类型识别为继承自您所用平台上的 Python 整数类型。有时，这意味着在 32 位机器上工作的代码在 64 位机器上会失败。）

如果您收到如下所示的 Python 错误

TypeError: in method 'MyClass_MyMethod', argument 2 of type 'int'

并且您传递的参数是从 NumPy 数组中提取的整数，那么您就遇到了这个问题。解决方案是修改 SWIG 类型转换系统，使其除了标准整数类型外，还接受 NumPy 数组标量。幸运的是，此功能已为您提供。只需复制文件

pyfragments.swg

到您项目的工作构建目录，此问题将得到解决。建议您无论如何都这样做，因为它只会增加您的 Python 接口的功能。

为什么有第二个文件？#

SWIG 类型检查和转换系统是 C 宏、SWIG 宏、SWIG 类型映射和 SWIG 片段的复杂组合。片段是一种根据需要有条件地将代码插入包装文件的方式，如果不需要则不插入。如果多个类型映射需要相同的片段，则该片段只会插入到您的包装器代码中一次。

有一个片段用于将 Python 整数转换为 C long。有一个不同的片段用于将 Python 整数转换为 C int，它调用在 long 片段中定义的例程。我们可以通过更改 long 片段的定义来实现我们想要的更改。SWIG 使用“先到先得”系统来确定片段的活动定义。也就是说，我们需要在 SWIG 内部完成 long 转换之前定义 long 转换的片段。SWIG 允许我们将片段定义放在文件 pyfragments.swg 中。如果我们将新的片段定义放在 numpy.i 中，它们将被忽略。

辅助函数#

numpy.i 文件包含几个用于内部构建类型映射的宏和例程。然而，这些函数可能在您的接口文件的其他地方有用。这些宏和例程以片段的形式实现，上一节已简要描述。如果您尝试使用以下一个或多个宏或函数，但编译器抱怨它无法识别该符号，那么您需要通过在您的 SWIG 接口文件中使用

%fragment("NumPy_Fragments");

来强制这些片段出现在您的代码中。

宏#

is_array(a): 如果 a 非 NULL 且可以转换为 PyArrayObject*，则评估为真。
array_type(a): 计算 a 的整数数据类型代码，假设 a 可以转换为 PyArrayObject*。
array_numdims(a): 计算 a 的整数维数，假设 a 可以转换为 PyArrayObject*。
array_dimensions(a): 计算一个类型为 npy_intp 且长度为 array_numdims(a) 的数组，给出 a 所有维度的长度，假设 a 可以转换为 PyArrayObject*。
array_size(a,i): 计算 a 的第 i 个维度的大小，假设 a 可以转换为 PyArrayObject*。
array_strides(a): 计算一个类型为 npy_intp 且长度为 array_numdims(a) 的数组，给出 a 所有维度的步长，假设 a 可以转换为 PyArrayObject*。步长是元素与其沿同一轴的直接相邻元素之间以字节为单位的距离。
array_stride(a,i): 计算 a 的第 i 个步长，假设 a 可以转换为 PyArrayObject*。
array_data(a): 计算一个类型为 void* 的指针，指向 a 的数据缓冲区，假设 a 可以转换为 PyArrayObject*。
array_descr(a): 返回 a 的 dtype 属性（PyArray_Descr*）的借用引用，假设 a 可以转换为 PyArrayObject*。
array_flags(a): 返回一个表示 a 标志的整数，假设 a 可以转换为 PyArrayObject*。
array_enableflags(a,f): 设置 a 中由 f 表示的标志，假设 a 可以转换为 PyArrayObject*。
array_is_contiguous(a): 如果 a 是一个连续数组，则评估为 true。等同于 (PyArray_ISCONTIGUOUS(a))。
array_is_native(a): 如果 a 的数据缓冲区使用本机字节序，则评估为 true。等同于 (PyArray_ISNOTSWAPPED(a))。
array_is_fortran(a): 如果 a 是 Fortran 顺序，则评估为 true。

例程#

pytype_string()

返回类型：const char*

参数

PyObject* py_obj，一个通用的 Python 对象。

返回一个描述 py_obj 类型的字符串。

typecode_string()

返回类型：const char*

参数

int typecode，一个 NumPy 整数类型代码。

返回一个字符串，描述与 NumPy typecode 对应的类型。

type_match()

返回类型：int

参数

int actual_type，NumPy 数组的 NumPy 类型代码。
int desired_type，所需的 NumPy 类型代码。

确保 actual_type 与 desired_type 兼容。例如，这允许字符类型和字节类型，或 int 类型和 long 类型匹配。这现在等同于 PyArray_EquivTypenums()。

obj_to_array_no_conversion()

返回类型：PyArrayObject*

参数

PyObject* input，一个通用的 Python 对象。
int typecode，所需的 NumPy 类型代码。

如果合法，将 input 转换为 PyArrayObject*，并确保其类型为 typecode。如果 input 无法转换，或者 typecode 不正确，则设置 Python 错误并返回 NULL。

obj_to_array_allow_conversion()

返回类型：PyArrayObject*

参数

PyObject* input，一个通用的 Python 对象。
int typecode，结果数组所需的 NumPy 类型代码。
int* is_new_object，如果未执行转换，则返回 0，否则返回 1。

将 input 转换为指定 typecode 的 NumPy 数组。成功时，返回一个具有正确类型的有效 PyArrayObject*。失败时，将设置 Python 错误字符串，例程返回 NULL。

make_contiguous()

返回类型：PyArrayObject*

参数

PyArrayObject* ary，一个 NumPy 数组。
int* is_new_object，如果未执行转换，则返回 0，否则返回 1。
int min_dims，允许的最小维度。
int max_dims，允许的最大维度。

检查 ary 是否连续。如果连续，则返回输入指针并将其标记为非新对象。如果不连续，则使用原始数据创建新的 PyArrayObject*，将其标记为新对象并返回指针。

make_fortran()

返回类型：PyArrayObject*

参数

PyArrayObject* ary，一个 NumPy 数组。
int* is_new_object，如果未执行转换，则返回 0，否则返回 1。

检查 ary 是否为 Fortran 连续。如果是，则返回输入指针并将其标记为非新对象。如果不是 Fortran 连续，则使用原始数据创建一个新的 PyArrayObject*，将其标记为新对象并返回指针。

obj_to_array_contiguous_allow_conversion()

返回类型：PyArrayObject*

参数

PyObject* input，一个通用的 Python 对象。
int typecode，结果数组所需的 NumPy 类型代码。
int* is_new_object，如果未执行转换，则返回 0，否则返回 1。

将 input 转换为指定类型的连续 PyArrayObject*。如果输入对象不是连续的 PyArrayObject*，则将创建一个新的，并设置新对象标志。

obj_to_array_fortran_allow_conversion()

返回类型：PyArrayObject*

参数

PyObject* input，一个通用的 Python 对象。
int typecode，结果数组所需的 NumPy 类型代码。
int* is_new_object，如果未执行转换，则返回 0，否则返回 1。

将 input 转换为指定类型的 Fortran 连续 PyArrayObject*。如果输入对象不是 Fortran 连续的 PyArrayObject*，则将创建一个新的，并设置新对象标志。

require_contiguous()

返回类型：int

参数

PyArrayObject* ary，一个 NumPy 数组。

测试 ary 是否连续。如果是，则返回 1。否则，设置 Python 错误并返回 0。

require_native()

返回类型：int

参数

PyArray_Object* ary，一个 NumPy 数组。

要求 ary 未进行字节交换。如果数组未进行字节交换，则返回 1。否则，设置 Python 错误并返回 0。

require_dimensions()

返回类型：int

参数

PyArrayObject* ary，一个 NumPy 数组。
int exact_dimensions，所需的维度数量。

要求 ary 具有指定维数。如果数组具有指定维数，则返回 1。否则，设置 Python 错误并返回 0。

require_dimensions_n()

返回类型：int

参数

PyArrayObject* ary，一个 NumPy 数组。
int* exact_dimensions，表示可接受维数整数的数组。
int n，exact_dimensions 的长度。

要求 ary 具有指定维数列表中的一个。如果数组具有指定维数中的一个，则返回 1。否则，设置 Python 错误字符串并返回 0。

require_size()

返回类型：int

参数

PyArrayObject* ary，一个 NumPy 数组。
npy_int* size，表示每个维度的所需长度的数组。
int n，size 的长度。

要求 ary 具有指定的形状。如果数组具有指定的形状，则返回 1。否则，设置 Python 错误字符串并返回 0。

require_fortran()

返回类型：int

参数

PyArrayObject* ary，一个 NumPy 数组。

要求给定的 PyArrayObject 是 Fortran 序的。如果 PyArrayObject 已经是 Fortran 序的，则不执行任何操作。否则，设置 Fortran 序标志并重新计算步长。

超出提供的类型映射#

有许多 C 或 C++ 数组/NumPy 数组情况不是通过简单的 %include "numpy.i" 和随后的 %apply 指令所涵盖的。

一个常见的例子#

考虑一个点积函数的合理原型

double dot(int len, double* vec1, double* vec2);

我们想要的 Python 接口是

def dot(vec1, vec2):
    """
    dot(PyObject,PyObject) -> double
    """

这里的问题是有一个维度参数和两个数组参数，而我们的类型映射是为应用于单个数组的维度设置的（事实上，SWIG 没有提供一种机制来将 len 与 vec2 关联起来，该机制接受两个 Python 输入参数）。推荐的解决方案如下：

%apply (int DIM1, double* IN_ARRAY1) {(int len1, double* vec1),
                                      (int len2, double* vec2)}
%rename (dot) my_dot;
%exception my_dot {
    $action
    if (PyErr_Occurred()) SWIG_fail;
}
%inline %{
double my_dot(int len1, double* vec1, int len2, double* vec2) {
    if (len1 != len2) {
        PyErr_Format(PyExc_ValueError,
                     "Arrays of lengths (%d,%d) given",
                     len1, len2);
        return 0.0;
    }
    return dot(len1, vec1, vec2);
}
%}

如果包含 double dot() 原型的头文件也包含您希望包装的其他原型，从而您需要 %include 此头文件，那么您还需要一个 %ignore dot; 指令，该指令应放置在 %rename 之后和 %include 指令之前。或者，如果相关函数是类方法，除了 %ignore 之外，您还需要使用 %extend 而不是 %inline。

错误处理注意事项：请注意 my_dot 返回一个 double，但它也可以引发 Python 错误。当向量长度不匹配时，生成的包装函数将返回 0.0 的 Python 浮点表示。由于这不是 NULL，Python 解释器将不知道检查错误。因此，我们为 my_dot 添加了上述 %exception 指令以获得我们想要的行为（请注意，$action 是一个宏，它被扩展为对 my_dot 的有效调用）。通常，您可能需要编写一个 SWIG 宏来执行此任务。

其他情况#

还有其他包装情况，当您遇到它们时，numpy.i 可能会有所帮助。

在某些情况下，您可以使用 %numpy_typemaps 宏为您自己的类型实现类型映射。有关示例，请参阅其他常见类型：bool 或其他常见类型：complex 部分。另一种情况是如果您的维度类型不是 int（例如 long）
```
%numpy_typemaps(double, NPY_DOUBLE, long)
```
您可以使用 numpy.i 中的代码编写您自己的类型映射。例如，如果您的函数参数是一个五维数组，您可以将相应的四维类型映射剪切并粘贴到您的接口文件中。对第四维的修改将是微不足道的。
有时，最好的方法是使用 %extend 指令为您的类定义新方法（或重载现有方法），这些方法接受 PyObject*（它本身是或可以转换为 PyArrayObject*），而不是指向缓冲区的指针。在这种情况下，numpy.i 中的辅助例程会非常有用。
编写类型映射可能有点不直观。如果您对为 NumPy 编写 SWIG 类型映射有具体问题，numpy.i 的开发者会关注 Numpy-discussion 和 Swig-user 邮件列表。

最后一点#

当您使用 %apply 指令时（通常使用 numpy.i 是必需的），它将一直有效，直到您告诉 SWIG 不再有效。如果您正在包装的函数或方法的参数具有诸如 length 或 vector 等常见名称，这些类型映射可能会在您意想不到或不希望的情况下应用。因此，在使用完特定类型映射后添加 %clear 指令始终是一个好主意

%apply (double* IN_ARRAY1, int DIM1) {(double* vector, int length)}
%include "my_header.h"
%clear (double* vector, int length);

一般来说，您应该将这些类型映射签名精确地应用于您需要它们的地方，然后在使用完毕后清除它们。

总结#

numpy.i 开箱即用地提供了支持 NumPy 数组与 C 数组之间转换的类型映射。

它可以是 12 种不同标量类型之一：signed char, unsigned char, short, unsigned short, int, unsigned int, long, unsigned long, long long, unsigned long long, float 和 double。
每种数据类型支持 74 种不同的参数签名，包括
- 一维、二维、三维和四维数组。
- 只输入、就地、argout、argoutview 和内存管理 argoutview 行为。
- 硬编码维度、数据缓冲区-然后-维度规范以及维度-然后-数据缓冲区规范。
- 支持 2D、3D 和 4D 数组的 C 顺序（“最后一维最快”）或 Fortran 顺序（“第一维最快”）。

numpy.i 接口文件还为包装器开发人员提供了额外的工具，包括

一个带有三个参数的 SWIG 宏 (%numpy_typemaps)，用于实现 74 种参数签名，用户可选择 (1) C 数据类型、(2) NumPy 数据类型（假设它们匹配）和 (3) 维度类型。
十四个 C 宏和十五个 C 函数，可用于编写专用类型映射、扩展或内联函数，以处理所提供类型映射未涵盖的情况。请注意，这些宏和函数专门用于与 NumPy C/API 配合使用，无论 NumPy 版本号如何，包括版本 1.6 后某些 API 方面的弃用之前和之后。