index.js (1317B)
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 * Rayleigh distribution logarithm of probability density function (PDF). 23 * 24 * @module @stdlib/stats/base/dists/rayleigh/logpdf 25 * 26 * @example 27 * var logpdf = require( '@stdlib/stats/base/dists/rayleigh/logpdf' ); 28 * 29 * var y = logpdf( 2.0, 4.0 ); 30 * // returns ~-2.207 31 * 32 * var mylogpdf = logpdf.factory( 4.0 ); 33 * 34 * y = mylogpdf( 6.0 ); 35 * // returns ~-2.104 36 * 37 * y = mylogpdf( 4.0 ); 38 * // returns ~-1.884 39 */ 40 41 // MODULES // 42 43 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 44 var logpdf = require( './logpdf.js' ); 45 var factory = require( './factory.js' ); 46 47 48 // MAIN // 49 50 setReadOnly( logpdf, 'factory', factory ); 51 52 53 // EXPORTS // 54 55 module.exports = logpdf;