main.js (1192B)
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 factory = require( './factory.js' ); 24 25 26 // MAIN // 27 28 /** 29 * Returns a pseudorandom number drawn from a Rayleigh distribution with scale parameter `sigma`. 30 * 31 * @name rayleigh 32 * @type {Function} 33 * @param {PositiveNumber} sigma - scale parameter 34 * @returns {NonNegativeNumber} pseudorandom number 35 * 36 * @example 37 * var v = rayleigh( 3.0 ); 38 * // returns <number> 39 * 40 * @example 41 * var v = rayleigh( 0.0 ); 42 * // returns NaN 43 * 44 * @example 45 * var v = rayleigh( NaN ); 46 * // returns NaN 47 */ 48 var rayleigh = factory(); 49 50 51 // EXPORTS // 52 53 module.exports = rayleigh;