lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-05-16 12:33:41 +02:00
Code Issues Projects Releases Packages Wiki Activity

Documentation updated

Browse source
This commit is contained in:
fjosw 2021-11-15 11:14:13 +00:00
parent 7925663814
commit 22d528cd9c
5 changed files with 38 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

42
docs/pyerrors/correlators.html
View file

@ -211,7 +211,7 @@
<span class="sd"> Everything, this class does, can be achieved using lists or arrays of Obs.</span>
<span class="sd"> But it is simply more convenient to have a dedicated object for correlators.</span>
<span class="sd"> One often wants to add or multiply correlators of the same length at every timeslice and it is inconvinient</span>
<span class="sd"> One often wants to add or multiply correlators of the same length at every timeslice and it is inconvenient</span>
<span class="sd"> to iterate over all timeslices for every operation. This is especially true, when dealing with smearing matrices.</span>
<span class="sd"> The correlator can have two types of content: An Obs at every timeslice OR a GEVP</span>
@ -514,7 +514,7 @@
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> symmetric : bool</span>
<span class="sd"> decides whether symmertic of simple finite differences are used. Default: True</span>
<span class="sd"> decides whether symmetric of simple finite differences are used. Default: True</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">symmetric</span><span class="p">:</span>
<span class="n">newcontent</span> <span class="o">=</span> <span class="p">[]</span>
@ -612,7 +612,7 @@
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">arccosh</span><span class="p">(</span><span class="n">Corr</span><span class="p">(</span><span class="n">newcontent</span><span class="p">,</span> <span class="n">padding_back</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">padding_front</span><span class="o">=</span><span class="mi">1</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Unkown variant.&#39;</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Unknown variant.&#39;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">fit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">function</span><span class="p">,</span> <span class="n">fitrange</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">silent</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Fits function to the data</span>
@ -630,7 +630,7 @@
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">N</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Correlator must be projected before fitting&quot;</span><span class="p">)</span>
<span class="c1"># The default behaviour is:</span>
<span class="c1"># The default behavior is:</span>
<span class="c1"># 1 use explicit fitrange</span>
<span class="c1"># if none is provided, use the range of the corr</span>
<span class="c1"># if this is also not set, use the whole length of the corr (This could come with a warning!)</span>
@ -648,7 +648,7 @@
<span class="k">return</span> <span class="n">result</span>
<span class="k">def</span> <span class="nf">plateau</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plateau_range</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s2">&quot;fit&quot;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; Extract a plateu value from a Corr object</span>
<span class="sd">&quot;&quot;&quot; Extract a plateau value from a Corr object</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
@ -779,7 +779,7 @@
<span class="k">return</span>
<span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Dumps the Corr into a pickel file</span>
<span class="sd">&quot;&quot;&quot;Dumps the Corr into a pickle file</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
@ -1019,7 +1019,7 @@
<span class="sd"> Everything, this class does, can be achieved using lists or arrays of Obs.</span>
<span class="sd"> But it is simply more convenient to have a dedicated object for correlators.</span>
<span class="sd"> One often wants to add or multiply correlators of the same length at every timeslice and it is inconvinient</span>
<span class="sd"> One often wants to add or multiply correlators of the same length at every timeslice and it is inconvenient</span>
<span class="sd"> to iterate over all timeslices for every operation. This is especially true, when dealing with smearing matrices.</span>
<span class="sd"> The correlator can have two types of content: An Obs at every timeslice OR a GEVP</span>
@ -1322,7 +1322,7 @@
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> symmetric : bool</span>
<span class="sd"> decides whether symmertic of simple finite differences are used. Default: True</span>
<span class="sd"> decides whether symmetric of simple finite differences are used. Default: True</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">symmetric</span><span class="p">:</span>
<span class="n">newcontent</span> <span class="o">=</span> <span class="p">[]</span>
@ -1420,7 +1420,7 @@
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">arccosh</span><span class="p">(</span><span class="n">Corr</span><span class="p">(</span><span class="n">newcontent</span><span class="p">,</span> <span class="n">padding_back</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">padding_front</span><span class="o">=</span><span class="mi">1</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Unkown variant.&#39;</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Unknown variant.&#39;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">fit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">function</span><span class="p">,</span> <span class="n">fitrange</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">silent</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Fits function to the data</span>
@ -1438,7 +1438,7 @@
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">N</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Correlator must be projected before fitting&quot;</span><span class="p">)</span>
<span class="c1"># The default behaviour is:</span>
<span class="c1"># The default behavior is:</span>
<span class="c1"># 1 use explicit fitrange</span>
<span class="c1"># if none is provided, use the range of the corr</span>
<span class="c1"># if this is also not set, use the whole length of the corr (This could come with a warning!)</span>
@ -1456,7 +1456,7 @@
<span class="k">return</span> <span class="n">result</span>
<span class="k">def</span> <span class="nf">plateau</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plateau_range</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s2">&quot;fit&quot;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; Extract a plateu value from a Corr object</span>
<span class="sd">&quot;&quot;&quot; Extract a plateau value from a Corr object</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
@ -1587,7 +1587,7 @@
<span class="k">return</span>
<span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Dumps the Corr into a pickel file</span>
<span class="sd">&quot;&quot;&quot;Dumps the Corr into a pickle file</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
@ -1814,7 +1814,7 @@
<p>Everything, this class does, can be achieved using lists or arrays of Obs.
But it is simply more convenient to have a dedicated object for correlators.
One often wants to add or multiply correlators of the same length at every timeslice and it is inconvinient
One often wants to add or multiply correlators of the same length at every timeslice and it is inconvenient
to iterate over all timeslices for every operation. This is especially true, when dealing with smearing matrices.</p>
<p>The correlator can have two types of content: An Obs at every timeslice OR a GEVP
@ -2420,7 +2420,7 @@ Parity quantum number of the correlator, can be +1 or -1</li>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> symmetric : bool</span>
<span class="sd"> decides whether symmertic of simple finite differences are used. Default: True</span>
<span class="sd"> decides whether symmetric of simple finite differences are used. Default: True</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">symmetric</span><span class="p">:</span>
<span class="n">newcontent</span> <span class="o">=</span> <span class="p">[]</span>
@ -2452,7 +2452,7 @@ Parity quantum number of the correlator, can be +1 or -1</li>
<ul>
<li><strong>symmetric</strong> (bool):
decides whether symmertic of simple finite differences are used. Default: True</li>
decides whether symmetric of simple finite differences are used. Default: True</li>
</ul>
</div>
@ -2561,7 +2561,7 @@ decides whether symmertic of simple finite differences are used. Default: True</
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">arccosh</span><span class="p">(</span><span class="n">Corr</span><span class="p">(</span><span class="n">newcontent</span><span class="p">,</span> <span class="n">padding_back</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">padding_front</span><span class="o">=</span><span class="mi">1</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Unkown variant.&#39;</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Unknown variant.&#39;</span><span class="p">)</span>
</pre></div>
</details>
@ -2610,7 +2610,7 @@ guess for the root finder, only relevant for the root variant</li>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">N</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Correlator must be projected before fitting&quot;</span><span class="p">)</span>
<span class="c1"># The default behaviour is:</span>
<span class="c1"># The default behavior is:</span>
<span class="c1"># 1 use explicit fitrange</span>
<span class="c1"># if none is provided, use the range of the corr</span>
<span class="c1"># if this is also not set, use the whole length of the corr (This could come with a warning!)</span>
@ -2658,7 +2658,7 @@ Decides whether output is printed to the standard output.</li>
<details>
<summary>View Source</summary>
<div class="codehilite"><pre><span></span> <span class="k">def</span> <span class="nf">plateau</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plateau_range</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s2">&quot;fit&quot;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; Extract a plateu value from a Corr object</span>
<span class="sd">&quot;&quot;&quot; Extract a plateau value from a Corr object</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
@ -2694,7 +2694,7 @@ Decides whether output is printed to the standard output.</li>
</details>
<div class="docstring"><p>Extract a plateu value from a Corr object</p>
<div class="docstring"><p>Extract a plateau value from a Corr object</p>
<h6 id="parameters">Parameters</h6>
@ -2884,7 +2884,7 @@ path to file in which the figure should be saved</li>
<details>
<summary>View Source</summary>
<div class="codehilite"><pre><span></span> <span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Dumps the Corr into a pickel file</span>
<span class="sd">&quot;&quot;&quot;Dumps the Corr into a pickle file</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
@ -2897,7 +2897,7 @@ path to file in which the figure should be saved</li>
</details>
<div class="docstring"><p>Dumps the Corr into a pickel file</p>
<div class="docstring"><p>Dumps the Corr into a pickle file</p>
<h6 id="parameters">Parameters</h6>

8
docs/pyerrors/fits.html
View file

@ -137,7 +137,7 @@
<span class="sd"> ----------</span>
<span class="sd"> fit_parameters : list</span>
<span class="sd"> results for the individual fit parameters,</span>
<span class="sd"> also accesible via indices.</span>
<span class="sd"> also accessible via indices.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
@ -543,7 +543,7 @@
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;x and y input have to have the same length&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Unkown format for x values&#39;</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Unknown format for x values&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">callable</span><span class="p">(</span><span class="n">func</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;func has to be a function.&#39;</span><span class="p">)</span>
@ -943,7 +943,7 @@
<span class="sd"> ----------</span>
<span class="sd"> fit_parameters : list</span>
<span class="sd"> results for the individual fit parameters,</span>
<span class="sd"> also accesible via indices.</span>
<span class="sd"> also accessible via indices.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
@ -987,7 +987,7 @@
<ul>
<li><strong>fit_parameters</strong> (list):
results for the individual fit parameters,
also accesible via indices.</li>
also accessible via indices.</li>
</ul>
</div>

6
docs/pyerrors/linalg.html
View file

@ -276,7 +276,7 @@
<span class="k">def</span> <span class="nf">cholesky</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Cholesky decompostion of Obs or CObs valued matrices.&quot;&quot;&quot;</span>
<span class="sd">&quot;&quot;&quot;Cholesky decomposition of Obs or CObs valued matrices.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">_mat_mat_op</span><span class="p">(</span><span class="n">anp</span><span class="o">.</span><span class="n">linalg</span><span class="o">.</span><span class="n">cholesky</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
@ -901,13 +901,13 @@ standard multiplication via the @ operator.</p>
<details>
<summary>View Source</summary>
<div class="codehilite"><pre><span></span><span class="k">def</span> <span class="nf">cholesky</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Cholesky decompostion of Obs or CObs valued matrices.&quot;&quot;&quot;</span>
<span class="sd">&quot;&quot;&quot;Cholesky decomposition of Obs or CObs valued matrices.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">_mat_mat_op</span><span class="p">(</span><span class="n">anp</span><span class="o">.</span><span class="n">linalg</span><span class="o">.</span><span class="n">cholesky</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
</pre></div>
</details>
<div class="docstring"><p>Cholesky decompostion of Obs or CObs valued matrices.</p>
<div class="docstring"><p>Cholesky decomposition of Obs or CObs valued matrices.</p>
</div>

18
docs/pyerrors/obs.html
View file

@ -373,7 +373,7 @@
<span class="sd"> samples : list</span>
<span class="sd"> list of numpy arrays containing the Monte Carlo samples</span>
<span class="sd"> names : list</span>
<span class="sd"> list of strings labeling the indivdual samples</span>
<span class="sd"> list of strings labeling the individual samples</span>
<span class="sd"> idl : list, optional</span>
<span class="sd"> list of ranges or lists on which the samples are defined</span>
<span class="sd"> means : list, optional</span>
@ -628,9 +628,9 @@
<span class="sd"> deltas : list</span>
<span class="sd"> List of fluctuations</span>
<span class="sd"> idx : list</span>
<span class="sd"> List or range of configs on which the deltas are defined.</span>
<span class="sd"> List or range of configurations on which the deltas are defined.</span>
<span class="sd"> shape : int</span>
<span class="sd"> Number of configs in idx.</span>
<span class="sd"> Number of configurations in idx.</span>
<span class="sd"> w_max : int</span>
<span class="sd"> Upper bound for the summation window.</span>
<span class="sd"> fft : bool</span>
@ -1423,7 +1423,7 @@
<span class="sd"> Has to be a subset of idx_old.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">len</span><span class="p">(</span><span class="n">deltas</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">idx_old</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Lenght of deltas and idx_old have to be the same: </span><span class="si">%d</span><span class="s1"> != </span><span class="si">%d</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">deltas</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="n">idx_old</span><span class="p">)))</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Length of deltas and idx_old have to be the same: </span><span class="si">%d</span><span class="s1"> != </span><span class="si">%d</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">deltas</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="n">idx_old</span><span class="p">)))</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">idx_old</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">range</span> <span class="ow">and</span> <span class="nb">type</span><span class="p">(</span><span class="n">idx_new</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">range</span><span class="p">:</span>
<span class="k">if</span> <span class="n">idx_old</span> <span class="o">==</span> <span class="n">idx_new</span><span class="p">:</span>
<span class="k">return</span> <span class="n">deltas</span>
@ -1927,7 +1927,7 @@
<span class="sd"> samples : list</span>
<span class="sd"> list of numpy arrays containing the Monte Carlo samples</span>
<span class="sd"> names : list</span>
<span class="sd"> list of strings labeling the indivdual samples</span>
<span class="sd"> list of strings labeling the individual samples</span>
<span class="sd"> idl : list, optional</span>
<span class="sd"> list of ranges or lists on which the samples are defined</span>
<span class="sd"> means : list, optional</span>
@ -2182,9 +2182,9 @@
<span class="sd"> deltas : list</span>
<span class="sd"> List of fluctuations</span>
<span class="sd"> idx : list</span>
<span class="sd"> List or range of configs on which the deltas are defined.</span>
<span class="sd"> List or range of configurations on which the deltas are defined.</span>
<span class="sd"> shape : int</span>
<span class="sd"> Number of configs in idx.</span>
<span class="sd"> Number of configurations in idx.</span>
<span class="sd"> w_max : int</span>
<span class="sd"> Upper bound for the summation window.</span>
<span class="sd"> fft : bool</span>
@ -2649,7 +2649,7 @@ this overwrites the standard value for that ensemble.</li>
<span class="sd"> samples : list</span>
<span class="sd"> list of numpy arrays containing the Monte Carlo samples</span>
<span class="sd"> names : list</span>
<span class="sd"> list of strings labeling the indivdual samples</span>
<span class="sd"> list of strings labeling the individual samples</span>
<span class="sd"> idl : list, optional</span>
<span class="sd"> list of ranges or lists on which the samples are defined</span>
<span class="sd"> means : list, optional</span>
@ -2734,7 +2734,7 @@ this overwrites the standard value for that ensemble.</li>
<li><strong>samples</strong> (list):
list of numpy arrays containing the Monte Carlo samples</li>
<li><strong>names</strong> (list):
list of strings labeling the indivdual samples</li>
list of strings labeling the individual samples</li>
<li><strong>idl</strong> (list, optional):
list of ranges or lists on which the samples are defined</li>
<li><strong>means</strong> (list, optional):

2
docs/search.js
View file

File diff suppressed because one or more lines are too long