51 lines
1.1 KiB
JavaScript
51 lines
1.1 KiB
JavaScript
|
/**
|
||
|
|
* @license Apache-2.0
|
||
|
|
*
|
||
|
|
* Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
*
|
||
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
* you may not use this file except in compliance with the License.
|
||
|
|
* You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
*/
|
||
|
|
|
||
|
|
'use strict';
|
||
|
|
|
||
|
|
// MODULES //
|
||
|
|
|
||
|
|
var factory = require( './factory.js' );
|
||
|
|
|
||
|
|
|
||
|
|
// MAIN //
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns pseudorandom number drawn from a Cauchy distribution.
|
||
|
|
*
|
||
|
|
* @name cauchy
|
||
|
|
* @type {PRNG}
|
||
|
|
* @param {number} x0 - location parameter
|
||
|
|
* @param {PositiveNumber} gamma - scale parameter
|
||
|
|
* @returns {number} pseudorandom number
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var v = cauchy( 0.0, 2.0 );
|
||
|
|
* // returns <number>
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var v = cauchy( 0.0, -1.0 );
|
||
|
|
* // returns NaN
|
||
|
|
*/
|
||
|
|
var cauchy = factory();
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = cauchy;
|