[
https://issues.apache.org/jira/browse/RNG-73?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Alex D Herbert resolved RNG-73.
-------------------------------
Resolution: Implemented
Assignee: Alex D Herbert
Fix Version/s: 1.3
Updated javadocs merged into master.
> Improve Javadoc for the samplers
> --------------------------------
>
> Key: RNG-73
> URL: https://issues.apache.org/jira/browse/RNG-73
> Project: Commons RNG
> Issue Type: Improvement
> Components: sampling
> Affects Versions: 1.3
> Reporter: Alex D Herbert
> Assignee: Alex D Herbert
> Priority: Minor
> Fix For: 1.3
>
> Time Spent: 0.5h
> Remaining Estimate: 0h
>
> Add the methods used by each of the samplers from the
> {{UniformRandomProvider}} interface to the Javadoc. This can be used to
> select an optimal provider for the algorithm as some may perform better for
> different methods, e.g. {{nextDouble}}.
> For example:
> {code:java}
> /**
> * ...
> *
> * <p>Sampling uses {@link UniformRandomProvider#nextInt(int)}.
> *
> * ...
> */
> public class CollectionSampler<T> {
> /**
> * ...
> *
> * <p>Sampling uses {@link UniformRandomProvider#nextDouble()}.
> *
> * ...
> */
> public class SmallMeanPoissonSampler
> {code}
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
