Skip to content

Commit

Permalink
Merge pull request #10 from mtsch/multinomial-doc
Browse files Browse the repository at this point in the history
Add docstring for multinomial
  • Loading branch information
mtsch authored Aug 28, 2024
2 parents 48e8368 + a96657c commit 86ce163
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion src/ansatz/multinomial.jl
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
"""
MultinomialAnsatz(H::AbstractHamiltonian; normalize=false)
The multinomial ansatz
```math
b
F(|n_1, n_2, n_3, …⟩; p) = K ( ∏_{i=1}^M 1/n_i )^p.
```
If ``p = 1/2``, this is the exact solution to a non-interacting Bose-Hubbard model. If `normalize` is set to `true`, a normalization factor of
```math
K = (\frac{N}{M^N})^p
```
is applied.
"""
struct MultinomialAnsatz{K} <: Gutzwiller.AbstractAnsatz{K,Float64,1}
normalization::Float64
Expand Down

0 comments on commit 86ce163

Please sign in to comment.