Skip to content

Commit

Permalink
Committing the 0.7.0 docs (including multithreading).
Browse files Browse the repository at this point in the history
  • Loading branch information
@hgomersall
hgomersall committed Mar 4, 2012
1 parent e68a5dd commit 34d85b4
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 24 deletions.
10 changes: 6 additions & 4 deletions _sources/index.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Welcome to pyFFTW's documentation!
* :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.
pyFFTW is a pythonic wrapper around `FFTW <http://www.fftw.org/>`_, the
speedy FFT library. The ultimate aim is to present a unified interface for all
the possible transforms that FFTW can perform.

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
Expand All @@ -25,6 +25,8 @@ The source can be found in `github <https://github.com/hgomersall/pyFFTW>`_
and it's page in the python package index is
`here <http://pypi.python.org/pypi/pyFFTW>`_.

Operating FFTW in multithreaded mode is supported.

A comprehensive unittest suite is included with the source on the repository.

A quick (and very much non-comprehensive) usage example:
Expand Down Expand Up @@ -59,7 +61,7 @@ FFTW. Simply renaming the class should be sufficient to migrate**
FFTW Class
-----------------

.. autoclass:: pyfftw.FFTW(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',), threads=1)

.. _FFTW_update_arrays:

Expand Down
10 changes: 5 additions & 5 deletions genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Index &mdash; pyFFTW v0.6.1 documentation</title>
<title>Index &mdash; pyFFTW v0.7.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.6.1',
VERSION: '0.7.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.6.1 documentation" href="index.html" />
<link rel="top" title="pyFFTW v0.7.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.6.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyFFTW v0.7.0 documentation</a> &raquo;</li>
</ul>
</div>

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.6.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyFFTW v0.7.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
Expand Down
23 changes: 14 additions & 9 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Welcome to pyFFTW’s documentation! &mdash; pyFFTW v0.6.1 documentation</title>
<title>Welcome to pyFFTW’s documentation! &mdash; pyFFTW v0.7.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.6.1',
VERSION: '0.7.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.6.1 documentation" href="#" />
<link rel="top" title="pyFFTW v0.7.0 documentation" href="#" />
</head>
<body>
<div class="related">
Expand All @@ -31,7 +31,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li><a href="#">pyFFTW v0.6.1 documentation</a> &raquo;</li>
<li><a href="#">pyFFTW v0.7.0 documentation</a> &raquo;</li>
</ul>
</div>

Expand All @@ -46,9 +46,9 @@ <h1>Welcome to pyFFTW&#8217;s documentation!<a class="headerlink" href="#welcome
<li><a class="reference internal" href="#fftw-class"><em>FFTW Class</em></a></li>
<li><a class="reference internal" href="#utilityfunctions"><em>Utility Functions</em></a></li>
</ul>
<p>pyFFTW is an attempt to produce a pythonic wrapper around
<a class="reference external" href="http://www.fftw.org/">FFTW</a>. The ultimate aim is to present a unified
interface for all the possible transforms that FFTW can perform.</p>
<p>pyFFTW is a pythonic wrapper around <a class="reference external" href="http://www.fftw.org/">FFTW</a>, the
speedy FFT library. The ultimate aim is to present a unified interface for all
the possible transforms that FFTW can perform.</p>
<p>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 and real FFT functions of <tt class="docutils literal"><span class="pre">numpy.fft</span></tt>
Expand All @@ -58,6 +58,7 @@ <h1>Welcome to pyFFTW&#8217;s documentation!<a class="headerlink" href="#welcome
<p>The source can be found in <a class="reference external" href="https://github.com/hgomersall/pyFFTW">github</a>
and it&#8217;s page in the python package index is
<a class="reference external" href="http://pypi.python.org/pypi/pyFFTW">here</a>.</p>
<p>Operating FFTW in multithreaded mode is supported.</p>
<p>A comprehensive unittest suite is included with the source on the repository.</p>
<p>A quick (and very much non-comprehensive) usage example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">pyfftw</span><span class="o">,</span> <span class="nn">numpy</span>
Expand Down Expand Up @@ -89,7 +90,7 @@ <h1>Welcome to pyFFTW&#8217;s documentation!<a class="headerlink" href="#welcome
<span id="id1"></span><h2>FFTW Class<a class="headerlink" href="#fftw-class" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pyfftw.FFTW">
<em class="property">class </em><tt class="descclassname">pyfftw.</tt><tt class="descname">FFTW</tt><big>(</big><em>input_array</em>, <em>output_array</em>, <em>axes=(-1</em>, <em>)</em>, <em>direction='FFTW_FORWARD'</em>, <em>flags=('FFTW_MEASURE'</em>, <em>)</em><big>)</big><a class="headerlink" href="#pyfftw.FFTW" title="Permalink to this definition"></a></dt>
<em class="property">class </em><tt class="descclassname">pyfftw.</tt><tt class="descname">FFTW</tt><big>(</big><em>input_array</em>, <em>output_array</em>, <em>axes=(-1</em>, <em>)</em>, <em>direction='FFTW_FORWARD'</em>, <em>flags=('FFTW_MEASURE'</em>, <em>)</em>, <em>threads=1</em><big>)</big><a class="headerlink" href="#pyfftw.FFTW" title="Permalink to this definition"></a></dt>
<dd><p>FFTW is a class for computing the complex N-Dimensional DFT or
inverse DFT of an array using the FFTW library. The interface is
designed to be somewhat pythonic, with the correct transform being
Expand Down Expand Up @@ -133,6 +134,10 @@ <h1>Welcome to pyFFTW&#8217;s documentation!<a class="headerlink" href="#welcome
This tells FFTW not to assume anything about the
alignment of the data and disabling any SIMD capability
(see below).</p>
<p><tt class="docutils literal"><span class="pre">threads</span></tt> tells the wrapper how many threads to use
when invoking FFTW, with a default of 1. If the number
of threads is greater than 1, then the GIL is released
by necessity.</p>
<p>The currently supported schemes are as follows:</p>
<table border="1" class="docutils">
<colgroup>
Expand Down Expand Up @@ -344,7 +349,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li><a href="#">pyFFTW v0.6.1 documentation</a> &raquo;</li>
<li><a href="#">pyFFTW v0.7.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
Expand Down
Binary file modified objects.inv
View file
Binary file not shown.
10 changes: 5 additions & 5 deletions search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Search &mdash; pyFFTW v0.6.1 documentation</title>
<title>Search &mdash; pyFFTW v0.7.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.6.1',
VERSION: '0.7.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="pyFFTW v0.6.1 documentation" href="index.html" />
<link rel="top" title="pyFFTW v0.7.0 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
Expand All @@ -37,7 +37,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">pyFFTW v0.6.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyFFTW v0.7.0 documentation</a> &raquo;</li>
</ul>
</div>

Expand Down Expand Up @@ -85,7 +85,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li><a href="index.html">pyFFTW v0.6.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyFFTW v0.7.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 34d85b4

Please sign in to comment.