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

* :ref:`FFTW Class <FFTW_class>`
* :ref:`Wisdom Functions <WisdomFunctions>`
* :ref:`Utility Functions <UtilityFunctions>`

pyFFTW is a pythonic wrapper around `FFTW <http://www.fftw.org/>`_, the
Expand Down Expand Up @@ -71,6 +72,28 @@ FFTW Class

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

.. _WisdomFunctions:

Wisdom Functions
----------------

Functions for dealing with FFTW's ability to export and restore plans,
referred to as *wisdom*. For further information, refer to the `FFTW
wisdom documentation <http://www.fftw.org/fftw3_doc/Words-of-Wisdom_002dSaving-Plans.html#Words-of-Wisdom_002dSaving-Plans>`_.

.. _export_wisdom:

.. autofunction:: pyfftw.export_wisdom

.. _import_wisdom:

.. autofunction:: pyfftw.import_wisdom

.. _forget_wisdom:

.. autofunction:: pyfftw.forget_wisdom


.. _UtilityFunctions:

Utility Functions
Expand Down
25 changes: 19 additions & 6 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.7.0 documentation</title>
<title>Index &mdash; pyFFTW v0.8.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.7.0',
VERSION: '0.8.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.7.0 documentation" href="index.html" />
<link rel="top" title="pyFFTW v0.8.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.7.0 documentation</a> &raquo;</li>
<li><a href="index.html">pyFFTW v0.8.0 documentation</a> &raquo;</li>
</ul>
</div>

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

<div class="genindex-jumpbox">
<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>
<a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#U"><strong>U</strong></a>
</div>
<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.FFTW.execute">execute() (pyfftw.FFTW method)</a></dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#pyfftw.export_wisdom">export_wisdom() (in module pyfftw)</a></dt>
</dl></td>
</tr></table>

<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.FFTW">FFTW (class in pyfftw)</a></dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#pyfftw.forget_wisdom">forget_wisdom() (in module pyfftw)</a></dt>
</dl></td>
</tr></table>

<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#pyfftw.import_wisdom">import_wisdom() (in module pyfftw)</a></dt>
</dl></td>
</tr></table>

Expand Down Expand Up @@ -110,7 +123,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.7.0 documentation</a> &raquo;</li>
<li><a href="index.html">pyFFTW v0.8.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
Expand Down
52 changes: 47 additions & 5 deletions index.html
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.7.0 documentation</title>
<title>Welcome to pyFFTW’s documentation! &mdash; pyFFTW v0.8.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.7.0',
VERSION: '0.8.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.7.0 documentation" href="#" />
<link rel="top" title="pyFFTW v0.8.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.7.0 documentation</a> &raquo;</li>
<li><a href="#">pyFFTW v0.8.0 documentation</a> &raquo;</li>
</ul>
</div>

Expand All @@ -44,6 +44,7 @@ <h3>Navigation</h3>
<h1>Welcome to pyFFTW&#8217;s documentation!<a class="headerlink" href="#welcome-to-pyfftw-s-documentation" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><a class="reference internal" href="#fftw-class"><em>FFTW Class</em></a></li>
<li><a class="reference internal" href="#wisdomfunctions"><em>Wisdom Functions</em></a></li>
<li><a class="reference internal" href="#utilityfunctions"><em>Utility Functions</em></a></li>
</ul>
<p>pyFFTW is a pythonic wrapper around <a class="reference external" href="http://www.fftw.org/">FFTW</a>, the
Expand Down Expand Up @@ -279,6 +280,46 @@ <h1>Welcome to pyFFTW&#8217;s documentation!<a class="headerlink" href="#welcome

</dd></dl>

</div>
<div class="section" id="wisdom-functions">
<span id="wisdomfunctions"></span><h2>Wisdom Functions<a class="headerlink" href="#wisdom-functions" title="Permalink to this headline"></a></h2>
<p>Functions for dealing with FFTW&#8217;s ability to export and restore plans,
referred to as <em>wisdom</em>. For further information, refer to the <a class="reference external" href="http://www.fftw.org/fftw3_doc/Words-of-Wisdom_002dSaving-Plans.html#Words-of-Wisdom_002dSaving-Plans">FFTW
wisdom documentation</a>.</p>
<span class="target" id="export-wisdom"></span><dl class="function">
<dt id="pyfftw.export_wisdom">
<tt class="descclassname">pyfftw.</tt><tt class="descname">export_wisdom</tt><big>(</big><big>)</big><a class="headerlink" href="#pyfftw.export_wisdom" title="Permalink to this definition"></a></dt>
<dd><p>Return the FFTW wisdom as a tuple of strings.</p>
<p>The first string in the tuple is the string for the double
precision wisdom. The second string in the tuple is the string
for the single precision wisdom. The third string in the tuple
is the string for the long douple precision wisdom.</p>
<p>The tuple that is returned from this function can be used as the
argument to <a class="reference internal" href="#import-wisdom"><em>import_wisdom()</em></a>.</p>
</dd></dl>

<span class="target" id="import-wisdom"></span><dl class="function">
<dt id="pyfftw.import_wisdom">
<tt class="descclassname">pyfftw.</tt><tt class="descname">import_wisdom</tt><big>(</big><em>wisdom</em><big>)</big><a class="headerlink" href="#pyfftw.import_wisdom" title="Permalink to this definition"></a></dt>
<dd><p>Function that imports wisdom from the passed tuple
of strings.</p>
<p>The first string in the tuple is the string for the double
precision wisdom. The second string in the tuple is the string
for the single precision wisdom. The third string in the tuple
is the string for the long douple precision wisdom.</p>
<p>The tuple that is returned from <a class="reference internal" href="#export-wisdom"><em>export_wisdom()</em></a>
can be used as the argument to this function.</p>
<p>This function returns a tuple of boolean values indicating
the success of loading each of the wisdom types (double, float
and long double, in that order).</p>
</dd></dl>

<span class="target" id="forget-wisdom"></span><dl class="function">
<dt id="pyfftw.forget_wisdom">
<tt class="descclassname">pyfftw.</tt><tt class="descname">forget_wisdom</tt><big>(</big><big>)</big><a class="headerlink" href="#pyfftw.forget_wisdom" title="Permalink to this definition"></a></dt>
<dd><p>Forget all the accumulated wisdom.</p>
</dd></dl>

</div>
<div class="section" id="utility-functions">
<span id="utilityfunctions"></span><h2>Utility Functions<a class="headerlink" href="#utility-functions" title="Permalink to this headline"></a></h2>
Expand Down Expand Up @@ -316,6 +357,7 @@ <h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to pyFFTW&#8217;s documentation!</a><ul>
<li><a class="reference internal" href="#fftw-class">FFTW Class</a></li>
<li><a class="reference internal" href="#wisdom-functions">Wisdom Functions</a></li>
<li><a class="reference internal" href="#utility-functions">Utility Functions</a></li>
</ul>
</li>
Expand Down Expand Up @@ -349,7 +391,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.7.0 documentation</a> &raquo;</li>
<li><a href="#">pyFFTW v0.8.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
Expand Down
Binary file modified objects.inv
Binary file not shown.
10 changes: 5 additions & 5 deletions search.html
Expand Up @@ -7,13 +7,13 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Search &mdash; pyFFTW v0.7.0 documentation</title>
<title>Search &mdash; pyFFTW v0.8.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.7.0',
VERSION: '0.8.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.7.0 documentation" href="index.html" />
<link rel="top" title="pyFFTW v0.8.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.7.0 documentation</a> &raquo;</li>
<li><a href="index.html">pyFFTW v0.8.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.7.0 documentation</a> &raquo;</li>
<li><a href="index.html">pyFFTW v0.8.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

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