index.js (1301B)
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 * Natural logarithm of cumulative distribution function (CDF) for a raised cosine distribution. 23 * 24 * @module @stdlib/stats/base/dists/cosine/logcdf 25 * 26 * @example 27 * var logcdf = require( '@stdlib/stats/base/dists/cosine/logcdf' ); 28 * 29 * var y = logcdf( 0.5, 0.0, 1.0 ); 30 * // returns ~-0.095 31 * 32 * var mylogcdf = logcdf.factory( 3.0, 1.5 ); 33 * 34 * y = mylogcdf( 4.0 ); 35 * // returns ~--0.029 36 */ 37 38 // MODULES // 39 40 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 41 var logcdf = require( './logcdf.js' ); 42 var factory = require( './factory.js' ); 43 44 45 // MAIN // 46 47 setReadOnly( logcdf, 'factory', factory ); 48 49 50 // EXPORTS // 51 52 module.exports = logcdf;