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

Small change in docstrings

Browse source
This commit is contained in:
Simon Kuberski 2021-11-15 16:42:19 +01:00
commit 5a347e0506
1 changed files with 3 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
pyerrors/fits.py
View file

@ -109,12 +109,11 @@ def least_squares(x, y, func, priors=None, silent=False, **kwargs):
corrected by effects caused by correlated input data. corrected by effects caused by correlated input data.
This can take a while as the full correlation matrix This can take a while as the full correlation matrix
has to be calculated (default False). has to be calculated (default False).
correlated_fit : int correlated_fit : bool
If true, use the full correlation matrix in the definition of the chisquare If true, use the full correlation matrix in the definition of the chisquare
(only works for prior==None and when no method is given, at the moment). (only works for prior==None and when no method is given, at the moment).
const_par : list, optional const_par : list, optional
List of N Obs that are used to constrain the last N fit parameters of func and List of N Obs that are used to constrain the last N fit parameters of func.
to take into account the correlations.
''' '''
if priors is not None: if priors is not None:
return _prior_fit(x, y, func, priors, silent=silent, **kwargs) return _prior_fit(x, y, func, priors, silent=silent, **kwargs)
@ -161,8 +160,7 @@ def total_least_squares(x, y, func, silent=False, **kwargs):
This can take a while as the full correlation matrix This can take a while as the full correlation matrix
has to be calculated (default False). has to be calculated (default False).
const_par : list, optional const_par : list, optional
List of N Obs that are used to constrain the last N fit parameters of func and List of N Obs that are used to constrain the last N fit parameters of func.
to take into account the correlations.
Based on the orthogonal distance regression module of scipy Based on the orthogonal distance regression module of scipy
''' '''