Showing with 168 additions and 95 deletions.
  1. +17 −15 _sources/index.txt
  2. +11 −11 genindex.html
  3. +134 −63 index.html
  4. BIN objects.inv
  5. +5 −5 search.html
  6. +1 −1 searchindex.js
32 changes: 17 additions & 15 deletions _sources/index.txt
Expand Up @@ -6,19 +6,18 @@
Welcome to pyFFTW's documentation!
==================================

* :ref:`ComplexFFTW Class <ComplexFFTW_class>`
* :ref:`FFTW Class <FFTW_class>`
* :ref:`Utility Functions <UtilityFunctions>`

pyFFTW is an attempt to produce a pythonic wrapper around
`FFTW <http://www.fftw.org/>`_. The ultimate aim is to present a unified
interface for all the possible transforms that FFTW can perform.

Currently, only the complex DFT is supported, though on arbitrary
Both the complex DFT and the real DFT are supported, as well as on arbitrary
axes of abitrary shaped and strided arrays, which makes it almost
feature equivalent to standard FFT functions of ``numpy.fft`` (indeed,
it supports the ``clongdouble`` dtype which ``numpy.fft`` does not).
It shouldn't be too much work to extend it to other schemes such as
the real DFT. See the ``numpy.fft`` `documentation
feature equivalent to standard and real FFT functions of ``numpy.fft``
(indeed, it supports the ``clongdouble`` dtype which ``numpy.fft`` does not).
See the ``numpy.fft`` `documentation
<http://docs.scipy.org/doc/numpy/reference/routines.fft.html>`_
for more information on that module.

Expand All @@ -37,8 +36,8 @@ A quick (and very much non-comprehensive) usage example:
>>> b = pyfftw.n_byte_align_empty(a.shape, 16, dtype=a.dtype)
>>> c = pyfftw.n_byte_align_empty(a.shape, 16, dtype=a.dtype)
>>> # Create the DFT and inverse DFT objects
>>> fft = pyfftw.ComplexFFTW(a, b)
>>> ifft = pyfftw.ComplexFFTW(b, c, direction='FFTW_BACKWARD')
>>> fft = pyfftw.FFTW(a, b)
>>> ifft = pyfftw.FFTW(b, c, direction='FFTW_BACKWARD')
>>> # Fill a with data
>>> a[:] = [1, 2, 3, 4]
>>> print a
Expand All @@ -52,20 +51,23 @@ A quick (and very much non-comprehensive) usage example:
>>> print c/a.size
[[ 1.+0.j 2.+0.j 3.+0.j 4.+0.j]]

.. _ComplexFFTW_class:
**Note that what was previously the ComplexFFTW class is now just called
FFTW. Simply renaming the class should be sufficient to migrate**

ComplexFFTW Class
.. _FFTW_class:

FFTW Class
-----------------

.. autoclass:: pyfftw.ComplexFFTW(input_array, output_array, axes=[-1], direction='FFTW_FORWARD', flags=['FFTW_MEASURE'])
.. autoclass:: pyfftw.FFTW(input_array, output_array, axes=[-1], direction='FFTW_FORWARD', flags=['FFTW_MEASURE'])

.. _ComplexFFTW_update_arrays:
.. _FFTW_update_arrays:

.. automethod:: pyfftw.ComplexFFTW.update_arrays(new_input_array, new_output_array)
.. automethod:: pyfftw.FFTW.update_arrays(new_input_array, new_output_array)

.. _ComplexFFTW_execute:
.. _FFTW_execute:

.. automethod:: pyfftw.ComplexFFTW.execute()
.. automethod:: pyfftw.FFTW.execute()

.. _UtilityFunctions:

Expand Down
22 changes: 11 additions & 11 deletions genindex.html
Expand Up @@ -7,13 +7,13 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Index &mdash; pyFFTW v0.5.1 documentation</title>
<title>Index &mdash; pyFFTW v0.6.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.5.1',
VERSION: '0.6.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -22,7 +22,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pyFFTW v0.5.1 documentation" href="index.html" />
<link rel="top" title="pyFFTW v0.6.0 documentation" href="index.html" />
</head>
<body>
<div class="related">
Expand All @@ -31,7 +31,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">pyFFTW v0.5.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyFFTW v0.6.0 documentation</a> &raquo;</li>
</ul>
</div>

Expand All @@ -44,19 +44,19 @@ <h3>Navigation</h3>
<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
<a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#U"><strong>U</strong></a>
<a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#U"><strong>U</strong></a>
</div>
<h2 id="C">C</h2>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#pyfftw.ComplexFFTW">ComplexFFTW (class in pyfftw)</a></dt>
<dt><a href="index.html#pyfftw.FFTW.execute">execute() (pyfftw.FFTW method)</a></dt>
</dl></td>
</tr></table>

<h2 id="E">E</h2>
<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#pyfftw.ComplexFFTW.execute">execute() (pyfftw.ComplexFFTW method)</a></dt>
<dt><a href="index.html#pyfftw.FFTW">FFTW (class in pyfftw)</a></dt>
</dl></td>
</tr></table>

Expand All @@ -73,7 +73,7 @@ <h2 id="N">N</h2>
<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#pyfftw.ComplexFFTW.update_arrays">update_arrays() (pyfftw.ComplexFFTW method)</a></dt>
<dt><a href="index.html#pyfftw.FFTW.update_arrays">update_arrays() (pyfftw.FFTW method)</a></dt>
</dl></td>
</tr></table>

Expand Down Expand Up @@ -110,7 +110,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li><a href="index.html">pyFFTW v0.5.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyFFTW v0.6.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
Expand Down