summaryrefslogtreecommitdiff
path: root/numpy/doc/swig
diff options
context:
space:
mode:
authorwfspotz@sandia.gov <wfspotz@sandia.gov@localhost>2007-08-15 20:48:11 +0000
committerwfspotz@sandia.gov <wfspotz@sandia.gov@localhost>2007-08-15 20:48:11 +0000
commit14dd6a9c6ac5a393bfcda7c6a77e615ce70b5873 (patch)
tree96a01d9abfbc380085f3a89a5da918183acae6d3 /numpy/doc/swig
parent9fc1daf9ac0fe6f7f8c1ab593b3d75c85e438e75 (diff)
downloadnumpy-14dd6a9c6ac5a393bfcda7c6a77e615ce70b5873.tar.gz
Improved formatting of typemap signature lists
Diffstat (limited to 'numpy/doc/swig')
-rw-r--r--numpy/doc/swig/numpy_swig.html58
-rw-r--r--numpy/doc/swig/numpy_swig.pdfbin148245 -> 148244 bytes
-rw-r--r--numpy/doc/swig/numpy_swig.txt56
-rw-r--r--numpy/doc/swig/testing.pdfbin72391 -> 72877 bytes
4 files changed, 57 insertions, 57 deletions
diff --git a/numpy/doc/swig/numpy_swig.html b/numpy/doc/swig/numpy_swig.html
index 6b2a750ef..b051363be 100644
--- a/numpy/doc/swig/numpy_swig.html
+++ b/numpy/doc/swig/numpy_swig.html
@@ -5,7 +5,7 @@
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>numpy.i: a SWIG Interface File for NumPy</title>
<meta name="author" content="Bill Spotz" />
-<meta name="date" content="13 April, 2007" />
+<meta name="date" content="15 August, 2007" />
<style type="text/css">
/*
@@ -302,7 +302,7 @@ ul.auto-toc {
<tr class="field"><th class="docinfo-name">Institution:</th><td class="field-body">Sandia National Laboratories</td>
</tr>
<tr><th class="docinfo-name">Date:</th>
-<td>13 April, 2007</td></tr>
+<td>15 August, 2007</td></tr>
</tbody>
</table>
<div class="contents topic">
@@ -562,21 +562,21 @@ sequence (such as a list) that can be converted to the requested type
of array. The input array signatures are</p>
<blockquote>
<ul class="simple">
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE</span> <span class="pre">IN_ARRAY1[ANY])</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE*</span> <span class="pre">IN_ARRAY1,</span> <span class="pre">int</span> <span class="pre">DIM1)</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(int</span> <span class="pre">DIM1,</span> <span class="pre">DATA_TYPE*</span> <span class="pre">IN_ARRAY1)</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE</span> <span class="pre">IN_ARRAY2[ANY][ANY])</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE*</span> <span class="pre">IN_ARRAY2,</span> <span class="pre">int</span> <span class="pre">DIM1,</span> <span class="pre">int</span> <span class="pre">DIM2)</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(int</span> <span class="pre">DIM1,</span> <span class="pre">int</span> <span class="pre">DIM2,</span> <span class="pre">DATA_TYPE*</span> <span class="pre">IN_ARRAY2)</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE</span> <span class="pre">IN_ARRAY3[ANY][ANY][ANY])</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE*</span> <span class="pre">IN_ARRAY3,</span> <span class="pre">int</span> <span class="pre">DIM1,</span> <span class="pre">int</span> <span class="pre">DIM2,</span> <span class="pre">int</span> <span class="pre">DIM3)</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(int</span> <span class="pre">DIM1,</span> <span class="pre">int</span> <span class="pre">DIM2,</span> <span class="pre">int</span> <span class="pre">DIM3,</span> <span class="pre">DATA_TYPE*</span> <span class="pre">IN_ARRAY3)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE</span> <span class="pre">IN_ARRAY1[ANY]</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE*</span> <span class="pre">IN_ARRAY1,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM1</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">int</span> <span class="pre">DIM1,</span>&nbsp; <span class="pre">DATA_TYPE*</span> <span class="pre">IN_ARRAY1</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE</span> <span class="pre">IN_ARRAY2[ANY][ANY]</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE*</span> <span class="pre">IN_ARRAY2,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM1,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM2</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">int</span> <span class="pre">DIM1,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM2,</span>&nbsp; <span class="pre">DATA_TYPE*</span> <span class="pre">IN_ARRAY2</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE</span> <span class="pre">IN_ARRAY3[ANY][ANY][ANY]</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE*</span> <span class="pre">IN_ARRAY3,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM1,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM2,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM3</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">int</span> <span class="pre">DIM1,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM2,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM3,</span>&nbsp; <span class="pre">DATA_TYPE*</span> <span class="pre">IN_ARRAY3</span> <span class="pre">)</span></tt></li>
</ul>
</blockquote>
-<p>The first signature listed, <tt class="docutils literal"><span class="pre">(DATA_TYPE</span> <span class="pre">IN_ARRAY[ANY])</span></tt> is for
+<p>The first signature listed, <tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE</span> <span class="pre">IN_ARRAY[ANY]</span> <span class="pre">)</span></tt> is for
one-dimensional arrays with hard-coded dimensions. Likewise,
-<tt class="docutils literal"><span class="pre">(DATA_TYPE</span> <span class="pre">IN_ARRAY2[ANY][ANY])</span></tt> is for two-dimensional arrays with
-hard-coded dimensions, and similarly for three-dimensional.</p>
+<tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE</span> <span class="pre">IN_ARRAY2[ANY][ANY]</span> <span class="pre">)</span></tt> is for two-dimensional arrays
+with hard-coded dimensions, and similarly for three-dimensional.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id5" id="in-place-arrays" name="in-place-arrays">In-Place Arrays</a></h2>
@@ -587,15 +587,15 @@ must therefore be a <a class="reference" href="http://numpy.scipy.org">NumPy</a>
signatures are</p>
<blockquote>
<ul class="simple">
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE</span> <span class="pre">INPLACE_ARRAY1[ANY])</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE*</span> <span class="pre">INPLACE_ARRAY1,</span> <span class="pre">int</span> <span class="pre">DIM1)</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(int</span> <span class="pre">DIM1,</span> <span class="pre">DATA_TYPE*</span> <span class="pre">INPLACE_ARRAY1)</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE</span> <span class="pre">INPLACE_ARRAY2[ANY][ANY])</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE*</span> <span class="pre">INPLACE_ARRAY2,</span> <span class="pre">int</span> <span class="pre">DIM1,</span> <span class="pre">int</span> <span class="pre">DIM2)</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(int</span> <span class="pre">DIM1,</span> <span class="pre">int</span> <span class="pre">DIM2,</span> <span class="pre">DATA_TYPE*</span> <span class="pre">INPLACE_ARRAY2)</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE</span> <span class="pre">INPLACE_ARRAY3[ANY][ANY][ANY])</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE*</span> <span class="pre">INPLACE_ARRAY3,</span> <span class="pre">int</span> <span class="pre">DIM1,</span> <span class="pre">int</span> <span class="pre">DIM2,</span> <span class="pre">int</span> <span class="pre">DIM3)</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(int</span> <span class="pre">DIM1,</span> <span class="pre">int</span> <span class="pre">DIM2,</span> <span class="pre">int</span> <span class="pre">DIM3,</span> <span class="pre">DATA_TYPE*</span> <span class="pre">INPLACE_ARRAY3)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE</span> <span class="pre">INPLACE_ARRAY1[ANY]</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE*</span> <span class="pre">INPLACE_ARRAY1,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM1</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">int</span> <span class="pre">DIM1,</span>&nbsp; <span class="pre">DATA_TYPE*</span> <span class="pre">INPLACE_ARRAY1</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE</span> <span class="pre">INPLACE_ARRAY2[ANY][ANY]</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE*</span> <span class="pre">INPLACE_ARRAY2,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM1,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM2</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">int</span> <span class="pre">DIM1,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM2,</span>&nbsp; <span class="pre">DATA_TYPE*</span> <span class="pre">INPLACE_ARRAY2</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE</span> <span class="pre">INPLACE_ARRAY3[ANY][ANY][ANY]</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE*</span> <span class="pre">INPLACE_ARRAY3,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM1,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM2,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM3</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">int</span> <span class="pre">DIM1,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM2,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM3,</span>&nbsp; <span class="pre">DATA_TYPE*</span> <span class="pre">INPLACE_ARRAY3</span> <span class="pre">)</span></tt></li>
</ul>
</blockquote>
<p>These typemaps now check to make sure that the <tt class="docutils literal"><span class="pre">INPLACE_ARRAY</span></tt>
@@ -615,11 +615,11 @@ the version of <a class="reference" href="http://www.python.org">python</a>. Th
arrays in, they simply get returned. The argout signatures are</p>
<blockquote>
<ul class="simple">
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE</span> <span class="pre">ARGOUT_ARRAY1[ANY])</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE*</span> <span class="pre">ARGOUT_ARRAY1,</span> <span class="pre">int</span> <span class="pre">DIM1)</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(int</span> <span class="pre">DIM1,</span> <span class="pre">DATA_TYPE*</span> <span class="pre">ARGOUT_ARRAY1)</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE</span> <span class="pre">ARGOUT_ARRAY2[ANY][ANY])</span></tt></li>
-<li><tt class="docutils literal"><span class="pre">(DATA_TYPE</span> <span class="pre">ARGOUT_ARRAY3[ANY][ANY][ANY])</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE</span> <span class="pre">ARGOUT_ARRAY1[ANY]</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE*</span> <span class="pre">ARGOUT_ARRAY1,</span>&nbsp; <span class="pre">int</span> <span class="pre">DIM1</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">int</span> <span class="pre">DIM1,</span>&nbsp; <span class="pre">DATA_TYPE*</span> <span class="pre">ARGOUT_ARRAY1</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE</span> <span class="pre">ARGOUT_ARRAY2[ANY][ANY]</span> <span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span> <span class="pre">DATA_TYPE</span> <span class="pre">ARGOUT_ARRAY3[ANY][ANY][ANY]</span> <span class="pre">)</span></tt></li>
</ul>
</blockquote>
<p>These are typically used in situations where in C/C++, you would
@@ -1049,7 +1049,7 @@ possible.</p>
</div>
<div class="footer">
<hr class="footer" />
-Generated on: 2007-08-03 21:19 UTC.
+Generated on: 2007-08-15 20:42 UTC.
Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
</div>
diff --git a/numpy/doc/swig/numpy_swig.pdf b/numpy/doc/swig/numpy_swig.pdf
index 3e755b0ff..3c31a5301 100644
--- a/numpy/doc/swig/numpy_swig.pdf
+++ b/numpy/doc/swig/numpy_swig.pdf
Binary files differ
diff --git a/numpy/doc/swig/numpy_swig.txt b/numpy/doc/swig/numpy_swig.txt
index c8450045d..28a83943c 100644
--- a/numpy/doc/swig/numpy_swig.txt
+++ b/numpy/doc/swig/numpy_swig.txt
@@ -4,7 +4,7 @@ numpy.i: a SWIG Interface File for NumPy
:Author: Bill Spotz
:Institution: Sandia National Laboratories
-:Date: 13 April, 2007
+:Date: 15 August, 2007
.. contents::
@@ -247,20 +247,20 @@ routine but are not altered in-place or returned to the user. The
sequence (such as a list) that can be converted to the requested type
of array. The input array signatures are
- * ``(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_ARRAY3[ANY][ANY][ANY])``
- * ``(DATA_TYPE* IN_ARRAY3, int DIM1, int DIM2, int DIM3)``
- * ``(int DIM1, int DIM2, int DIM3, DATA_TYPE* IN_ARRAY3)``
-
-The first signature listed, ``(DATA_TYPE IN_ARRAY[ANY])`` is for
+ * ``( 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_ARRAY3[ANY][ANY][ANY] )``
+ * ``( DATA_TYPE* IN_ARRAY3, int DIM1, int DIM2, int DIM3 )``
+ * ``( int DIM1, int DIM2, int DIM3, DATA_TYPE* IN_ARRAY3 )``
+
+The first signature listed, ``( DATA_TYPE IN_ARRAY[ANY] )`` is for
one-dimensional arrays with hard-coded dimensions. Likewise,
-``(DATA_TYPE IN_ARRAY2[ANY][ANY])`` is for two-dimensional arrays with
-hard-coded dimensions, and similarly for three-dimensional.
+``( DATA_TYPE IN_ARRAY2[ANY][ANY] )`` is for two-dimensional arrays
+with hard-coded dimensions, and similarly for three-dimensional.
In-Place Arrays
---------------
@@ -271,15 +271,15 @@ function returns are significant. The provided `python`_ argument
must therefore be a `NumPy`_ array of the required type. The in-place
signatures are
- * ``(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_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_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_ARRAY3[ANY][ANY][ANY] )``
+ * ``( DATA_TYPE* INPLACE_ARRAY3, int DIM1, int DIM2, int DIM3 )``
+ * ``( int DIM1, int DIM2, int DIM3, DATA_TYPE* INPLACE_ARRAY3 )``
These typemaps now check to make sure that the ``INPLACE_ARRAY``
arguments use native byte ordering. If not, an exception is raised.
@@ -298,11 +298,11 @@ return argument, they are packed into a tuple or list, depending on
the version of `python`_. The `python`_ user does not pass these
arrays in, they simply get returned. The argout signatures are
- * ``(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_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] )``
These are typically used in situations where in C/C++, you would
allocate a(n) array(s) on the heap, and call the function to fill the
diff --git a/numpy/doc/swig/testing.pdf b/numpy/doc/swig/testing.pdf
index 57af9b6fd..ad0342da2 100644
--- a/numpy/doc/swig/testing.pdf
+++ b/numpy/doc/swig/testing.pdf
Binary files differ