Documentation updated

This commit is contained in:
fjosw 2023-09-17 16:12:47 +00:00
parent e4da34ae59
commit f1fb56189f

View file

@ -279,12 +279,12 @@
</span><span id="L-168"><a href="#L-168"><span class="linenos">168</span></a><span class="sd"> &#39;&#39;&#39;</span>
</span><span id="L-169"><a href="#L-169"><span class="linenos">169</span></a> <span class="n">output</span> <span class="o">=</span> <span class="n">Fit_result</span><span class="p">()</span>
</span><span id="L-170"><a href="#L-170"><span class="linenos">170</span></a>
</span><span id="L-171"><a href="#L-171"><span class="linenos">171</span></a> <span class="k">if</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">==</span> <span class="nb">dict</span> <span class="ow">and</span> <span class="nb">type</span><span class="p">(</span><span class="n">y</span><span class="p">)</span> <span class="o">==</span> <span class="nb">dict</span> <span class="ow">and</span> <span class="nb">type</span><span class="p">(</span><span class="n">func</span><span class="p">)</span> <span class="o">==</span> <span class="nb">dict</span><span class="p">):</span>
</span><span id="L-171"><a href="#L-171"><span class="linenos">171</span></a> <span class="k">if</span> <span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)):</span>
</span><span id="L-172"><a href="#L-172"><span class="linenos">172</span></a> <span class="n">xd</span> <span class="o">=</span> <span class="p">{</span><span class="n">key</span><span class="p">:</span> <span class="n">anp</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">x</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">x</span><span class="p">}</span>
</span><span id="L-173"><a href="#L-173"><span class="linenos">173</span></a> <span class="n">yd</span> <span class="o">=</span> <span class="n">y</span>
</span><span id="L-174"><a href="#L-174"><span class="linenos">174</span></a> <span class="n">funcd</span> <span class="o">=</span> <span class="n">func</span>
</span><span id="L-175"><a href="#L-175"><span class="linenos">175</span></a> <span class="n">output</span><span class="o">.</span><span class="n">fit_function</span> <span class="o">=</span> <span class="n">func</span>
</span><span id="L-176"><a href="#L-176"><span class="linenos">176</span></a> <span class="k">elif</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">==</span> <span class="nb">dict</span> <span class="ow">or</span> <span class="nb">type</span><span class="p">(</span><span class="n">y</span><span class="p">)</span> <span class="o">==</span> <span class="nb">dict</span> <span class="ow">or</span> <span class="nb">type</span><span class="p">(</span><span class="n">func</span><span class="p">)</span> <span class="o">==</span> <span class="nb">dict</span><span class="p">):</span>
</span><span id="L-176"><a href="#L-176"><span class="linenos">176</span></a> <span class="k">elif</span> <span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)):</span>
</span><span id="L-177"><a href="#L-177"><span class="linenos">177</span></a> <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;All arguments have to be dictionaries in order to perform a combined fit.&quot;</span><span class="p">)</span>
</span><span id="L-178"><a href="#L-178"><span class="linenos">178</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="L-179"><a href="#L-179"><span class="linenos">179</span></a> <span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
@ -1201,12 +1201,12 @@ Hotelling t-squared p-value for correlated fits.</li>
</span><span id="least_squares-169"><a href="#least_squares-169"><span class="linenos">169</span></a><span class="sd"> &#39;&#39;&#39;</span>
</span><span id="least_squares-170"><a href="#least_squares-170"><span class="linenos">170</span></a> <span class="n">output</span> <span class="o">=</span> <span class="n">Fit_result</span><span class="p">()</span>
</span><span id="least_squares-171"><a href="#least_squares-171"><span class="linenos">171</span></a>
</span><span id="least_squares-172"><a href="#least_squares-172"><span class="linenos">172</span></a> <span class="k">if</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">==</span> <span class="nb">dict</span> <span class="ow">and</span> <span class="nb">type</span><span class="p">(</span><span class="n">y</span><span class="p">)</span> <span class="o">==</span> <span class="nb">dict</span> <span class="ow">and</span> <span class="nb">type</span><span class="p">(</span><span class="n">func</span><span class="p">)</span> <span class="o">==</span> <span class="nb">dict</span><span class="p">):</span>
</span><span id="least_squares-172"><a href="#least_squares-172"><span class="linenos">172</span></a> <span class="k">if</span> <span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)):</span>
</span><span id="least_squares-173"><a href="#least_squares-173"><span class="linenos">173</span></a> <span class="n">xd</span> <span class="o">=</span> <span class="p">{</span><span class="n">key</span><span class="p">:</span> <span class="n">anp</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">x</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">x</span><span class="p">}</span>
</span><span id="least_squares-174"><a href="#least_squares-174"><span class="linenos">174</span></a> <span class="n">yd</span> <span class="o">=</span> <span class="n">y</span>
</span><span id="least_squares-175"><a href="#least_squares-175"><span class="linenos">175</span></a> <span class="n">funcd</span> <span class="o">=</span> <span class="n">func</span>
</span><span id="least_squares-176"><a href="#least_squares-176"><span class="linenos">176</span></a> <span class="n">output</span><span class="o">.</span><span class="n">fit_function</span> <span class="o">=</span> <span class="n">func</span>
</span><span id="least_squares-177"><a href="#least_squares-177"><span class="linenos">177</span></a> <span class="k">elif</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">==</span> <span class="nb">dict</span> <span class="ow">or</span> <span class="nb">type</span><span class="p">(</span><span class="n">y</span><span class="p">)</span> <span class="o">==</span> <span class="nb">dict</span> <span class="ow">or</span> <span class="nb">type</span><span class="p">(</span><span class="n">func</span><span class="p">)</span> <span class="o">==</span> <span class="nb">dict</span><span class="p">):</span>
</span><span id="least_squares-177"><a href="#least_squares-177"><span class="linenos">177</span></a> <span class="k">elif</span> <span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)):</span>
</span><span id="least_squares-178"><a href="#least_squares-178"><span class="linenos">178</span></a> <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;All arguments have to be dictionaries in order to perform a combined fit.&quot;</span><span class="p">)</span>
</span><span id="least_squares-179"><a href="#least_squares-179"><span class="linenos">179</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="least_squares-180"><a href="#least_squares-180"><span class="linenos">180</span></a> <span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>