/usr/share/doc/pyviennacl-doc/html/index.html is in pyviennacl-doc 1.0.2+dfsg-1build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>PyViennaCL — PyViennaCL 1.0.2 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<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="PyViennaCL 1.0.2 documentation" href="#" />
<link rel="next" title="PyViennaCL Example Code" href="examples/index.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="examples/index.html" title="PyViennaCL Example Code"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">PyViennaCL 1.0.2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<span class="target" id="module-pyviennacl"></span><div class="section" id="pyviennacl">
<h1>PyViennaCL<a class="headerlink" href="#pyviennacl" title="Permalink to this headline">¶</a></h1>
<p>This extension provides the Python bindings for the ViennaCL linear
algebra and numerical computation library for GPGPU and heterogeneous
systems. ViennaCL itself is a header-only C++ library, so these bindings
make available to Python programmers ViennaCL’s fast OpenCL and CUDA
algorithms, in a way that is idiomatic and compatible with the Python
community’s most popular scientific packages, NumPy and SciPy.</p>
<p>PyViennaCL is divided into five submodules, of which four are designed
for direct use by users:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="pycore.html"><em>pycore</em></a>: user-friendly classes for representing the main ViennaCL
objects, such as Matrix or Vector;</li>
<li><a class="reference internal" href="linalg.html"><em>linalg</em></a>: an explicit interface to a number of ViennaCL’s linear
algebra routines, such as matrix solvers and eigenvalue computation;</li>
<li><a class="reference internal" href="vclmath.html"><em>vclmath</em></a>: convenience functions akin to the standard math module
(you can also access it as <code class="docutils literal"><span class="pre">pyviennacl.math</span></code>);</li>
<li><a class="reference internal" href="util.html"><em>util</em></a>: utility functions, such as to construct an appropriate
ViennaCL object from an ndarray (Matrix or Vector), or to provide basic
debug logging;</li>
<li>_viennacl: a raw C++ interface to ViennaCL, with no stable API.</li>
</ul>
</div></blockquote>
<p>Nonetheless, all of PyViennaCL’s functionality is available from the
top-level pyviennacl namespace. So, if you want help on the Matrix class,
you can just run:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pyviennacl</span> <span class="kn">as</span> <span class="nn">p</span>
<span class="gp">>>> </span><span class="n">help</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">Matrix</span><span class="p">)</span>
</pre></div>
</div>
<p>For help on PyViennaCL’s core functionality in general, or
PyViennaCL’s high-level linear algebra functions, run:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">help</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">pycore</span><span class="p">)</span>
</pre></div>
</div>
<p>or:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">help</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">linalg</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="usage-examples">
<h1>Usage examples<a class="headerlink" href="#usage-examples" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="examples/index.html">PyViennaCL Example Code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/basics.html">PyViennaCL Basics</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/products.html">Computing products</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/slices-and-proxies.html">Submatrices: slices and proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/sparse-matrices.html">Sparse matrices</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/iterative-solvers.html">Iterative solvers</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/direct-solvers.html">Direct solvers</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span>Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span>Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span>Search Page</span></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">PyViennaCL</a></li>
<li><a class="reference internal" href="#usage-examples">Usage examples</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="examples/index.html"
title="next chapter">PyViennaCL Example Code</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="examples/index.html" title="PyViennaCL Example Code"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">PyViennaCL 1.0.2 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2013-2014, Toby St Clere Smithe.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.4.
</div>
</body>
</html>
|