index.js (1415B)
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 /** 22 * Fréchet distribution probability density function (PDF). 23 * 24 * @module @stdlib/stats/base/dists/frechet/pdf 25 * 26 * @example 27 * var pdf = require( '@stdlib/stats/base/dists/frechet/pdf' ); 28 * 29 * var y = pdf( 10.0, 2.0, 3.0, 5.0 ); 30 * // returns ~0.698 31 * 32 * y = pdf( 0.0, 2.0, 3.0, 2.0 ); 33 * // returns 0.0 34 * 35 * @example 36 * var factory = require( '@stdlib/stats/base/dists/frechet/pdf' ).factory; 37 * var pdf = factory( 3.0, 3.0, 5.0 ); 38 * var y = pdf( 10.0 ); 39 * // returns ~0.806 40 * 41 * y = pdf( 7.0 ); 42 * // returns ~0.034 43 */ 44 45 // MODULES // 46 47 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 48 var pdf = require( './pdf.js' ); 49 var factory = require( './factory.js' ); 50 51 52 // MAIN // 53 54 setReadOnly( pdf, 'factory', factory ); 55 56 57 // EXPORTS // 58 59 module.exports = pdf;