time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

rand_uint32.js (1227B)


      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 // MODULES //
     22 
     23 var UINT32_MAX = require( '@stdlib/constants/uint32/max' );
     24 var floor = require( '@stdlib/math/base/special/floor' );
     25 
     26 
     27 // VARIABLES //
     28 
     29 var MAX = UINT32_MAX - 1;
     30 
     31 
     32 // MAIN //
     33 
     34 /**
     35 * Returns a pseudorandom integer on the interval \\([1, 2^{32}-1)\\).
     36 *
     37 * @private
     38 * @returns {PositiveInteger} pseudorandom integer
     39 *
     40 * @example
     41 * var v = randuint32();
     42 * // returns <number>
     43 */
     44 function randuint32() {
     45 	var v = floor( 1.0 + (MAX*Math.random()) ); // eslint-disable-line stdlib/no-builtin-math
     46 	return v >>> 0; // asm type annotation
     47 }
     48 
     49 
     50 // EXPORTS //
     51 
     52 module.exports = randuint32;