numpy.nditer#

class numpy.nditer(op, flags=None, op_flags=None, op_dtypes=None, order='K', casting='safe', op_axes=None, itershape=None, buffersize=0)[source]#

高效的多维迭代器对象，用于遍历数组。要开始使用此对象，请参阅数组迭代入门指南。

参数:
opndarray 或类数组序列

要迭代的数组。

flagsstr 序列，可选

控制迭代器行为的标志。

  • buffered 在需要时启用缓冲。

  • c_index 导致跟踪 C-order 索引。

  • f_index 导致跟踪 Fortran-order 索引。

  • multi_index 导致跟踪多索引，即每个迭代维度一个索引的元组。

  • common_dtype 导致所有操作数转换为通用数据类型，必要时进行复制或缓冲。

  • copy_if_overlap 导致迭代器判断读取操作数是否与写入操作数重叠，并根据需要制作临时副本以避免重叠。在某些情况下可能会出现假阳性（不必要的复制）。

  • delay_bufalloc 将缓冲区的分配延迟到调用 reset() 时。允许 allocate 操作数在将其值复制到缓冲区之前进行初始化。

  • external_loop 导致给定的 values 是具有多个值的一维数组，而不是零维数组。

  • grow_inner 允许在同时使用 buffered 和 external_loop 时，将 value 数组的大小设置为大于缓冲区大小。

  • ranged 允许迭代器限制在 iterindex 值的子范围。

  • refs_ok 启用引用类型的迭代，例如对象数组。

  • reduce_ok 启用对广播的 readwrite 操作数（也称为归约操作数）的迭代。

  • zerosize_ok 允许 itersize 为零。

op_flagsstr 列表的列表，可选

这是每个操作数的标志列表。至少必须指定 readonly、readwrite 或 writeonly 之一。

  • readonly 表示操作数只能读取。

  • readwrite 表示操作数将进行读写操作。

  • writeonly 表示操作数只能写入。

  • no_broadcast 防止操作数进行广播。

  • contig 强制操作数数据是连续的。

  • aligned 强制操作数数据对齐。

  • nbo 强制操作数数据采用本机字节顺序。

  • copy 允许在需要时创建临时只读副本。

  • updateifcopy 允许在需要时创建临时读写副本。

  • allocate 导致在 op 参数中为 None 时分配数组。

  • no_subtype 防止 allocate 操作数使用子类型。

  • arraymask 表示此操作数是在写入带有“writemasked”标志的操作数时用于选择元素的掩码。迭代器不强制执行此操作，但在将缓冲区数据写回数组时，它只复制此掩码指示的元素。

  • writemasked 表示只有当所选 arraymask 操作数为 True 时，才会被写入元素。

  • overlap_assume_elementwise 可用于标记仅按迭代器顺序访问的操作数，以在存在 copy_if_overlap 时允许不那么保守的复制。

op_dtypesdtype 或 dtype(s) 元组，可选

操作数所需的数据类型。如果启用复制或缓冲，数据将从其原始类型进行转换。

order{'C', 'F', 'A', 'K'}，可选

控制迭代顺序。'C' 表示 C 顺序，'F' 表示 Fortran 顺序，'A' 表示如果所有数组都是 Fortran 连续的，则为 'F' 顺序，否则为 'C' 顺序，'K' 表示尽可能接近数组元素在内存中出现的顺序。这还会影响 allocate 操作数的元素内存顺序，因为它们被分配为与迭代顺序兼容。默认为 'K'。

casting{'no', 'equiv', 'safe', 'same_kind', 'unsafe'}，可选

控制在进行复制或缓冲时可能发生的数据类型转换。不建议将其设置为 'unsafe'，因为它可能对累加产生不利影响。

  • ‘no’ 表示数据类型不应进行任何转换。

  • ‘equiv’ 表示只允许字节序更改。

  • ‘safe’ 表示只允许保留值的转换。

  • ‘same_kind’ 表示只允许安全转换或同类转换，例如 float64 到 float32。

  • ‘unsafe’ 表示可以进行任何数据转换。

op_axesint 列表的列表，可选

如果提供，则是每个操作数的 int 列表或 None。操作数的轴列表是从迭代器维度到操作数维度的映射。条目可以放置 -1，导致该维度被视为新轴（newaxis）。

itershapeint 元组，可选

迭代器的期望形状。这允许 allocate 操作数，其由 op_axes 映射的维度不对应于不同操作数的维度，在该维度上获得不等于 1 的值。

buffersizeint，可选

启用缓冲时，控制临时缓冲区的大小。设置为 0 为默认值。

备注

nditer 取代了 flatiter。nditer 背后的迭代器实现也由 NumPy C API 暴露。

Python 接口提供了两种迭代接口，一种遵循 Python 迭代器协议，另一种模仿 C 风格的 do-while 模式。在大多数情况下，原生 Python 方法更好，但如果您需要迭代器的坐标或索引，请使用 C 风格模式。

示例

下面是如何使用 Python 迭代器协议编写 iter_add 函数的示例

>>> import numpy as np

>>> def iter_add_py(x, y, out=None):
...     addop = np.add
...     it = np.nditer([x, y, out], [],
...                 [['readonly'], ['readonly'], ['writeonly','allocate']])
...     with it:
...         for (a, b, c) in it:
...             addop(a, b, out=c)
...         return it.operands[2]

这是相同的函数，但遵循 C 风格模式

>>> def iter_add(x, y, out=None):
...    addop = np.add
...    it = np.nditer([x, y, out], [],
...                [['readonly'], ['readonly'], ['writeonly','allocate']])
...    with it:
...        while not it.finished:
...            addop(it[0], it[1], out=it[2])
...            it.iternext()
...        return it.operands[2]

这是一个外积函数的示例

>>> def outer_it(x, y, out=None):
...     mulop = np.multiply
...     it = np.nditer([x, y, out], ['external_loop'],
...             [['readonly'], ['readonly'], ['writeonly', 'allocate']],
...             op_axes=[list(range(x.ndim)) + [-1] * y.ndim,
...                      [-1] * x.ndim + list(range(y.ndim)),
...                      None])
...     with it:
...         for (a, b, c) in it:
...             mulop(a, b, out=c)
...         return it.operands[2]

>>> a = np.arange(2)+1
>>> b = np.arange(3)+1
>>> outer_it(a,b)
array([[1, 2, 3],
       [2, 4, 6]])

这是一个像“lambda”ufunc 一样操作的函数示例

>>> def luf(lamdaexpr, *args, **kwargs):
...    '''luf(lambdaexpr, op1, ..., opn, out=None, order='K', casting='safe', buffersize=0)'''
...    nargs = len(args)
...    op = (kwargs.get('out',None),) + args
...    it = np.nditer(op, ['buffered','external_loop'],
...            [['writeonly','allocate','no_broadcast']] +
...                            [['readonly','nbo','aligned']]*nargs,
...            order=kwargs.get('order','K'),
...            casting=kwargs.get('casting','safe'),
...            buffersize=kwargs.get('buffersize',0))
...    while not it.finished:
...        it[0] = lamdaexpr(*it[1:])
...        it.iternext()
...    return it.operands[0]

>>> a = np.arange(5)
>>> b = np.ones(5)
>>> luf(lambda i,j:i*i + j/2, a, b)
array([  0.5,   1.5,   4.5,   9.5,  16.5])

如果使用操作数标志 "writeonly" 或 "readwrite"，操作数可能是原始数据的视图，带有 WRITEBACKIFCOPY 标志。在这种情况下，nditer 必须用作上下文管理器，或者在使用结果之前必须调用 nditer.close 方法。临时数据将在 __exit__ 函数被调用时写回原始数据，而不是之前

>>> a = np.arange(6, dtype='i4')[::-2]
>>> with np.nditer(a, [],
...        [['writeonly', 'updateifcopy']],
...        casting='unsafe',
...        op_dtypes=[np.dtype('f4')]) as i:
...    x = i.operands[0]
...    x[:] = [-1, -2, -3]
...    # a still unchanged here
>>> a, x
(array([-1, -2, -3], dtype=int32), array([-1., -2., -3.], dtype=float32))

需要注意的是，一旦迭代器退出，悬空引用（例如示例中的 x）可能与原始数据 a 共享数据，也可能不共享。如果回写语义处于活动状态，即如果 x.base.flags.writebackifcopy 为 True，则退出迭代器将切断 x 和 a 之间的连接，写入 x 将不再写入 a。如果回写语义不活动，则 x.data 仍将指向 a.data 的一部分，写入其中一个将影响另一个。

上下文管理和 close 方法出现在版本 1.15.0 中。

属性:
dtypesdtype(s) 元组

value 中提供的值的数据类型。如果启用了缓冲，这可能与操作数数据类型不同。仅在迭代器关闭之前有效。

finished布尔值

操作数上的迭代是否已完成。

has_delayed_bufalloc布尔值

如果为 True，则迭代器是使用 delay_bufalloc 标志创建的，并且尚未对其调用 reset() 函数。

has_index布尔值

如果为 True，则迭代器是使用 c_index 或 f_index 标志创建的，并且可以使用属性 index 来检索它。

has_multi_index布尔值

如果为 True，则迭代器是使用 multi_index 标志创建的，并且可以使用属性 multi_index 来检索它。

index

当使用 c_index 或 f_index 标志时，此属性提供对索引的访问。如果访问且 has_index 为 False，则引发 ValueError。

iterationneedsapi布尔值

迭代是否需要访问 Python API，例如，如果其中一个操作数是对象数组。

iterindexint

与迭代顺序匹配的索引。

itersizeint

迭代器的大小。

itviews

内存中 operands 的结构化视图，匹配重新排序和优化的迭代器访问模式。仅在迭代器关闭之前有效。

multi_index

当使用 multi_index 标志时，此属性提供对索引的访问。如果访问且 has_multi_index 为 False，则引发 ValueError。

ndimint

迭代器的维度。

nopint

迭代器操作数的数量。

operands操作数(s) 元组

operands[切片]

shapeint 元组

形状元组，即迭代器的形状。

value

当前迭代中 operands 的值。通常，这是一个数组标量的元组，但如果使用了 external_loop 标志，则它是一个一维数组的元组。

方法

close()

解决可写操作数中的所有回写语义。

copy()

获取迭代器当前状态的副本。

debug_print()

将 nditer 实例的当前状态和调试信息打印到标准输出。

enable_external_loop()

当构造时未使用“external_loop”但需要它时，此方法会修改迭代器，使其表现得如同指定了该标志一样。

iternext()

检查是否还有剩余迭代，并执行一次内部迭代而不返回结果。

remove_axis(i, /)

从迭代器中移除轴 i。

remove_multi_index()

当指定了“multi_index”标志时，此方法会将其移除，从而允许内部迭代结构得到进一步优化。

reset()

将迭代器重置为初始状态。
在本页