index.js (1228B)
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 * Normal distribution cumulative distribution function (CDF). 23 * 24 * @module @stdlib/stats/base/dists/normal/cdf 25 * 26 * @example 27 * var cdf = require( '@stdlib/stats/base/dists/normal/cdf' ); 28 * 29 * var y = cdf( 2.0, 0.0, 1.0 ); 30 * // returns ~0.977 31 * 32 * var myCDF = cdf.factory( 10.0, 2.0 ); 33 * y = myCDF( 10.0 ); 34 * // returns 0.5 35 */ 36 37 // MODULES // 38 39 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 40 var cdf = require( './cdf.js' ); 41 var factory = require( './factory.js' ); 42 43 44 // MAIN // 45 46 setReadOnly( cdf, 'factory', factory ); 47 48 49 // EXPORTS // 50 51 module.exports = cdf;