Skip to content

Commit

Permalink
API docs and bibliography in README.md.
Browse files Browse the repository at this point in the history
Description of the project and API documentation.
  • Loading branch information
joeydumont committed Jul 9, 2014
1 parent bdb67c8 commit d08ce01
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,29 @@
wignerSymbols
=============
Wigner Symbols
==============

A C++ ensemble of functions to compute the Wigner 3j- and 6j- symbols. It implements the algorihtm designed
by Schulten and Gordon. It can either compute an array of Wigner 3j or 6j symbols, or a single
coefficient. It also computes the Clebsch-Gordan coefficients.

## API documentation
We list the user-facing functions that compute the Wigner symbols. The functions are
behind the namespace `WignerSymbols`.

+ `std::vector<double> wigner3j(double l2, double l3, double m1, double m2, double m3)`<br />
Computes Wigner 3j symbols with all possible values of `l1`. Returns an `std::vector<double>` with the
coefficients sorted by increasing values of `l1`.
+ `double wigner3j(double l1, double l2, double l3, double m1, double m2, double m3)`<br />
Computes a specific Wigner 3j symbol.
+ `double clebschGordan(double l1, double l2, double l3, double m1, double m2, double m3)`<br />
Computes a specific Clebch-Gordan coeffcient.
+ `std::vector<double> wigner6j(double l2, double l3, double l4, double l5, double l6)`<br />
Computes Wigner 6j symbols with all possible values of `l1`. Returns an `std::vector<double>` with the
coefficients sorted by increasing values of `l1`.
+ `double wigner6j(double l1, double l2, double l3, double l4, double l5, double l6)`<br />
Computes a specific Wigner 6j symbol.


## Bibliography
+ K. Schulten and R. G. Gordon, _Recursive evaluation of 3j and 6j coefficients_, Comput. Phys. Commun. **11**, 269–278 (1976).
+ K. Schulten, _Exact recursive evaluation of 3j- and 6j-coefficients for quantum-mechanical coupling of angular momenta,_ J. Math. Phys. **16**, 1961 (1975).

A C++ library to compute the Wigner 3j- and 6j- symbols.

0 comments on commit d08ce01

Please sign in to comment.