time-to-botec/js/node_modules/@stdlib/random/base/frechet/lib/index.js

68 lines
1.5 KiB
JavaScript
Raw Normal View History

/**
* @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';
/**
* Fréchet distributed pseudorandom numbers.
*
* @module @stdlib/random/base/frechet
*
* @example
* var frechet = require( '@stdlib/random/base/frechet' );
*
* var v = frechet( 10.0, 10.0, 7.0 );
* // returns <number>
*
* @example
* var factory = require( '@stdlib/random/base/frechet' ).factory;
*
* var frechet = factory( 5.0, 5.0, 3.0, {
* 'seed': 643361677
* });
*
* var v = frechet();
* // returns <number>
*
* @example
* var factory = require( '@stdlib/random/base/frechet' ).factory;
*
* var frechet = factory({
* 'seed': 643361677
* });
*
* var v = frechet( 5.0, 5.0, 3.0 );
* // returns <number>
*/
// MODULES //
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
var frechet = require( './main.js' );
var factory = require( './factory.js' );
// MAIN //
setReadOnly( frechet, 'factory', factory );
// EXPORTS //
module.exports = frechet;