summaryrefslogtreecommitdiff
path: root/numpy/doc/swig/numpy_swig.html
diff options
context:
space:
mode:
authorwfspotz@sandia.gov <wfspotz@sandia.gov@localhost>2007-03-23 17:36:16 +0000
committerwfspotz@sandia.gov <wfspotz@sandia.gov@localhost>2007-03-23 17:36:16 +0000
commit32a2519c0b028ada876a3fe33ca598c18e65d05c (patch)
tree68684b7bad8d20df51e6aaaa44e3bfbdf4b67164 /numpy/doc/swig/numpy_swig.html
parent25526d1a26f4b7ac245ecedd16c82cfd7d67f741 (diff)
downloadnumpy-32a2519c0b028ada876a3fe33ca598c18e65d05c.tar.gz
Added '#ifdef SWIGPYTHON' protection
Diffstat (limited to 'numpy/doc/swig/numpy_swig.html')
-rw-r--r--numpy/doc/swig/numpy_swig.html23
1 files changed, 6 insertions, 17 deletions
diff --git a/numpy/doc/swig/numpy_swig.html b/numpy/doc/swig/numpy_swig.html
index 5a8b0fe74..b8d6f9d9c 100644
--- a/numpy/doc/swig/numpy_swig.html
+++ b/numpy/doc/swig/numpy_swig.html
@@ -614,7 +614,8 @@ can be cast to a <tt class="docutils literal"><span class="pre">PyArrayObject*</
<dd>Given a <a class="reference" href="http://numpy.scipy.org">NumPy</a> integer typecode, return a string describing the type.</dd>
<dt><strong>int type_match(int actual_type, int desired_type)</strong></dt>
<dd>Make sure input has correct <a class="reference" href="http://numpy.scipy.org">NumPy</a> type. Allow character and
-byte to match. Also allow int and long to match.</dd>
+byte to match. Also allow int and long to match. This is
+deprecated . You should use <tt class="docutils literal"><span class="pre">PyArray_EquivTypenums()</span></tt> instead.</dd>
<dt><strong>PyArrayObject* obj_to_array_no_conversion(PyObject* input, int typecode)</strong></dt>
<dd>Given a <tt class="docutils literal"><span class="pre">PyObject*</span></tt>, cast it to a <tt class="docutils literal"><span class="pre">PyArrayObject*</span></tt> if legal.
If not, set the python error string appropriately and return
@@ -651,19 +652,6 @@ python error string and return 0.</dd>
<dd>Require the given <tt class="docutils literal"><span class="pre">PyArrayObject*</span></tt> to have a specified shape.
If the array has the specified shape, return 1. Otherwise, set
the python error string and return 0.</dd>
-<dt><strong>static PyArrayObject *contiguous_typed_array(PyObject *obj, int typecode, int expectnd, int *expectdims)</strong></dt>
-<dd>This function tries to create a contiguous <a class="reference" href="http://numpy.scipy.org">NumPy</a> array of type
-typecode from an arbitrary python object <tt class="docutils literal"><span class="pre">obj</span></tt>. This should
-work for any sequence object. The argument <tt class="docutils literal"><span class="pre">expectnd</span></tt> is the
-expected number of dimensions, ignored if &lt;= 0. The argument
-<tt class="docutils literal"><span class="pre">expectdims</span></tt> is an array of expected dimensions, ignored if &lt;=
-0. This routine raises a <tt class="docutils literal"><span class="pre">ValueError</span></tt> exception if the
-underlying <tt class="docutils literal"><span class="pre">PyArray_ContiguousFromObject</span></tt> routine fails, if the
-array has a bad shape, if the extent of a given dimension doesn't
-match the specified extent. If <tt class="docutils literal"><span class="pre">obj</span></tt> is a contiguous
-<tt class="docutils literal"><span class="pre">PyArrayObject*</span></tt> then a reference is returned; if <tt class="docutils literal"><span class="pre">obj</span></tt> is a
-python sequence, then a new <tt class="docutils literal"><span class="pre">PyArrayObject*</span></tt> is created and
-returned.</dd>
</dl>
</blockquote>
</div>
@@ -671,8 +659,9 @@ returned.</dd>
<div class="section">
<h1><a class="toc-backref" href="#id12" id="beyond-the-provided-typemaps" name="beyond-the-provided-typemaps">Beyond the Provided Typemaps</a></h1>
<p>There are many C or C++ array/<a class="reference" href="http://numpy.scipy.org">NumPy</a> array situations not covered by
-a simple <tt class="docutils literal"><span class="pre">%include</span> <span class="pre">&quot;numpy.i&quot;</span></tt>. Nevertheless, <tt class="docutils literal"><span class="pre">numpy.i</span></tt> may still
-be helpful when you encounter them.</p>
+a simple <tt class="docutils literal"><span class="pre">%include</span> <span class="pre">&quot;numpy.i&quot;</span></tt> and subsequent <tt class="docutils literal"><span class="pre">%apply</span></tt> directives.
+Nevertheless, <tt class="docutils literal"><span class="pre">numpy.i</span></tt> may still be helpful when you encounter
+them.</p>
<blockquote>
<ul>
<li><p class="first">In some situations, it is possible that you could use the
@@ -719,7 +708,7 @@ result possible.</p>
</div>
<div class="footer">
<hr class="footer" />
-Generated on: 2007-03-19 04:09 UTC.
+Generated on: 2007-03-23 12:04 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>