[jira] [Created] (RNG-73) Improve Javadoc for the samplers

["Alex D Herbert (JIRA)" <ji...@apache.org>]

Alex D Herbert created RNG-73:
---------------------------------

             Summary: 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


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)