Tidy up the docs, fix typos and formatting issues #28
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
josh146
commented
Jul 18, 2019
hafnian/__init__.py
Outdated
| @@ -47,6 +47,9 @@ | |||
| matrices with non-negative elements. This is done by sampling determinants; | |||
| the larger the number of samples taken, the higher the accuracy. | |||
|
|
|||
| Batched hafnian algorithm | |||
| TODO | |||
There was a problem hiding this comment.
@nquesada or @bgupt, realised this definition was missing, could one of you guys fill it in? This is in the code API section, so just needs a short 1-2 sentence of what it does plus a link to the paper.
Something like
Returns photon number statistics of a Gaussian state for a given
covariance matrix as described in
*Multidimensional Hermite polynomials and photon distribution for polymode mixed light*
`arxiv:9308033 <https://arxiv.org/abs/hep-th/9308033>`__.
josh146
commented
Jul 18, 2019
josh146
commented
Jul 18, 2019
josh146
commented
Jul 18, 2019
Codecov Report
@@ Coverage Diff @@
## master #28 +/- ##
==========================================
+ Coverage 95.2% 96.08% +0.88%
==========================================
Files 9 9
Lines 625 791 +166
==========================================
+ Hits 595 760 +165
- Misses 30 31 +1
Continue to review full report at Codecov.
|
bgupt
approved these changes
Jul 20, 2019
josh146
commented
Jul 21, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the Change: resolves a few typos and formatting issues
Benefits: n/a
Possible Drawbacks: n/a
Related GitHub Issues: n/a