Documentation updated

This commit is contained in:
fjosw 2022-02-23 17:01:54 +00:00
parent 5dac3462a7
commit bf83ab29de

View file

@ -1245,7 +1245,7 @@
<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 configs on which the deltas are defined, has to be sorted in ascending order.</span>
<span class="sd"> shape : int</span>
<span class="sd"> Number of configs in idx.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -1259,7 +1259,7 @@
<span class="k">def</span> <span class="nf">_merge_idx</span><span class="p">(</span><span class="n">idl</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Returns the union of all lists in idl</span>
<span class="sd">&quot;&quot;&quot;Returns the union of all lists in idl as sorted list</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
@ -1282,7 +1282,7 @@
<span class="n">idstep</span> <span class="o">=</span> <span class="nb">min</span><span class="p">([</span><span class="n">idx</span><span class="o">.</span><span class="n">step</span> <span class="k">for</span> <span class="n">idx</span> <span class="ow">in</span> <span class="n">idl</span><span class="p">])</span>
<span class="k">return</span> <span class="nb">range</span><span class="p">(</span><span class="n">idstart</span><span class="p">,</span> <span class="n">idstop</span><span class="p">,</span> <span class="n">idstep</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">set</span><span class="p">()</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="o">*</span><span class="n">idl</span><span class="p">))</span>
<span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="nb">set</span><span class="p">()</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="o">*</span><span class="n">idl</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_expand_deltas_for_merge</span><span class="p">(</span><span class="n">deltas</span><span class="p">,</span> <span class="n">idx</span><span class="p">,</span> <span class="n">shape</span><span class="p">,</span> <span class="n">new_idx</span><span class="p">):</span>
@ -1296,11 +1296,11 @@
<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"> Has to be a subset of new_idx.</span>
<span class="sd"> Has to be a subset of new_idx and has to be sorted in ascending order.</span>
<span class="sd"> shape : list</span>
<span class="sd"> Number of configs in idx.</span>
<span class="sd"> new_idx : list</span>
<span class="sd"> List of configs that defines the new range.</span>
<span class="sd"> List of configs that defines the new range, has to be sorted in ascending order.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">idx</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">new_idx</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">range</span><span class="p">:</span>