lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-03-20 01:00:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

Documentation updated

Browse source
This commit is contained in:
fjosw 2022-02-22 21:34:28 +00:00
parent 3375349884
commit 7200e7344d
2 changed files with 80 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

86
docs/pyerrors/correlators.html
View file

@ -461,9 +461,9 @@
<span class="sd"> The state one is interested in ordered by energy. The lowest state is zero.</span>
<span class="sd"> sorted_list : string</span>
<span class="sd"> if this argument is set, a list of vectors (len=self.T) is returned. If it is left as None, only one vector is returned.</span>
<span class="sd"> &quot;Eigenvalue&quot; - The eigenvector is chosen according to which einvenvalue it belongs individually on every timeslice.</span>
<span class="sd"> &quot;Eigenvalue&quot; - The eigenvector is chosen according to which eigenvalue it belongs individually on every timeslice.</span>
<span class="sd"> &quot;Eigenvector&quot; - Use the method described in arXiv:2004.10472 [hep-lat] to find the set of v(t) belonging to the state.</span>
<span class="sd"> The referense state is identified by its eigenvalue at t=ts</span>
<span class="sd"> The reference state is identified by its eigenvalue at t=ts</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">sorted_list</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="p">(</span><span class="n">ts</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">):</span>
@ -508,6 +508,23 @@
<span class="k">return</span> <span class="n">all_vecs</span>
<span class="k">def</span> <span class="nf">Eigenvalue</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">t0</span><span class="p">,</span> <span class="n">ts</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">sorted_list</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Determines the eigenvalue of the GEVP by solving and projecting the correlator</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> t0 : int</span>
<span class="sd"> The time t0 for G(t)v= lambda G(t_0)v</span>
<span class="sd"> ts : int</span>
<span class="sd"> fixed time G(t_s)v= lambda G(t_0)v if return_list=False</span>
<span class="sd"> If return_list=True and sorting=Eigenvector it gives a reference point for the sorting method.</span>
<span class="sd"> state : int</span>
<span class="sd"> The state one is interested in ordered by energy. The lowest state is zero.</span>
<span class="sd"> sorted_list : string</span>
<span class="sd"> if this argument is set, a list of vectors (len=self.T) is returned. If it is left as None, only one vector is returned.</span>
<span class="sd"> &quot;Eigenvalue&quot; - The eigenvector is chosen according to which eigenvalue it belongs individually on every timeslice.</span>
<span class="sd"> &quot;Eigenvector&quot; - Use the method described in arXiv:2004.10472 [hep-lat] to find the set of v(t) belonging to the state.</span>
<span class="sd"> The reference state is identified by its eigenvalue at t=ts</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">vec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">GEVP</span><span class="p">(</span><span class="n">t0</span><span class="p">,</span> <span class="n">ts</span><span class="o">=</span><span class="n">ts</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="n">state</span><span class="p">,</span> <span class="n">sorted_list</span><span class="o">=</span><span class="n">sorted_list</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">projected</span><span class="p">(</span><span class="n">vec</span><span class="p">)</span>
@ -1552,9 +1569,9 @@
<span class="sd"> The state one is interested in ordered by energy. The lowest state is zero.</span>
<span class="sd"> sorted_list : string</span>
<span class="sd"> if this argument is set, a list of vectors (len=self.T) is returned. If it is left as None, only one vector is returned.</span>
<span class="sd"> &quot;Eigenvalue&quot; - The eigenvector is chosen according to which einvenvalue it belongs individually on every timeslice.</span>
<span class="sd"> &quot;Eigenvalue&quot; - The eigenvector is chosen according to which eigenvalue it belongs individually on every timeslice.</span>
<span class="sd"> &quot;Eigenvector&quot; - Use the method described in arXiv:2004.10472 [hep-lat] to find the set of v(t) belonging to the state.</span>
<span class="sd"> The referense state is identified by its eigenvalue at t=ts</span>
<span class="sd"> The reference state is identified by its eigenvalue at t=ts</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">sorted_list</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="p">(</span><span class="n">ts</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">):</span>
@ -1599,6 +1616,23 @@
<span class="k">return</span> <span class="n">all_vecs</span>
<span class="k">def</span> <span class="nf">Eigenvalue</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">t0</span><span class="p">,</span> <span class="n">ts</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">sorted_list</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Determines the eigenvalue of the GEVP by solving and projecting the correlator</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> t0 : int</span>
<span class="sd"> The time t0 for G(t)v= lambda G(t_0)v</span>
<span class="sd"> ts : int</span>
<span class="sd"> fixed time G(t_s)v= lambda G(t_0)v if return_list=False</span>
<span class="sd"> If return_list=True and sorting=Eigenvector it gives a reference point for the sorting method.</span>
<span class="sd"> state : int</span>
<span class="sd"> The state one is interested in ordered by energy. The lowest state is zero.</span>
<span class="sd"> sorted_list : string</span>
<span class="sd"> if this argument is set, a list of vectors (len=self.T) is returned. If it is left as None, only one vector is returned.</span>
<span class="sd"> &quot;Eigenvalue&quot; - The eigenvector is chosen according to which eigenvalue it belongs individually on every timeslice.</span>
<span class="sd"> &quot;Eigenvector&quot; - Use the method described in arXiv:2004.10472 [hep-lat] to find the set of v(t) belonging to the state.</span>
<span class="sd"> The reference state is identified by its eigenvalue at t=ts</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">vec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">GEVP</span><span class="p">(</span><span class="n">t0</span><span class="p">,</span> <span class="n">ts</span><span class="o">=</span><span class="n">ts</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="n">state</span><span class="p">,</span> <span class="n">sorted_list</span><span class="o">=</span><span class="n">sorted_list</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">projected</span><span class="p">(</span><span class="n">vec</span><span class="p">)</span>
@ -2770,9 +2804,9 @@ timeslice and the error on each timeslice.</p>
<span class="sd"> The state one is interested in ordered by energy. The lowest state is zero.</span>
<span class="sd"> sorted_list : string</span>
<span class="sd"> if this argument is set, a list of vectors (len=self.T) is returned. If it is left as None, only one vector is returned.</span>
<span class="sd"> &quot;Eigenvalue&quot; - The eigenvector is chosen according to which einvenvalue it belongs individually on every timeslice.</span>
<span class="sd"> &quot;Eigenvalue&quot; - The eigenvector is chosen according to which eigenvalue it belongs individually on every timeslice.</span>
<span class="sd"> &quot;Eigenvector&quot; - Use the method described in arXiv:2004.10472 [hep-lat] to find the set of v(t) belonging to the state.</span>
<span class="sd"> The referense state is identified by its eigenvalue at t=ts</span>
<span class="sd"> The reference state is identified by its eigenvalue at t=ts</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">sorted_list</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="p">(</span><span class="n">ts</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">):</span>
@ -2833,9 +2867,9 @@ If return_list=True and sorting=Eigenvector it gives a reference point for the s
The state one is interested in ordered by energy. The lowest state is zero.</li>
<li><strong>sorted_list</strong> (string):
if this argument is set, a list of vectors (len=self.T) is returned. If it is left as None, only one vector is returned.
"Eigenvalue" - The eigenvector is chosen according to which einvenvalue it belongs individually on every timeslice.
"Eigenvalue" - The eigenvector is chosen according to which eigenvalue it belongs individually on every timeslice.
"Eigenvector" - Use the method described in arXiv:2004.10472 [hep-lat] to find the set of v(t) belonging to the state.
The referense state is identified by its eigenvalue at t=ts</li>
The reference state is identified by its eigenvalue at t=ts</li>
</ul>
</div>
@ -2852,12 +2886,48 @@ if this argument is set, a list of vectors (len=self.T) is returned. If it is le
<details>
<summary>View Source</summary>
<div class="pdoc-code codehilite"><pre><span></span> <span class="k">def</span> <span class="nf">Eigenvalue</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">t0</span><span class="p">,</span> <span class="n">ts</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">sorted_list</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Determines the eigenvalue of the GEVP by solving and projecting the correlator</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> t0 : int</span>
<span class="sd"> The time t0 for G(t)v= lambda G(t_0)v</span>
<span class="sd"> ts : int</span>
<span class="sd"> fixed time G(t_s)v= lambda G(t_0)v if return_list=False</span>
<span class="sd"> If return_list=True and sorting=Eigenvector it gives a reference point for the sorting method.</span>
<span class="sd"> state : int</span>
<span class="sd"> The state one is interested in ordered by energy. The lowest state is zero.</span>
<span class="sd"> sorted_list : string</span>
<span class="sd"> if this argument is set, a list of vectors (len=self.T) is returned. If it is left as None, only one vector is returned.</span>
<span class="sd"> &quot;Eigenvalue&quot; - The eigenvector is chosen according to which eigenvalue it belongs individually on every timeslice.</span>
<span class="sd"> &quot;Eigenvector&quot; - Use the method described in arXiv:2004.10472 [hep-lat] to find the set of v(t) belonging to the state.</span>
<span class="sd"> The reference state is identified by its eigenvalue at t=ts</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">vec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">GEVP</span><span class="p">(</span><span class="n">t0</span><span class="p">,</span> <span class="n">ts</span><span class="o">=</span><span class="n">ts</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="n">state</span><span class="p">,</span> <span class="n">sorted_list</span><span class="o">=</span><span class="n">sorted_list</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">projected</span><span class="p">(</span><span class="n">vec</span><span class="p">)</span>
</pre></div>
</details>
<div class="docstring"><p>Determines the eigenvalue of the GEVP by solving and projecting the correlator</p>
<h6 id="parameters">Parameters</h6>
<ul>
<li><strong>t0</strong> (int):
The time t0 for G(t)v= lambda G(t_0)v</li>
<li><strong>ts</strong> (int):
fixed time G(t_s)v= lambda G(t_0)v if return_list=False
If return_list=True and sorting=Eigenvector it gives a reference point for the sorting method.</li>
<li><strong>state</strong> (int):
The state one is interested in ordered by energy. The lowest state is zero.</li>
<li><strong>sorted_list</strong> (string):
if this argument is set, a list of vectors (len=self.T) is returned. If it is left as None, only one vector is returned.
"Eigenvalue" - The eigenvector is chosen according to which eigenvalue it belongs individually on every timeslice.
"Eigenvector" - Use the method described in arXiv:2004.10472 [hep-lat] to find the set of v(t) belonging to the state.
The reference state is identified by its eigenvalue at t=ts</li>
</ul>
</div>
</div>

2
docs/search.js
View file

File diff suppressed because one or more lines are too long