summaryrefslogtreecommitdiff
path: root/doc/source/reference/swig.interface-file.rst
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2015-05-26 13:23:19 -0600
committerCharles Harris <charlesr.harris@gmail.com>2015-05-26 13:23:19 -0600
commit0794d8f072ae8fc74550a661d646dc122fd47576 (patch)
tree123aeb1d7c6d61a6cc7934a5fb24540a077b4fea /doc/source/reference/swig.interface-file.rst
parentd1acfd9c232046579029861e5207eb80a1b1f747 (diff)
parenta49ad1523c87766134aa98e04772d988040516fb (diff)
downloadnumpy-0794d8f072ae8fc74550a661d646dc122fd47576.tar.gz
Merge pull request #5914 from sirtom67/master
New typemap for in-place arrays of arbitrary number of dimensions:
Diffstat (limited to 'doc/source/reference/swig.interface-file.rst')
-rw-r--r--doc/source/reference/swig.interface-file.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/source/reference/swig.interface-file.rst b/doc/source/reference/swig.interface-file.rst
index c381feb85..e5d369d0e 100644
--- a/doc/source/reference/swig.interface-file.rst
+++ b/doc/source/reference/swig.interface-file.rst
@@ -320,6 +320,17 @@ signatures are
These typemaps now check to make sure that the ``INPLACE_ARRAY``
arguments use native byte ordering. If not, an exception is raised.
+There is also a "flat" in-place array for situations in which
+you would like to modify or process each element, regardless of the
+number of dimensions. One example is a "quantization" function that
+quantizes each element of an array in-place, be it 1D, 2D or whatever.
+This form checks for continuity but allows either C or Fortran ordering.
+
+ND:
+
+ * ``(DATA_TYPE* INPLACE_ARRAY_FLAT, DIM_TYPE DIM_FLAT)``
+
+
Argout Arrays
`````````````