docs merged from develop

mbruno46 · Sep 15, 2020 · c0c2604 · c0c2604
1 parent 50fc081
commit c0c2604
Show file tree

Hide file tree

Showing 27 changed files with 53 additions and 28 deletions.
diff --git a/docs/_sources/mathfuncs.rst.txt b/docs/_sources/mathfuncs.rst.txt
@@ -74,7 +74,7 @@ The following functions can be imported using::
    >>> from pyobs import det, inv
 
 .. automodule:: pyobs.observa
-   :members: det, trace, inv
+   :members: det, trace, inv, eig
 
 
 Manipulation of observables

diff --git a/docs/_static/basic.css b/docs/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js
@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for all documentation.
  *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/docs/_static/language_data.js b/docs/_static/language_data.js
@@ -5,7 +5,7 @@
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
  *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js
@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for the full-text search.
  *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/docs/_static/sphinxdoc.css b/docs/_static/sphinxdoc.css
@@ -5,7 +5,7 @@
  * Sphinx stylesheet -- sphinxdoc theme.  Originally created by
  * Armin Ronacher for Werkzeug.
  *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/docs/_static/websupport.js b/docs/_static/websupport.js
@@ -4,7 +4,7 @@
  *
  * sphinx.websupport utilities for all documentation.
  *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/docs/basics.html b/docs/basics.html
@@ -165,7 +165,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/eigen.html b/docs/eigen.html
@@ -102,7 +102,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/error.html b/docs/error.html
@@ -264,7 +264,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/first.html b/docs/first.html
@@ -153,7 +153,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/fitting.html b/docs/fitting.html
@@ -321,7 +321,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -125,12 +125,14 @@ <h2 id="D">D</h2>
 <h2 id="E">E</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pyobs.vwerr.html#pyobs.vwerr.errinfo">errinfo (class in pyobs.vwerr)</a>
+      <li><a href="mathfuncs.html#pyobs.observa.eig">eig() (in module pyobs.observa)</a>
 </li>
-      <li><a href="pyobs.fit.html#pyobs.fit.mfit.eval">eval() (pyobs.fit.mfit method)</a>
+      <li><a href="pyobs.vwerr.html#pyobs.vwerr.errinfo">errinfo (class in pyobs.vwerr)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="pyobs.fit.html#pyobs.fit.mfit.eval">eval() (pyobs.fit.mfit method)</a>
+</li>
       <li><a href="pyobs.fit.html#pyobs.fit.mfit.eval_obs">eval_obs() (pyobs.fit.mfit method)</a>
 </li>
       <li><a href="mathfuncs.html#pyobs.observa.exp">exp() (in module pyobs.observa)</a>
@@ -274,7 +276,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/getstarted.html b/docs/getstarted.html
@@ -314,7 +314,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/index.html b/docs/index.html
@@ -157,7 +157,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/intro.html b/docs/intro.html
@@ -225,7 +225,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/mathfuncs.html b/docs/mathfuncs.html
@@ -253,6 +253,29 @@ <h2>matrix functions<a class="headerlink" href="#matrix-functions" title="Permal
 </table>
 </dd></dl>
 
+<dl class="function">
+<dt id="pyobs.observa.eig">
+<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>
+<dd><p>Compute the eigenvalues and eigenvectors of a square symmetric matrix</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<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
+correspond to the eigenvectors</td>
+</tr>
+<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>
+</tr>
+</tbody>
+</table>
+<p class="rubric">Examples</p>
+<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>
+</pre></div>
+</div>
+</dd></dl>
+
 </div>
 <div class="section" id="manipulation-of-observables">
 <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>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -104,7 +104,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/pyobs.fit.html b/docs/pyobs.fit.html
@@ -263,7 +263,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/pyobs.html b/docs/pyobs.html
@@ -127,7 +127,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/pyobs.observa.html b/docs/pyobs.observa.html
@@ -405,7 +405,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/pyobs.vwerr.html b/docs/pyobs.vwerr.html
@@ -145,7 +145,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>
diff --git a/docs/search.html b/docs/search.html
@@ -97,7 +97,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2018, Mattia Bruno.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>