randomInt.js 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.createRandomInt = void 0;
  6. var _factory = require("../../utils/factory.js");
  7. var _randomMatrix = require("./util/randomMatrix.js");
  8. var _seededRNG = require("./util/seededRNG.js");
  9. var _is = require("../../utils/is.js");
  10. var name = 'randomInt';
  11. var dependencies = ['typed', 'config', '?on'];
  12. var createRandomInt = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
  13. var typed = _ref.typed,
  14. config = _ref.config,
  15. on = _ref.on;
  16. // seeded pseudo random number generator
  17. var rng = (0, _seededRNG.createRng)(config.randomSeed);
  18. if (on) {
  19. on('config', function (curr, prev) {
  20. if (curr.randomSeed !== prev.randomSeed) {
  21. rng = (0, _seededRNG.createRng)(curr.randomSeed);
  22. }
  23. });
  24. }
  25. /**
  26. * Return a random integer number larger or equal to `min` and smaller than `max`
  27. * using a uniform distribution.
  28. *
  29. * Syntax:
  30. *
  31. * math.randomInt() // generate a random integer between 0 and 1
  32. * math.randomInt(max) // generate a random integer between 0 and max
  33. * math.randomInt(min, max) // generate a random integer between min and max
  34. * math.randomInt(size) // generate a matrix with random integer between 0 and 1
  35. * math.randomInt(size, max) // generate a matrix with random integer between 0 and max
  36. * math.randomInt(size, min, max) // generate a matrix with random integer between min and max
  37. *
  38. * Examples:
  39. *
  40. * math.randomInt(100) // returns a random integer between 0 and 100
  41. * math.randomInt(30, 40) // returns a random integer between 30 and 40
  42. * math.randomInt([2, 3]) // returns a 2x3 matrix with random integers between 0 and 1
  43. *
  44. * See also:
  45. *
  46. * random, pickRandom
  47. *
  48. * @param {Array | Matrix} [size] If provided, an array or matrix with given
  49. * size and filled with random values is returned
  50. * @param {number} [min] Minimum boundary for the random value, included
  51. * @param {number} [max] Maximum boundary for the random value, excluded
  52. * @return {number | Array | Matrix} A random integer value
  53. */
  54. return typed(name, {
  55. '': function _() {
  56. return _randomInt(0, 1);
  57. },
  58. number: function number(max) {
  59. return _randomInt(0, max);
  60. },
  61. 'number, number': function numberNumber(min, max) {
  62. return _randomInt(min, max);
  63. },
  64. 'Array | Matrix': function ArrayMatrix(size) {
  65. return _randomIntMatrix(size, 0, 1);
  66. },
  67. 'Array | Matrix, number': function ArrayMatrixNumber(size, max) {
  68. return _randomIntMatrix(size, 0, max);
  69. },
  70. 'Array | Matrix, number, number': function ArrayMatrixNumberNumber(size, min, max) {
  71. return _randomIntMatrix(size, min, max);
  72. }
  73. });
  74. function _randomIntMatrix(size, min, max) {
  75. var res = (0, _randomMatrix.randomMatrix)(size.valueOf(), function () {
  76. return _randomInt(min, max);
  77. });
  78. return (0, _is.isMatrix)(size) ? size.create(res) : res;
  79. }
  80. function _randomInt(min, max) {
  81. return Math.floor(min + rng() * (max - min));
  82. }
  83. });
  84. exports.createRandomInt = createRandomInt;