Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds quick_guide #75

Merged
merged 2 commits into from
Oct 24, 2019
Merged

Adds quick_guide #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d68a8a
Adds quick_guide
nquesada Oct 24, 2019
1464722
Update quick_guide.rst
nquesada Oct 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ The Walrus library is **free** and **open source**, released under the Apache Li

installing
research
quick_guide


.. toctree::
Expand Down
26 changes: 26 additions & 0 deletions docs/quick_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _quick_guide:

Quick guide
###########

This section provides a quick guide to find which function does what in The Walrus.


================================================================================ =============================
**What you want** **Corresponding function**
-------------------------------------------------------------------------------- -----------------------------
Numerical hafnian :func:`thewalrus.hafnian()`
Symbolic hafnian :func:`thewalrus.reference.hafnian()`
Hafnian of a matrix with repeated rows and columns :func:`thewalrus.hafnian_repeated()`
Hafnians of all possible reductions of a given matrix :func:`thewalrus.hafnian_batched()`
Hafnian samples of a Gaussian state :func:`thewalrus.samples.hafnian_sample_state()`
Torontonian samples of a Gaussian state :func:`thewalrus.samples.torontonian_sample_state()`
Hafnian samples of a graph :func:`thewalrus.samples.hafnian_sample_graph()`
Torontonian samples of a graph :func:`thewalrus.samples.torontonian_sample_graph()`
All probability amplitudes of a pure Gaussian state :func:`thewalrus.quantum.state_vector()`
All matrix elements of a general Gaussian state :func:`thewalrus.quantum.density_matrix()`
A particular probability amplitude of pure Gaussian state :func:`thewalrus.quantum.pure_state_amplitude()`
A particular matrix element of a general Gaussian state :func:`thewalrus.quantum.density_matrix_element()`
================================================================================ =============================

Note that all the hafnian functions listed above generalize to loop hafnians.