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

docs: documentation of CObs extended

Browse source
This commit is contained in:
Fabian Joswig 2021-11-15 14:57:58 +00:00
parent 85f37a7abf
commit 8bb1a910c6
1 changed files with 24 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

27
pyerrors/__init__.py
View file

@ -22,8 +22,8 @@ print(my_new_obs)
iamzero = my_new_obs - my_new_obs iamzero = my_new_obs - my_new_obs
iamzero.gamma_method() iamzero.gamma_method()
print(iamzero) print(iamzero == 0.0)
> 0.0 > True
``` ```
# The `Obs` class # The `Obs` class
@ -189,7 +189,28 @@ For the full API see `pyerrors.obs.Obs`
For the full API see `pyerrors.correlators.Corr` For the full API see `pyerrors.correlators.Corr`
# Complex observables # Complex observables
`pyerrors.obs.CObs`
`pyerrors` can handle complex valued observables via the class `pyerrors.obs.CObs`.
`CObs` are initialized with a real and an imaginary part which both can be `Obs` valued.
Example:
```python
my_real_part = pe.Obs([samples1], ['ensemble1'])
my_imag_part = pe.Obs([samples2], ['ensemble1'])
my_cobs = pe.CObs(my_real_part, my_imag_part)
my_cobs.gamma_method()
print(my_cobs)
> (0.9959(91)+0.659(28)j)
```
Elementary mathematical operations are overloaded and samples are properly propagated as for the `Obs` class.
```python
my_derived_cobs = (my_cobs + my_cobs.conjugate()) / np.abs(my_cobs)
my_derived_cobs.gamma_method()
print(my_derived_cobs)
> (1.668(23)+0.0j)
```
# Optimization / fits / roots # Optimization / fits / roots
`pyerrors.fits` `pyerrors.fits`