File tree Expand file tree Collapse file tree 4 files changed +5
-20
lines changed
lib/node_modules/@stdlib/stats/base/dists/degenerate/cdf Expand file tree Collapse file tree 4 files changed +5
-20
lines changed Original file line number Diff line number Diff line change 22
33@license Apache-2.0
44
5- Copyright (c) 2024 The Stdlib Authors.
5+ Copyright (c) 2018 The Stdlib Authors.
66
77Licensed under the Apache License, Version 2.0 (the "License");
88you may not use this file except in compliance with the License.
@@ -151,8 +151,8 @@ double y = stdlib_base_dists_degenerate_cdf( 2.0, 3.0 );
151151
152152The function accepts the following arguments:
153153
154- - ** x** : ` [in] double ` input value.
155- - ** mu** : ` [in] double ` constant value of distribution
154+ - ** x** : ` [in] double ` input value.
155+ - ** mu** : ` [in] double ` constant value of distribution.
156156
157157``` c
158158double stdlib_base_dists_degenerate_cdf ( const double x, const double mu );
Original file line number Diff line number Diff line change @@ -108,7 +108,7 @@ static double benchmark( void ) {
108108
109109 t = tic ();
110110 for ( i = 0 ; i < ITERATIONS ; i ++ ) {
111- y = stdlib_base_dists_degenerate_cdf ( x [ i % 100 ], mu [ i % 100 ] );
111+ y = stdlib_base_dists_degenerate_cdf ( x [ i % 100 ], mu [ i % 100 ] );
112112 if ( y != y ) {
113113 printf ( "should not return NaN\n" );
114114 break ;
Original file line number Diff line number Diff line change @@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' );
2828/**
2929* Evaluates the cumulative distribution function (CDF) for a degenerate distribution with mean value `mu`.
3030*
31+ * @private
3132* @param {number } x - input value
3233* @param {number } mu - constant value of distribution
3334* @returns {Probability } evaluated cumulative distribution function
Original file line number Diff line number Diff line change 2929* @example
3030* double y = stdlib_base_dists_degenerate_cdf( 2.0, 3.0 );
3131* // returns ~0.0
32- *
33- * @example
34- * double y = stdlib_base_dists_degenerate_cdf( 4.0, 3.0 );
35- * // returns ~1.0
36- *
37- * @example
38- * double y = stdlib_base_dists_degenerate_cdf( 3.0, 3.0 );
39- * // returns ~1.0
40- *
41- * @example
42- * double y = stdlib_base_dists_degenerate_cdf( NaN, 0.0 );
43- * // returns NaN
44- *
45- * @example
46- * double y = stdlib_base_dists_degenerate_cdf( 0.0, NaN );
47- * // returns NaN
4832*/
4933double stdlib_base_dists_degenerate_cdf ( const double x , const double mu ) {
5034 if ( stdlib_base_is_nan ( x ) || stdlib_base_is_nan ( mu ) ) {
You can’t perform that action at this time.
0 commit comments