Skip to content

Commit c0c2604

Browse files
mbruno46mbruno46
committedSep 15, 2020
docs merged from develop
·
v1.5.1v0.2.1
1 parent 50fc081 commit c0c2604

27 files changed

+53
-28
lines changed
 

‎docs/_sources/mathfuncs.rst.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ The following functions can be imported using::
7474
>>> from pyobs import det, inv
7575

7676
.. automodule:: pyobs.observa
77-
:members: det, trace, inv
77+
:members: det, trace, inv, eig
7878

7979

8080
Manipulation of observables

‎docs/_static/basic.css

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- basic theme.
66
*
7-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/

‎docs/_static/doctools.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx JavaScript utilities for all documentation.
66
*
7-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/

‎docs/_static/language_data.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* This script contains the language-specific data used by searchtools.js,
66
* namely the list of stopwords, stemmer, scorer and splitter.
77
*
8-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
8+
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
99
* :license: BSD, see LICENSE for details.
1010
*
1111
*/

‎docs/_static/searchtools.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx JavaScript utilities for the full-text search.
66
*
7-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/

‎docs/_static/sphinxdoc.css

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* Sphinx stylesheet -- sphinxdoc theme. Originally created by
66
* Armin Ronacher for Werkzeug.
77
*
8-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
8+
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
99
* :license: BSD, see LICENSE for details.
1010
*
1111
*/

‎docs/_static/websupport.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* sphinx.websupport utilities for all documentation.
66
*
7-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/

‎docs/basics.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ <h3>Navigation</h3>
165165
</div>
166166
<div class="footer" role="contentinfo">
167167
&#169; Copyright 2018, Mattia Bruno.
168-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
168+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
169169
</div>
170170
</body>
171171
</html>

‎docs/eigen.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h3>Navigation</h3>
102102
</div>
103103
<div class="footer" role="contentinfo">
104104
&#169; Copyright 2018, Mattia Bruno.
105-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
105+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
106106
</div>
107107
</body>
108108
</html>

‎docs/error.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ <h3>Navigation</h3>
264264
</div>
265265
<div class="footer" role="contentinfo">
266266
&#169; Copyright 2018, Mattia Bruno.
267-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
267+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
268268
</div>
269269
</body>
270270
</html>

‎docs/first.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ <h3>Navigation</h3>
153153
</div>
154154
<div class="footer" role="contentinfo">
155155
&#169; Copyright 2018, Mattia Bruno.
156-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
156+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
157157
</div>
158158
</body>
159159
</html>

‎docs/fitting.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ <h3>Navigation</h3>
321321
</div>
322322
<div class="footer" role="contentinfo">
323323
&#169; Copyright 2018, Mattia Bruno.
324-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
324+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
325325
</div>
326326
</body>
327327
</html>

‎docs/genindex.html

+5-3
Original file line numberDiff line numberDiff line change
@@ -125,12 +125,14 @@ <h2 id="D">D</h2>
125125
<h2 id="E">E</h2>
126126
<table style="width: 100%" class="indextable genindextable"><tr>
127127
<td style="width: 33%; vertical-align: top;"><ul>
128-
<li><a href="pyobs.vwerr.html#pyobs.vwerr.errinfo">errinfo (class in pyobs.vwerr)</a>
128+
<li><a href="mathfuncs.html#pyobs.observa.eig">eig() (in module pyobs.observa)</a>
129129
</li>
130-
<li><a href="pyobs.fit.html#pyobs.fit.mfit.eval">eval() (pyobs.fit.mfit method)</a>
130+
<li><a href="pyobs.vwerr.html#pyobs.vwerr.errinfo">errinfo (class in pyobs.vwerr)</a>
131131
</li>
132132
</ul></td>
133133
<td style="width: 33%; vertical-align: top;"><ul>
134+
<li><a href="pyobs.fit.html#pyobs.fit.mfit.eval">eval() (pyobs.fit.mfit method)</a>
135+
</li>
134136
<li><a href="pyobs.fit.html#pyobs.fit.mfit.eval_obs">eval_obs() (pyobs.fit.mfit method)</a>
135137
</li>
136138
<li><a href="mathfuncs.html#pyobs.observa.exp">exp() (in module pyobs.observa)</a>
@@ -274,7 +276,7 @@ <h3>Navigation</h3>
274276
</div>
275277
<div class="footer" role="contentinfo">
276278
&#169; Copyright 2018, Mattia Bruno.
277-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
279+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
278280
</div>
279281
</body>
280282
</html>

‎docs/getstarted.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ <h3>Navigation</h3>
314314
</div>
315315
<div class="footer" role="contentinfo">
316316
&#169; Copyright 2018, Mattia Bruno.
317-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
317+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
318318
</div>
319319
</body>
320320
</html>

‎docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ <h3>Navigation</h3>
157157
</div>
158158
<div class="footer" role="contentinfo">
159159
&#169; Copyright 2018, Mattia Bruno.
160-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
160+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
161161
</div>
162162
</body>
163163
</html>

‎docs/intro.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ <h3>Navigation</h3>
225225
</div>
226226
<div class="footer" role="contentinfo">
227227
&#169; Copyright 2018, Mattia Bruno.
228-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
228+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
229229
</div>
230230
</body>
231231
</html>

‎docs/mathfuncs.html

+24-1
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,29 @@ <h2>matrix functions<a class="headerlink" href="#matrix-functions" title="Permal
253253
</table>
254254
</dd></dl>
255255

256+
<dl class="function">
257+
<dt id="pyobs.observa.eig">
258+
<code class="descclassname">pyobs.observa.</code><code class="descname">eig</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#pyobs.observa.eig" title="Permalink to this definition"></a></dt>
259+
<dd><p>Compute the eigenvalues and eigenvectors of a square symmetric matrix</p>
260+
<table class="docutils field-list" frame="void" rules="none">
261+
<col class="field-name" />
262+
<col class="field-body" />
263+
<tbody valign="top">
264+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> (<a class="reference internal" href="pyobs.observa.html#pyobs.observa.observa" title="pyobs.observa.observa"><em>observa</em></a>) – must be a square matrix</td>
265+
</tr>
266+
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>w, v</strong> – the eigenvalues and a matrix whose columns
267+
correspond to the eigenvectors</td>
268+
</tr>
269+
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="pyobs.observa.html#pyobs.observa.observa" title="pyobs.observa.observa">observa</a></td>
270+
</tr>
271+
</tbody>
272+
</table>
273+
<p class="rubric">Examples</p>
274+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="p">[</span><span class="n">w</span><span class="p">,</span> <span class="n">v</span><span class="p">]</span> <span class="o">=</span> <span class="n">eig</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
275+
</pre></div>
276+
</div>
277+
</dd></dl>
278+
256279
</div>
257280
<div class="section" id="manipulation-of-observables">
258281
<h2>Manipulation of observables<a class="headerlink" href="#manipulation-of-observables" title="Permalink to this headline"></a></h2>
@@ -303,7 +326,7 @@ <h3>Navigation</h3>
303326
</div>
304327
<div class="footer" role="contentinfo">
305328
&#169; Copyright 2018, Mattia Bruno.
306-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
329+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
307330
</div>
308331
</body>
309332
</html>

‎docs/objects.inv

3 Bytes
Binary file not shown.

‎docs/py-modindex.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ <h3>Navigation</h3>
104104
</div>
105105
<div class="footer" role="contentinfo">
106106
&#169; Copyright 2018, Mattia Bruno.
107-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
107+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
108108
</div>
109109
</body>
110110
</html>

‎docs/pyobs.fit.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ <h3>Navigation</h3>
263263
</div>
264264
<div class="footer" role="contentinfo">
265265
&#169; Copyright 2018, Mattia Bruno.
266-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
266+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
267267
</div>
268268
</body>
269269
</html>

‎docs/pyobs.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ <h3>Navigation</h3>
127127
</div>
128128
<div class="footer" role="contentinfo">
129129
&#169; Copyright 2018, Mattia Bruno.
130-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
130+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
131131
</div>
132132
</body>
133133
</html>

‎docs/pyobs.observa.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ <h3>Navigation</h3>
405405
</div>
406406
<div class="footer" role="contentinfo">
407407
&#169; Copyright 2018, Mattia Bruno.
408-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
408+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
409409
</div>
410410
</body>
411411
</html>

‎docs/pyobs.vwerr.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ <h3>Navigation</h3>
145145
</div>
146146
<div class="footer" role="contentinfo">
147147
&#169; Copyright 2018, Mattia Bruno.
148-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
148+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
149149
</div>
150150
</body>
151151
</html>

‎docs/search.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h3>Navigation</h3>
9797
</div>
9898
<div class="footer" role="contentinfo">
9999
&#169; Copyright 2018, Mattia Bruno.
100-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
100+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
101101
</div>
102102
</body>
103103
</html>

‎docs/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/tips.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ <h3>Navigation</h3>
101101
</div>
102102
<div class="footer" role="contentinfo">
103103
&#169; Copyright 2018, Mattia Bruno.
104-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
104+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
105105
</div>
106106
</body>
107107
</html>

‎docs/tutorials.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ <h3>Navigation</h3>
124124
</div>
125125
<div class="footer" role="contentinfo">
126126
&#169; Copyright 2018, Mattia Bruno.
127-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
127+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
128128
</div>
129129
</body>
130130
</html>

0 commit comments

Comments
 (0)
Please sign in to comment.