lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-05-16 12:33:41 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: typos in docstrings corrected

Browse source
This commit is contained in:
Fabian Joswig 2021-11-15 11:13:12 +00:00
parent 24ef100197
commit b937ef04bb
4 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

12
pyerrors/correlators.py
View file

@ -14,7 +14,7 @@ class Corr:
Everything, this class does, can be achieved using lists or arrays of Obs.
But it is simply more convenient to have a dedicated object for correlators.
One often wants to add or multiply correlators of the same length at every timeslice and it is inconvinient
One often wants to add or multiply correlators of the same length at every timeslice and it is inconvenient
to iterate over all timeslices for every operation. This is especially true, when dealing with smearing matrices.
The correlator can have two types of content: An Obs at every timeslice OR a GEVP
@ -317,7 +317,7 @@ class Corr:
Parameters
----------
symmetric : bool
decides whether symmertic of simple finite differences are used. Default: True
decides whether symmetric of simple finite differences are used. Default: True
"""
if not symmetric:
newcontent = []
@ -415,7 +415,7 @@ class Corr:
return np.arccosh(Corr(newcontent, padding_back=1, padding_front=1))
else:
raise Exception('Unkown variant.')
raise Exception('Unknown variant.')
def fit(self, function, fitrange=None, silent=False, **kwargs):
"""Fits function to the data
@ -433,7 +433,7 @@ class Corr:
if self.N != 1:
raise Exception("Correlator must be projected before fitting")
# The default behaviour is:
# The default behavior is:
# 1 use explicit fitrange
# if none is provided, use the range of the corr
# if this is also not set, use the whole length of the corr (This could come with a warning!)
@ -451,7 +451,7 @@ class Corr:
return result
def plateau(self, plateau_range=None, method="fit"):
""" Extract a plateu value from a Corr object
""" Extract a plateau value from a Corr object
Parameters
----------
@ -582,7 +582,7 @@ class Corr:
return
def dump(self, filename):
"""Dumps the Corr into a pickel file
"""Dumps the Corr into a pickle file
Parameters
----------