Package adams.data.random

Interface CommonsRandomNumberGenerator<T extends Number>

  • Type Parameters:
    T - the type of random number to return
    All Superinterfaces:
    adams.core.Destroyable, adams.core.option.OptionHandler, adams.data.random.RandomNumberGenerator<T>, adams.core.ShallowCopySupporter<adams.data.random.RandomNumberGenerator>
    All Known Implementing Classes:
    AbstractCommonsRandomNumberGenerator, ISAACRandom, MersenneTwister, Well1024a, Well19937a, Well19937c, Well44497a, Well44497b, Well512a
    public interface CommonsRandomNumberGenerator<T extends Number>
extends adams.data.random.RandomNumberGenerator<T>, adams.core.option.OptionHandler
    Interface for random number generators that return the underlying Apache commons number generator.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String generateDoublesTipText()
      Returns the tip text for this property.
      boolean getGenerateDoubles()
      Returns whether to return doubles or integers.
      int getMaxValue()
      Returns the maximum value of the integers to generate.
      int getMinValue()
      Returns the minimum value of the integers to generate.
      org.apache.commons.math3.random.RandomGenerator getRandomGenerator()
      The underlying random number generator.
      String maxValueTipText()
      Returns the tip text for this property.
      String minValueTipText()
      Returns the tip text for this property.
      void setGenerateDoubles​(boolean value)
      Sets whether to return doubles or integers.
      void setMaxValue​(int value)
      Sets the maximum value of the integers to generate.
      void setMinValue​(int value)
      Sets the minimum value of the integers to generate.

      • Methods inherited from interface adams.core.Destroyable

        destroy

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, defineOptions, getOptionManager, toCommandLine

      • Methods inherited from interface adams.data.random.RandomNumberGenerator

        next, reset

      • Methods inherited from interface adams.core.ShallowCopySupporter

        shallowCopy, shallowCopy

    • Method Detail

      • setGenerateDoubles

        void setGenerateDoubles​(boolean value)
        Sets whether to return doubles or integers.
        Parameters:
        value - true if to return doubles, false for integers

      • getGenerateDoubles

        boolean getGenerateDoubles()
        Returns whether to return doubles or integers.
        Returns:
        true if to return doubles, false for integers

      • generateDoublesTipText

        String generateDoublesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setMinValue

        void setMinValue​(int value)
        Sets the minimum value of the integers to generate.
        Parameters:
        value - the minimum

      • getMinValue

        int getMinValue()
        Returns the minimum value of the integers to generate.
        Returns:
        the minimum

      • minValueTipText

        String minValueTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setMaxValue

        void setMaxValue​(int value)
        Sets the maximum value of the integers to generate.
        Parameters:
        value - the maximum

      • getMaxValue

        int getMaxValue()
        Returns the maximum value of the integers to generate.
        Returns:
        the maximum

      • maxValueTipText

        String maxValueTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getRandomGenerator

        org.apache.commons.math3.random.RandomGenerator getRandomGenerator()
        The underlying random number generator.
        Returns:
        the configured generator