Uploaded image for project: 'Commons RNG'
  1. Commons RNG
  2. RNG-73

Improve Javadoc for the samplers

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Minor
    • Resolution: Implemented
    • 1.3
    • 1.3
    • sampling
    • None

    Description

      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:

      /**
       * ...
       *
       * <p>Sampling uses {@link UniformRandomProvider#nextInt(int)}.
       *
       * ...
       */
      public class CollectionSampler<T> {
      
      /**
       * ...
       * 
       * <p>Sampling uses {@link UniformRandomProvider#nextDouble()}.
       *
       * ...
       */
      public class SmallMeanPoissonSampler
      
      

      Attachments

        Issue Links

          Activity

            People

              aherbert Alex Herbert
              aherbert Alex Herbert
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 0.5h
                  0.5h