File tree Expand file tree Collapse file tree 4 files changed +4
-15
lines changed
lib/node_modules/@stdlib/stats/base/dists/degenerate/entropy Expand file tree Collapse file tree 4 files changed +4
-15
lines changed Original file line number Diff line number Diff line change @@ -149,7 +149,7 @@ double y = stdlib_base_dists_degenerate_entropy( 0.1 );
149149
150150The function accepts the following arguments:
151151
152- - ** mu** : ` [in] double ` constant value of distribution
152+ - ** mu** : ` [in] double ` constant value of distribution.
153153
154154``` c
155155double stdlib_base_dists_degenerate_entropy ( const double mu );
Original file line number Diff line number Diff line change @@ -104,7 +104,7 @@ static double benchmark( void ) {
104104
105105 t = tic ();
106106 for ( i = 0 ; i < ITERATIONS ; i ++ ) {
107- y = stdlib_base_dists_degenerate_entropy ( mu [ i % 100 ] );
107+ y = stdlib_base_dists_degenerate_entropy ( mu [ i % 100 ] );
108108 if ( y != y ) {
109109 printf ( "should not return NaN\n" );
110110 break ;
Original file line number Diff line number Diff line change @@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' );
2828/**
2929* Returns the entropy of a degenerate distribution.
3030*
31+ * @private
3132* @param {number } mu - constant value of distribution
3233* @returns {NonNegativeNumber } entropy
3334*
Original file line number Diff line number Diff line change 2323* Returns the entropy of a degenerate distribution with constant value `mu`.
2424*
2525* @param mu constant value of distribution
26- * @returns Entropy
26+ * @returns entropy
2727*
2828* @example
2929* double y = stdlib_base_dists_degenerate_entropy( 0.1 );
3030* // returns ~0.0
31- *
32- * @example
33- * double y = stdlib_base_dists_degenerate_entropy( 0.5 );
34- * // returns ~0.0
35- *
36- * @example
37- * double y = stdlib_base_dists_degenerate_entropy( 10.0 );
38- * // returns ~0.0
39- *
40- * @example
41- * double y = stdlib_base_dists_degenerate_entropy( NaN );
42- * // returns NaN
4331*/
4432double stdlib_base_dists_degenerate_entropy ( const double mu ) {
4533 if ( stdlib_base_is_nan ( mu ) ) {
You can’t perform that action at this time.
0 commit comments