This file is indexed.

/usr/share/doc/python-brian-doc/docs/compiledcode.html is in python-brian-doc 1.3.1-1build1.

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
<!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>Compiled code &mdash; Brian v1.3.1 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:     '1.3.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  false
      };
    </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="Brian v1.3.1 documentation" href="index.html" />
    <link rel="up" title="Advanced concepts" href="advanced.html" />
    <link rel="next" title="Projects with multiple files or functions" href="tasks_multiplefiles.html" />
    <link rel="prev" title="How to write efficient Brian code" href="efficient.html" /> 
  </head>
  <body>
    <div class="related">
      <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="tasks_multiplefiles.html" title="Projects with multiple files or functions"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="efficient.html" title="How to write efficient Brian code"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Brian v1.3.1 documentation</a> &raquo;</li>
          <li><a href="advanced.html" accesskey="U">Advanced concepts</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="compiled-code">
<span id="id1"></span><h1>Compiled code<a class="headerlink" href="#compiled-code" title="Permalink to this headline"></a></h1>
<p>Compiled C code can be used in several places in Brian to get speed improvements in cases where performance
is the most important factor.</p>
<div class="section" id="weave">
<h2>Weave<a class="headerlink" href="#weave" title="Permalink to this headline"></a></h2>
<p>Weave is a SciPy module that allows the use of inlined C++ code. Brian by default doesn&#8217;t use any C++
optimisations for maximum compatibility across platforms, but you can enable several optimised
versions of Brian objects and functions by enabling weave compilation. See <a class="reference internal" href="reference-preferences.html#preferences"><em>Preferences</em></a>
for more information.</p>
<p>See also <a class="reference internal" href="efficient.html#efficiency-vectorisation"><em>Vectorisation</em></a> for some information on writing your own inlined C++ code
using Weave.</p>
</div>
<div class="section" id="circular-arrays">
<h2>Circular arrays<a class="headerlink" href="#circular-arrays" title="Permalink to this headline"></a></h2>
<p>For maximum compatibility, Brian works with pure Python only. However, as well as the optional
weave optimisations, there is also an object used in the spike propagation code that can run
with a pure C++ version for a considerable speedup (1.5-3x). You need a copy of the <tt class="docutils literal"><span class="pre">gcc</span></tt> compiler
installed (either on linux or through cygwin on Windows) to build it.</p>
<p>Installation:</p>
<p>In a command prompt or shell window, go to the directory where Brian is installed. On Windows this
will probably be <tt class="docutils literal"><span class="pre">C:\Python25\lib\site-packages\brian</span></tt>. Now
go to the <tt class="docutils literal"><span class="pre">Brian/brian/utils/ccircular</span></tt> folder. If you&#8217;re on Linux (and this may also work for Mac) run
the command <tt class="docutils literal"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">build_ext</span> <span class="pre">--inplace</span></tt>. If you&#8217;re on windows you&#8217;ll need to have cygwin with gcc
installed, and then you run <tt class="docutils literal"><span class="pre">setup.py</span> <span class="pre">build_ext</span> <span class="pre">--inplace</span> <span class="pre">-c</span> <span class="pre">mingw32</span></tt> instead. You should see some
compilation, possibly with some warnings but no errors.</p>
</div>
<div class="section" id="automatically-generated-c-code">
<h2>Automatically generated C code<a class="headerlink" href="#automatically-generated-c-code" title="Permalink to this headline"></a></h2>
<p>There is an experimental module for automatic generation of C code, see
<a class="reference internal" href="experimental-codegen.html#experimental-codegen"><em>Code generation</em></a>.</p>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/brian-logo.png" alt="Logo"/>
            </a></p>
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Compiled code</a><ul>
<li><a class="reference internal" href="#weave">Weave</a></li>
<li><a class="reference internal" href="#circular-arrays">Circular arrays</a></li>
<li><a class="reference internal" href="#automatically-generated-c-code">Automatically generated C code</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="efficient.html"
                        title="previous chapter">How to write efficient Brian code</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="tasks_multiplefiles.html"
                        title="next chapter">Projects with multiple files or functions</a></p>
<div id="searchbox" style="display: none">
  <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">
      <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="tasks_multiplefiles.html" title="Projects with multiple files or functions"
             >next</a> |</li>
        <li class="right" >
          <a href="efficient.html" title="How to write efficient Brian code"
             >previous</a> |</li>
        <li><a href="index.html">Brian v1.3.1 documentation</a> &raquo;</li>
          <li><a href="advanced.html" >Advanced concepts</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2008, Romain Brette, Dan Goodman.
      Last updated on Feb 19, 2012.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.
    </div>
  </body>
</html>