Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
davide-f committed Oct 17, 2022
1 parent 81aeb07 commit 740b178
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,15 @@ pem_output = pem(distribution, N_pem)

pem_output.x # locations of the points
pem_output.p # probability of each point
```
```

The pem function automatically calculates the moments of the distribution
with the method Distributions.moment(::UnivariateDistribution, ::Int), by default;
custom function can also be specified using the optional keyword central_moment_fun;
see the docstring of the pem function.

When the function is not available, the proposed distribution is sampled
using the rand function and then the sampled vector is used to calculate the moments.
For more details, see the docstring of the pem function.

Examples are provided in the notebooks folder.

0 comments on commit 740b178

Please sign in to comment.