← Back to branch summary

~jtaylor/ubuntu/precise/python-numpy/multiarch-fix-818867

« back to all changes in this revision

Viewing changes to numpy/doc/html/example-module.html

  • Committer: Bazaar Package Importer
  • Author(s): Ondrej Certik, Riku Voipio, Tiziano Zito, Carlos Galisteo, Ondrej Certik
  • Date: 2008-07-08 15:08:16 UTC
  • mfrom: (0.1.21 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080708150816-ekf992jcp2k1eua3
Tags: 1:1.1.0-3
http://bugs.debian.org/489568
http://bugs.debian.org/489726
[ Riku Voipio ]
* debian/control: atlas is not available on armel, and after a quick look
  neither on alpha. I'd also suggest dropping
  libatlas-sse-dev|libatlas-sse2-dev|libatlas-3dnow-dev alternative combo
  away, these are potentially dangerous on buildd's. Ondrej: dropped.
  (Closes: #489568)

[ Tiziano Zito ]
* patch: build _dotblas.c when ATLAS is not installed, build-conflict with
  atlas, build-depend on blas+lapack only, as it used to be (Closes: #489726)

[ Carlos Galisteo ]
* debian/control
  - Added Homepage field.

[ Ondrej Certik ]
* Checked the package on i386 and amd64, both with and without atlas, all
  tests run and the numpy package is faster if atlas is around. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
numpy/doc/html/example-module.html
 
1
<?xml version="1.0" encoding="ascii"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>example</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
 
8
  <script type="text/javascript" src="epydoc.js"></script>
 
9
</head>
 
10
 
 
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
12
      alink="#204080">
 
13
<!-- ==================== NAVIGATION BAR ==================== -->
 
14
<table class="navbar" border="0" width="100%" cellpadding="0"
 
15
       bgcolor="#a0c0ff" cellspacing="0">
 
16
  <tr valign="middle">
 
17
  <!-- Home link -->
 
18
      <th bgcolor="#70b0f0" class="navbar-select"
 
19
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>
 
20
 
 
21
  <!-- Tree link -->
 
22
      <th>&nbsp;&nbsp;&nbsp;<a
 
23
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
24
 
 
25
  <!-- Index link -->
 
26
      <th>&nbsp;&nbsp;&nbsp;<a
 
27
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
28
 
 
29
  <!-- Help link -->
 
30
      <th>&nbsp;&nbsp;&nbsp;<a
 
31
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
32
 
 
33
      <th class="navbar" width="100%"></th>
 
34
  </tr>
 
35
</table>
 
36
<table width="100%" cellpadding="0" cellspacing="0">
 
37
  <tr valign="top">
 
38
    <td width="100%">
 
39
      <span class="breadcrumbs">
 
40
        Module&nbsp;example
 
41
      </span>
 
42
    </td>
 
43
    <td>
 
44
      <table cellpadding="0" cellspacing="0">
 
45
        <!-- hide/show private -->
 
46
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 
47
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 
48
        <tr><td align="right"><span class="options"
 
49
            >[<a href="frames.html" target="_top">frames</a
 
50
            >]&nbsp;|&nbsp;<a href="example-module.html"
 
51
            target="_top">no&nbsp;frames</a>]</span></td></tr>
 
52
      </table>
 
53
    </td>
 
54
  </tr>
 
55
</table>
 
56
<!-- ==================== MODULE DESCRIPTION ==================== -->
 
57
<h1 class="epydoc">Module example</h1><p class="nomargin-top"><span class="codelink"><a href="example-pysrc.html">source&nbsp;code</a></span></p>
 
58
<p>This is the docstring for the example.py module.  Modules names should
 
59
have short, all-lowercase names.  The module name may have underscores if
 
60
this improves readability.</p>
 
61
<p>Every module should have a docstring at the very top of the file.  The
 
62
module's docstring may extend over multiple lines.  If your docstring does
 
63
extend over multiple lines, the closing three quotation marks must be on
 
64
a line by itself, preferably preceeded by a blank line.</p>
 
65
 
 
66
<!-- ==================== FUNCTIONS ==================== -->
 
67
<a name="section-Functions"></a>
 
68
<table class="summary" border="1" cellpadding="3"
 
69
       cellspacing="0" width="100%" bgcolor="white">
 
70
<tr bgcolor="#70b0f0" class="table-header">
 
71
  <td colspan="2" class="table-header">
 
72
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
73
      <tr valign="top">
 
74
        <td align="left"><span class="table-header">Functions</span></td>
 
75
        <td align="right" valign="top"
 
76
         ><span class="options">[<a href="#section-Functions"
 
77
         class="privatelink" onclick="toggle_private();"
 
78
         >hide private</a>]</span></td>
 
79
      </tr>
 
80
    </table>
 
81
  </td>
 
82
</tr>
 
83
<tr>
 
84
    <td width="15%" align="right" valign="top" class="summary">
 
85
      <span class="summary-type">&nbsp;</span>
 
86
    </td><td class="summary">
 
87
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
88
        <tr>
 
89
          <td><span class="summary-sig"><a href="example-module.html#foo" class="summary-sig-name">foo</a>(<span class="summary-sig-arg">var1</span>,
 
90
        <span class="summary-sig-arg">var2</span>,
 
91
        <span class="summary-sig-arg">long_var_name</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">hi</code><code class="variable-quote">'</code></span>)</span><br />
 
92
      One-line summary or signature.</td>
 
93
          <td align="right" valign="top">
 
94
            <span class="codelink"><a href="example-pysrc.html#foo">source&nbsp;code</a></span>
 
95
            
 
96
          </td>
 
97
        </tr>
 
98
      </table>
 
99
      
 
100
    </td>
 
101
  </tr>
 
102
<tr>
 
103
    <td width="15%" align="right" valign="top" class="summary">
 
104
      <span class="summary-type">&nbsp;</span>
 
105
    </td><td class="summary">
 
106
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
107
        <tr>
 
108
          <td><span class="summary-sig"><a href="example-module.html#newfunc" class="summary-sig-name">newfunc</a>()</span><br />
 
109
      Do nothing.</td>
 
110
          <td align="right" valign="top">
 
111
            <span class="codelink"><a href="example-pysrc.html#newfunc">source&nbsp;code</a></span>
 
112
            
 
113
          </td>
 
114
        </tr>
 
115
      </table>
 
116
      
 
117
    </td>
 
118
  </tr>
 
119
<tr>
 
120
    <td width="15%" align="right" valign="top" class="summary">
 
121
      <span class="summary-type">&nbsp;</span>
 
122
    </td><td class="summary">
 
123
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
124
        <tr>
 
125
          <td><span class="summary-sig"><a href="example-module.html#otherfunc" class="summary-sig-name">otherfunc</a>()</span><br />
 
126
      Do nothing.</td>
 
127
          <td align="right" valign="top">
 
128
            <span class="codelink"><a href="example-pysrc.html#otherfunc">source&nbsp;code</a></span>
 
129
            
 
130
          </td>
 
131
        </tr>
 
132
      </table>
 
133
      
 
134
    </td>
 
135
  </tr>
 
136
</table>
 
137
<!-- ==================== FUNCTION DETAILS ==================== -->
 
138
<a name="section-FunctionDetails"></a>
 
139
<table class="details" border="1" cellpadding="3"
 
140
       cellspacing="0" width="100%" bgcolor="white">
 
141
<tr bgcolor="#70b0f0" class="table-header">
 
142
  <td colspan="2" class="table-header">
 
143
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
144
      <tr valign="top">
 
145
        <td align="left"><span class="table-header">Function Details</span></td>
 
146
        <td align="right" valign="top"
 
147
         ><span class="options">[<a href="#section-FunctionDetails"
 
148
         class="privatelink" onclick="toggle_private();"
 
149
         >hide private</a>]</span></td>
 
150
      </tr>
 
151
    </table>
 
152
  </td>
 
153
</tr>
 
154
</table>
 
155
<a name="foo"></a>
 
156
<div>
 
157
<table class="details" border="1" cellpadding="3"
 
158
       cellspacing="0" width="100%" bgcolor="white">
 
159
<tr><td>
 
160
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
161
  <tr valign="top"><td>
 
162
  <h3 class="epydoc"><span class="sig"><span class="sig-name">foo</span>(<span class="sig-arg">var1</span>,
 
163
        <span class="sig-arg">var2</span>,
 
164
        <span class="sig-arg">long_var_name</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">hi</code><code class="variable-quote">'</code></span>)</span>
 
165
  </h3>
 
166
  </td><td align="right" valign="top"
 
167
    ><span class="codelink"><a href="example-pysrc.html#foo">source&nbsp;code</a></span>&nbsp;
 
168
    </td>
 
169
  </tr></table>
 
170
  
 
171
  <p>One-line summary or signature.</p>
 
172
<p>Several sentences providing an extended description. You can put
 
173
text in mono-spaced type like so: <tt class="rst-docutils literal"><span class="pre">var</span></tt>.</p>
 
174
<div class="rst-section" id="rst-parameters">
 
175
<h1 class="heading">Parameters</h1>
 
176
<dl class="rst-docutils">
 
177
<dt>var1 <span class="classifier-delimiter">:</span> <span class="rst-classifier">array_like</span></dt>
 
178
<dd>Array_like means all those objects -- lists, nested lists, etc. --
 
179
that can be converted to an array.</dd>
 
180
<dt>var2 <span class="classifier-delimiter">:</span> <span class="rst-classifier">integer</span></dt>
 
181
<dd>Write out the full type</dd>
 
182
<dt>long_variable_name <span class="classifier-delimiter">:</span> <span class="rst-classifier">{'hi', 'ho'}, optional</span></dt>
 
183
<dd>Choices in brackets, default first when optional.</dd>
 
184
</dl>
 
185
</div>
 
186
<div class="rst-section" id="rst-returns">
 
187
<h1 class="heading">Returns</h1>
 
188
<dl class="rst-docutils">
 
189
<dt>named <span class="classifier-delimiter">:</span> <span class="rst-classifier">type</span></dt>
 
190
<dd>Explanation</dd>
 
191
<dt>list</dt>
 
192
<dd>Explanation</dd>
 
193
<dt>of</dt>
 
194
<dd>Explanation</dd>
 
195
<dt>outputs</dt>
 
196
<dd>even more explaining</dd>
 
197
</dl>
 
198
</div>
 
199
<div class="rst-section" id="rst-other-parameters">
 
200
<h1 class="heading">Other Parameters</h1>
 
201
<dl class="rst-docutils">
 
202
<dt>only_seldom_used_keywords <span class="classifier-delimiter">:</span> <span class="rst-classifier">type</span></dt>
 
203
<dd>Explanation</dd>
 
204
<dt>common_parametrs_listed_above <span class="classifier-delimiter">:</span> <span class="rst-classifier">type</span></dt>
 
205
<dd>Explanation</dd>
 
206
</dl>
 
207
</div>
 
208
<div class="rst-section" id="rst-see-also">
 
209
<h1 class="heading">See Also</h1>
 
210
<p>otherfunc : relationship (optional)
 
211
newfunc : relationship (optional)</p>
 
212
</div>
 
213
<div class="rst-section" id="rst-notes">
 
214
<h1 class="heading">Notes</h1>
 
215
<p>Notes about the implementation algorithm (if needed).</p>
 
216
<p>This can have multiple paragraphs as can all sections.</p>
 
217
</div>
 
218
<div class="rst-section" id="rst-examples">
 
219
<h1 class="heading">Examples</h1>
 
220
<p>examples in doctest format</p>
 
221
<pre class="py-doctest">
 
222
<span class="py-prompt">&gt;&gt;&gt; </span>a=[1,2,3]
 
223
<span class="py-prompt">&gt;&gt;&gt; </span>[x + 3 <span class="py-keyword">for</span> x <span class="py-keyword">in</span> a]
 
224
<span class="py-output">[4, 5, 6]</span></pre>
 
225
</div>
 
226
  <dl class="fields">
 
227
  </dl>
 
228
</td></tr></table>
 
229
</div>
 
230
<a name="newfunc"></a>
 
231
<div>
 
232
<table class="details" border="1" cellpadding="3"
 
233
       cellspacing="0" width="100%" bgcolor="white">
 
234
<tr><td>
 
235
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
236
  <tr valign="top"><td>
 
237
  <h3 class="epydoc"><span class="sig"><span class="sig-name">newfunc</span>()</span>
 
238
  </h3>
 
239
  </td><td align="right" valign="top"
 
240
    ><span class="codelink"><a href="example-pysrc.html#newfunc">source&nbsp;code</a></span>&nbsp;
 
241
    </td>
 
242
  </tr></table>
 
243
  
 
244
  <p>Do nothing.</p>
 
245
<p>I never saw a purple cow.</p>
 
246
  <dl class="fields">
 
247
  </dl>
 
248
</td></tr></table>
 
249
</div>
 
250
<a name="otherfunc"></a>
 
251
<div>
 
252
<table class="details" border="1" cellpadding="3"
 
253
       cellspacing="0" width="100%" bgcolor="white">
 
254
<tr><td>
 
255
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
256
  <tr valign="top"><td>
 
257
  <h3 class="epydoc"><span class="sig"><span class="sig-name">otherfunc</span>()</span>
 
258
  </h3>
 
259
  </td><td align="right" valign="top"
 
260
    ><span class="codelink"><a href="example-pysrc.html#otherfunc">source&nbsp;code</a></span>&nbsp;
 
261
    </td>
 
262
  </tr></table>
 
263
  
 
264
  <p>Do nothing.</p>
 
265
<p>I never hope to see one.</p>
 
266
  <dl class="fields">
 
267
  </dl>
 
268
</td></tr></table>
 
269
</div>
 
270
<br />
 
271
<!-- ==================== NAVIGATION BAR ==================== -->
 
272
<table class="navbar" border="0" width="100%" cellpadding="0"
 
273
       bgcolor="#a0c0ff" cellspacing="0">
 
274
  <tr valign="middle">
 
275
  <!-- Home link -->
 
276
      <th bgcolor="#70b0f0" class="navbar-select"
 
277
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>
 
278
 
 
279
  <!-- Tree link -->
 
280
      <th>&nbsp;&nbsp;&nbsp;<a
 
281
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
282
 
 
283
  <!-- Index link -->
 
284
      <th>&nbsp;&nbsp;&nbsp;<a
 
285
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
286
 
 
287
  <!-- Help link -->
 
288
      <th>&nbsp;&nbsp;&nbsp;<a
 
289
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
290
 
 
291
      <th class="navbar" width="100%"></th>
 
292
  </tr>
 
293
</table>
 
294
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
295
  <tr>
 
296
    <td align="left" class="footer">
 
297
    Generated by Epydoc 3.0beta1 on Tue Jan 22 00:26:36 2008
 
298
    </td>
 
299
    <td align="right" class="footer">
 
300
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
 
301
        >http://epydoc.sourceforge.net</a>
 
302
    </td>
 
303
  </tr>
 
304
</table>
 
305
 
 
306
<script type="text/javascript">
 
307
  <!--
 
308
  // Private objects are initially displayed (because if
 
309
  // javascript is turned off then we want them to be
 
310
  // visible); but by default, we want to hide them.  So hide
 
311
  // them unless we have a cookie that says to show them.
 
312
  checkCookie();
 
313
  // -->
 
314
</script>
 
315
</body>
 
316
</html>