Documentation updated

This commit is contained in:
fjosw 2023-03-08 16:46:46 +00:00
parent 8f36de348d
commit 8edaf390e6

View file

@ -300,10 +300,10 @@
</span><span id="L-192"><a href="#L-192"><span class="linenos">192</span></a> <span class="n">key_ls</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">xd</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span>
</span><span id="L-193"><a href="#L-193"><span class="linenos">193</span></a>
</span><span id="L-194"><a href="#L-194"><span class="linenos">194</span></a> <span class="k">if</span> <span class="nb">sorted</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">yd</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span> <span class="o">!=</span> <span class="n">key_ls</span><span class="p">:</span>
</span><span id="L-195"><a href="#L-195"><span class="linenos">195</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;x and y dictionaries do not contain the same keys.&#39;</span><span class="p">)</span>
</span><span id="L-195"><a href="#L-195"><span class="linenos">195</span></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;x and y dictionaries do not contain the same keys.&#39;</span><span class="p">)</span>
</span><span id="L-196"><a href="#L-196"><span class="linenos">196</span></a>
</span><span id="L-197"><a href="#L-197"><span class="linenos">197</span></a> <span class="k">if</span> <span class="nb">sorted</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">funcd</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span> <span class="o">!=</span> <span class="n">key_ls</span><span class="p">:</span>
</span><span id="L-198"><a href="#L-198"><span class="linenos">198</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;x and func dictionaries do not contain the same keys.&#39;</span><span class="p">)</span>
</span><span id="L-198"><a href="#L-198"><span class="linenos">198</span></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;x and func dictionaries do not contain the same keys.&#39;</span><span class="p">)</span>
</span><span id="L-199"><a href="#L-199"><span class="linenos">199</span></a>
</span><span id="L-200"><a href="#L-200"><span class="linenos">200</span></a> <span class="n">x_all</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">([</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">xd</span><span class="p">[</span><span class="n">key</span><span class="p">])</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">key_ls</span><span class="p">])</span>
</span><span id="L-201"><a href="#L-201"><span class="linenos">201</span></a> <span class="n">y_all</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">([</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">yd</span><span class="p">[</span><span class="n">key</span><span class="p">])</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">key_ls</span><span class="p">])</span>
@ -323,7 +323,7 @@
</span><span id="L-215"><a href="#L-215"><span class="linenos">215</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">callable</span><span class="p">(</span><span class="n">funcd</span><span class="p">[</span><span class="n">key</span><span class="p">]):</span>
</span><span id="L-216"><a href="#L-216"><span class="linenos">216</span></a> <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;func (key=&#39;</span> <span class="o">+</span> <span class="n">key</span> <span class="o">+</span> <span class="s1">&#39;) is not a function.&#39;</span><span class="p">)</span>
</span><span id="L-217"><a href="#L-217"><span class="linenos">217</span></a> <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">xd</span><span class="p">[</span><span class="n">key</span><span class="p">])</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">yd</span><span class="p">[</span><span class="n">key</span><span class="p">]):</span>
</span><span id="L-218"><a href="#L-218"><span class="linenos">218</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;x and y input (key=&#39;</span> <span class="o">+</span> <span class="n">key</span> <span class="o">+</span> <span class="s1">&#39;) do not have the same length&#39;</span><span class="p">)</span>
</span><span id="L-218"><a href="#L-218"><span class="linenos">218</span></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;x and y input (key=&#39;</span> <span class="o">+</span> <span class="n">key</span> <span class="o">+</span> <span class="s1">&#39;) do not have the same length&#39;</span><span class="p">)</span>
</span><span id="L-219"><a href="#L-219"><span class="linenos">219</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="mi">100</span><span class="p">):</span>
</span><span id="L-220"><a href="#L-220"><span class="linenos">220</span></a> <span class="k">try</span><span class="p">:</span>
</span><span id="L-221"><a href="#L-221"><span class="linenos">221</span></a> <span class="n">funcd</span><span class="p">[</span><span class="n">key</span><span class="p">](</span><span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="n">i</span><span class="p">),</span> <span class="n">x_all</span><span class="o">.</span><span class="n">T</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
@ -788,7 +788,7 @@
</span><span id="L-680"><a href="#L-680"><span class="linenos">680</span></a> <span class="n">out</span> <span class="o">=</span> <span class="n">least_squares</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">f</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</span><span id="L-681"><a href="#L-681"><span class="linenos">681</span></a> <span class="k">return</span> <span class="n">out</span><span class="o">.</span><span class="n">fit_parameters</span>
</span><span id="L-682"><a href="#L-682"><span class="linenos">682</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="L-683"><a href="#L-683"><span class="linenos">683</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Unsupported types for x&#39;</span><span class="p">)</span>
</span><span id="L-683"><a href="#L-683"><span class="linenos">683</span></a> <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;Unsupported types for x&#39;</span><span class="p">)</span>
</span><span id="L-684"><a href="#L-684"><span class="linenos">684</span></a>
</span><span id="L-685"><a href="#L-685"><span class="linenos">685</span></a>
</span><span id="L-686"><a href="#L-686"><span class="linenos">686</span></a><span class="k">def</span> <span class="nf">qqplot</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">o_y</span><span class="p">,</span> <span class="n">func</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
@ -1208,10 +1208,10 @@ Hotelling t-squared p-value for correlated fits.</li>
</span><span id="least_squares-193"><a href="#least_squares-193"><span class="linenos">193</span></a> <span class="n">key_ls</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">xd</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span>
</span><span id="least_squares-194"><a href="#least_squares-194"><span class="linenos">194</span></a>
</span><span id="least_squares-195"><a href="#least_squares-195"><span class="linenos">195</span></a> <span class="k">if</span> <span class="nb">sorted</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">yd</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span> <span class="o">!=</span> <span class="n">key_ls</span><span class="p">:</span>
</span><span id="least_squares-196"><a href="#least_squares-196"><span class="linenos">196</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;x and y dictionaries do not contain the same keys.&#39;</span><span class="p">)</span>
</span><span id="least_squares-196"><a href="#least_squares-196"><span class="linenos">196</span></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;x and y dictionaries do not contain the same keys.&#39;</span><span class="p">)</span>
</span><span id="least_squares-197"><a href="#least_squares-197"><span class="linenos">197</span></a>
</span><span id="least_squares-198"><a href="#least_squares-198"><span class="linenos">198</span></a> <span class="k">if</span> <span class="nb">sorted</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">funcd</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span> <span class="o">!=</span> <span class="n">key_ls</span><span class="p">:</span>
</span><span id="least_squares-199"><a href="#least_squares-199"><span class="linenos">199</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;x and func dictionaries do not contain the same keys.&#39;</span><span class="p">)</span>
</span><span id="least_squares-199"><a href="#least_squares-199"><span class="linenos">199</span></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;x and func dictionaries do not contain the same keys.&#39;</span><span class="p">)</span>
</span><span id="least_squares-200"><a href="#least_squares-200"><span class="linenos">200</span></a>
</span><span id="least_squares-201"><a href="#least_squares-201"><span class="linenos">201</span></a> <span class="n">x_all</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">([</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">xd</span><span class="p">[</span><span class="n">key</span><span class="p">])</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">key_ls</span><span class="p">])</span>
</span><span id="least_squares-202"><a href="#least_squares-202"><span class="linenos">202</span></a> <span class="n">y_all</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">([</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">yd</span><span class="p">[</span><span class="n">key</span><span class="p">])</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">key_ls</span><span class="p">])</span>
@ -1231,7 +1231,7 @@ Hotelling t-squared p-value for correlated fits.</li>
</span><span id="least_squares-216"><a href="#least_squares-216"><span class="linenos">216</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">callable</span><span class="p">(</span><span class="n">funcd</span><span class="p">[</span><span class="n">key</span><span class="p">]):</span>
</span><span id="least_squares-217"><a href="#least_squares-217"><span class="linenos">217</span></a> <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;func (key=&#39;</span> <span class="o">+</span> <span class="n">key</span> <span class="o">+</span> <span class="s1">&#39;) is not a function.&#39;</span><span class="p">)</span>
</span><span id="least_squares-218"><a href="#least_squares-218"><span class="linenos">218</span></a> <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">xd</span><span class="p">[</span><span class="n">key</span><span class="p">])</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">yd</span><span class="p">[</span><span class="n">key</span><span class="p">]):</span>
</span><span id="least_squares-219"><a href="#least_squares-219"><span class="linenos">219</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;x and y input (key=&#39;</span> <span class="o">+</span> <span class="n">key</span> <span class="o">+</span> <span class="s1">&#39;) do not have the same length&#39;</span><span class="p">)</span>
</span><span id="least_squares-219"><a href="#least_squares-219"><span class="linenos">219</span></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;x and y input (key=&#39;</span> <span class="o">+</span> <span class="n">key</span> <span class="o">+</span> <span class="s1">&#39;) do not have the same length&#39;</span><span class="p">)</span>
</span><span id="least_squares-220"><a href="#least_squares-220"><span class="linenos">220</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="mi">100</span><span class="p">):</span>
</span><span id="least_squares-221"><a href="#least_squares-221"><span class="linenos">221</span></a> <span class="k">try</span><span class="p">:</span>
</span><span id="least_squares-222"><a href="#least_squares-222"><span class="linenos">222</span></a> <span class="n">funcd</span><span class="p">[</span><span class="n">key</span><span class="p">](</span><span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="n">i</span><span class="p">),</span> <span class="n">x_all</span><span class="o">.</span><span class="n">T</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
@ -1880,7 +1880,7 @@ Parameters and information on the fitted result.</li>
</span><span id="fit_lin-681"><a href="#fit_lin-681"><span class="linenos">681</span></a> <span class="n">out</span> <span class="o">=</span> <span class="n">least_squares</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">f</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</span><span id="fit_lin-682"><a href="#fit_lin-682"><span class="linenos">682</span></a> <span class="k">return</span> <span class="n">out</span><span class="o">.</span><span class="n">fit_parameters</span>
</span><span id="fit_lin-683"><a href="#fit_lin-683"><span class="linenos">683</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="fit_lin-684"><a href="#fit_lin-684"><span class="linenos">684</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Unsupported types for x&#39;</span><span class="p">)</span>
</span><span id="fit_lin-684"><a href="#fit_lin-684"><span class="linenos">684</span></a> <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;Unsupported types for x&#39;</span><span class="p">)</span>
</span></pre></div>