Documentation updated

This commit is contained in:
fjosw 2022-05-03 09:28:32 +00:00
parent b14474be35
commit 2c0fac9b9f
2 changed files with 12 additions and 12 deletions

View file

@ -453,7 +453,7 @@
</span><span id="L-240"><a href="#L-240"><span class="linenos"> 240</span></a> <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><span id="L-241"><a href="#L-241"><span class="linenos"> 241</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Trying to symmetrize a correlator matrix, that already has N=1.&quot;</span><span class="p">)</span>
</span><span id="L-242"><a href="#L-242"><span class="linenos"> 242</span></a>
</span><span id="L-243"><a href="#L-243"><span class="linenos"> 243</span></a> <span class="k">def</span> <span class="nf">GEVP</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><span id="L-243"><a href="#L-243"><span class="linenos"> 243</span></a> <span class="k">def</span> <span class="nf">GEVP</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="s2">&quot;Eigenvalue&quot;</span><span class="p">):</span>
</span><span id="L-244"><a href="#L-244"><span class="linenos"> 244</span></a> <span class="sd">&quot;&quot;&quot;Solve the general eigenvalue problem on the current correlator</span>
</span><span id="L-245"><a href="#L-245"><span class="linenos"> 245</span></a>
</span><span id="L-246"><a href="#L-246"><span class="linenos"> 246</span></a><span class="sd"> Parameters</span>
@ -464,7 +464,7 @@
</span><span id="L-251"><a href="#L-251"><span class="linenos"> 251</span></a><span class="sd"> fixed time G(t_s)v= lambda G(t_0)v if return_list=False</span>
</span><span id="L-252"><a href="#L-252"><span class="linenos"> 252</span></a><span class="sd"> If return_list=True and sorting=Eigenvector it gives a reference point for the sorting method.</span>
</span><span id="L-253"><a href="#L-253"><span class="linenos"> 253</span></a><span class="sd"> state : int</span>
</span><span id="L-254"><a href="#L-254"><span class="linenos"> 254</span></a><span class="sd"> The state one is interested in ordered by energy. The lowest state is zero.</span>
</span><span id="L-254"><a href="#L-254"><span class="linenos"> 254</span></a><span class="sd"> The state one is interested in, ordered by energy. The lowest state is zero.</span>
</span><span id="L-255"><a href="#L-255"><span class="linenos"> 255</span></a><span class="sd"> sorted_list : string</span>
</span><span id="L-256"><a href="#L-256"><span class="linenos"> 256</span></a><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><span id="L-257"><a href="#L-257"><span class="linenos"> 257</span></a><span class="sd"> &quot;Eigenvalue&quot; - The eigenvector is chosen according to which eigenvalue it belongs individually on every timeslice.</span>
@ -1382,7 +1382,7 @@
</span><span id="L-1169"><a href="#L-1169"><span class="linenos">1169</span></a>
</span><span id="L-1170"><a href="#L-1170"><span class="linenos">1170</span></a> <span class="n">evecs</span> <span class="o">=</span> <span class="p">[]</span>
</span><span id="L-1171"><a href="#L-1171"><span class="linenos">1171</span></a> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">Ntrunc</span><span class="p">):</span>
</span><span id="L-1172"><a href="#L-1172"><span class="linenos">1172</span></a> <span class="n">evecs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">basematrix</span><span class="o">.</span><span class="n">GEVP</span><span class="p">(</span><span class="n">t0proj</span><span class="p">,</span> <span class="n">tproj</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="n">i</span><span class="p">))</span>
</span><span id="L-1172"><a href="#L-1172"><span class="linenos">1172</span></a> <span class="n">evecs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">basematrix</span><span class="o">.</span><span class="n">GEVP</span><span class="p">(</span><span class="n">t0proj</span><span class="p">,</span> <span class="n">tproj</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="n">i</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><span id="L-1173"><a href="#L-1173"><span class="linenos">1173</span></a>
</span><span id="L-1174"><a href="#L-1174"><span class="linenos">1174</span></a> <span class="n">tmpmat</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">empty</span><span class="p">((</span><span class="n">Ntrunc</span><span class="p">,</span> <span class="n">Ntrunc</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">object</span><span class="p">)</span>
</span><span id="L-1175"><a href="#L-1175"><span class="linenos">1175</span></a> <span class="n">rmat</span> <span class="o">=</span> <span class="p">[]</span>
@ -1675,7 +1675,7 @@
</span><span id="Corr-241"><a href="#Corr-241"><span class="linenos"> 241</span></a> <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><span id="Corr-242"><a href="#Corr-242"><span class="linenos"> 242</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Trying to symmetrize a correlator matrix, that already has N=1.&quot;</span><span class="p">)</span>
</span><span id="Corr-243"><a href="#Corr-243"><span class="linenos"> 243</span></a>
</span><span id="Corr-244"><a href="#Corr-244"><span class="linenos"> 244</span></a> <span class="k">def</span> <span class="nf">GEVP</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><span id="Corr-244"><a href="#Corr-244"><span class="linenos"> 244</span></a> <span class="k">def</span> <span class="nf">GEVP</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="s2">&quot;Eigenvalue&quot;</span><span class="p">):</span>
</span><span id="Corr-245"><a href="#Corr-245"><span class="linenos"> 245</span></a> <span class="sd">&quot;&quot;&quot;Solve the general eigenvalue problem on the current correlator</span>
</span><span id="Corr-246"><a href="#Corr-246"><span class="linenos"> 246</span></a>
</span><span id="Corr-247"><a href="#Corr-247"><span class="linenos"> 247</span></a><span class="sd"> Parameters</span>
@ -1686,7 +1686,7 @@
</span><span id="Corr-252"><a href="#Corr-252"><span class="linenos"> 252</span></a><span class="sd"> fixed time G(t_s)v= lambda G(t_0)v if return_list=False</span>
</span><span id="Corr-253"><a href="#Corr-253"><span class="linenos"> 253</span></a><span class="sd"> If return_list=True and sorting=Eigenvector it gives a reference point for the sorting method.</span>
</span><span id="Corr-254"><a href="#Corr-254"><span class="linenos"> 254</span></a><span class="sd"> state : int</span>
</span><span id="Corr-255"><a href="#Corr-255"><span class="linenos"> 255</span></a><span class="sd"> The state one is interested in ordered by energy. The lowest state is zero.</span>
</span><span id="Corr-255"><a href="#Corr-255"><span class="linenos"> 255</span></a><span class="sd"> The state one is interested in, ordered by energy. The lowest state is zero.</span>
</span><span id="Corr-256"><a href="#Corr-256"><span class="linenos"> 256</span></a><span class="sd"> sorted_list : string</span>
</span><span id="Corr-257"><a href="#Corr-257"><span class="linenos"> 257</span></a><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><span id="Corr-258"><a href="#Corr-258"><span class="linenos"> 258</span></a><span class="sd"> &quot;Eigenvalue&quot; - The eigenvector is chosen according to which eigenvalue it belongs individually on every timeslice.</span>
@ -2604,7 +2604,7 @@
</span><span id="Corr-1170"><a href="#Corr-1170"><span class="linenos">1170</span></a>
</span><span id="Corr-1171"><a href="#Corr-1171"><span class="linenos">1171</span></a> <span class="n">evecs</span> <span class="o">=</span> <span class="p">[]</span>
</span><span id="Corr-1172"><a href="#Corr-1172"><span class="linenos">1172</span></a> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">Ntrunc</span><span class="p">):</span>
</span><span id="Corr-1173"><a href="#Corr-1173"><span class="linenos">1173</span></a> <span class="n">evecs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">basematrix</span><span class="o">.</span><span class="n">GEVP</span><span class="p">(</span><span class="n">t0proj</span><span class="p">,</span> <span class="n">tproj</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="n">i</span><span class="p">))</span>
</span><span id="Corr-1173"><a href="#Corr-1173"><span class="linenos">1173</span></a> <span class="n">evecs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">basematrix</span><span class="o">.</span><span class="n">GEVP</span><span class="p">(</span><span class="n">t0proj</span><span class="p">,</span> <span class="n">tproj</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="n">i</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><span id="Corr-1174"><a href="#Corr-1174"><span class="linenos">1174</span></a>
</span><span id="Corr-1175"><a href="#Corr-1175"><span class="linenos">1175</span></a> <span class="n">tmpmat</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">empty</span><span class="p">((</span><span class="n">Ntrunc</span><span class="p">,</span> <span class="n">Ntrunc</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">object</span><span class="p">)</span>
</span><span id="Corr-1176"><a href="#Corr-1176"><span class="linenos">1176</span></a> <span class="n">rmat</span> <span class="o">=</span> <span class="p">[]</span>
@ -3019,12 +3019,12 @@ timeslice and the error on each timeslice.</p>
<span class="def">def</span>
<span class="name">GEVP</span><span class="signature">(self, t0, ts=None, state=0, sorted_list=None)</span>:
<span class="name">GEVP</span><span class="signature">(self, t0, ts=None, state=0, sorted_list=&#39;Eigenvalue&#39;)</span>:
</div>
<details>
<summary>View Source</summary>
<div class="pdoc-code codehilite"><pre><span></span><span id="Corr.GEVP-244"><a href="#Corr.GEVP-244"><span class="linenos">244</span></a> <span class="k">def</span> <span class="nf">GEVP</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>
<div class="pdoc-code codehilite"><pre><span></span><span id="Corr.GEVP-244"><a href="#Corr.GEVP-244"><span class="linenos">244</span></a> <span class="k">def</span> <span class="nf">GEVP</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="s2">&quot;Eigenvalue&quot;</span><span class="p">):</span>
</span><span id="Corr.GEVP-245"><a href="#Corr.GEVP-245"><span class="linenos">245</span></a> <span class="sd">&quot;&quot;&quot;Solve the general eigenvalue problem on the current correlator</span>
</span><span id="Corr.GEVP-246"><a href="#Corr.GEVP-246"><span class="linenos">246</span></a>
</span><span id="Corr.GEVP-247"><a href="#Corr.GEVP-247"><span class="linenos">247</span></a><span class="sd"> Parameters</span>
@ -3035,7 +3035,7 @@ timeslice and the error on each timeslice.</p>
</span><span id="Corr.GEVP-252"><a href="#Corr.GEVP-252"><span class="linenos">252</span></a><span class="sd"> fixed time G(t_s)v= lambda G(t_0)v if return_list=False</span>
</span><span id="Corr.GEVP-253"><a href="#Corr.GEVP-253"><span class="linenos">253</span></a><span class="sd"> If return_list=True and sorting=Eigenvector it gives a reference point for the sorting method.</span>
</span><span id="Corr.GEVP-254"><a href="#Corr.GEVP-254"><span class="linenos">254</span></a><span class="sd"> state : int</span>
</span><span id="Corr.GEVP-255"><a href="#Corr.GEVP-255"><span class="linenos">255</span></a><span class="sd"> The state one is interested in ordered by energy. The lowest state is zero.</span>
</span><span id="Corr.GEVP-255"><a href="#Corr.GEVP-255"><span class="linenos">255</span></a><span class="sd"> The state one is interested in, ordered by energy. The lowest state is zero.</span>
</span><span id="Corr.GEVP-256"><a href="#Corr.GEVP-256"><span class="linenos">256</span></a><span class="sd"> sorted_list : string</span>
</span><span id="Corr.GEVP-257"><a href="#Corr.GEVP-257"><span class="linenos">257</span></a><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><span id="Corr.GEVP-258"><a href="#Corr.GEVP-258"><span class="linenos">258</span></a><span class="sd"> &quot;Eigenvalue&quot; - The eigenvector is chosen according to which eigenvalue it belongs individually on every timeslice.</span>
@ -3099,7 +3099,7 @@ The time t0 for G(t)v= lambda G(t_0)v</li>
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>
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.
@ -4558,7 +4558,7 @@ specifies a custom path for the file (default '.')</li>
</span><span id="Corr.prune-1170"><a href="#Corr.prune-1170"><span class="linenos">1170</span></a>
</span><span id="Corr.prune-1171"><a href="#Corr.prune-1171"><span class="linenos">1171</span></a> <span class="n">evecs</span> <span class="o">=</span> <span class="p">[]</span>
</span><span id="Corr.prune-1172"><a href="#Corr.prune-1172"><span class="linenos">1172</span></a> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">Ntrunc</span><span class="p">):</span>
</span><span id="Corr.prune-1173"><a href="#Corr.prune-1173"><span class="linenos">1173</span></a> <span class="n">evecs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">basematrix</span><span class="o">.</span><span class="n">GEVP</span><span class="p">(</span><span class="n">t0proj</span><span class="p">,</span> <span class="n">tproj</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="n">i</span><span class="p">))</span>
</span><span id="Corr.prune-1173"><a href="#Corr.prune-1173"><span class="linenos">1173</span></a> <span class="n">evecs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">basematrix</span><span class="o">.</span><span class="n">GEVP</span><span class="p">(</span><span class="n">t0proj</span><span class="p">,</span> <span class="n">tproj</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="n">i</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><span id="Corr.prune-1174"><a href="#Corr.prune-1174"><span class="linenos">1174</span></a>
</span><span id="Corr.prune-1175"><a href="#Corr.prune-1175"><span class="linenos">1175</span></a> <span class="n">tmpmat</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">empty</span><span class="p">((</span><span class="n">Ntrunc</span><span class="p">,</span> <span class="n">Ntrunc</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">object</span><span class="p">)</span>
</span><span id="Corr.prune-1176"><a href="#Corr.prune-1176"><span class="linenos">1176</span></a> <span class="n">rmat</span> <span class="o">=</span> <span class="p">[]</span>

File diff suppressed because one or more lines are too long