File tree Expand file tree Collapse file tree 4 files changed +4
-27
lines changed
lib/node_modules/@stdlib/stats/base/dists/beta/entropy Expand file tree Collapse file tree 4 files changed +4
-27
lines changed Original file line number Diff line number Diff line change @@ -182,8 +182,8 @@ double y = stdlib_base_dists_beta_entropy( 1.0, 1.0 );
182182
183183The function accepts the following arguments:
184184
185- - ** alpha** : ` [in] double ` first shape parameter
186- - ** beta** : ` [in] double ` second shape parameter
185+ - ** alpha** : ` [in] double ` first shape parameter.
186+ - ** beta** : ` [in] double ` second shape parameter.
187187
188188``` c
189189double stdlib_base_dists_beta_entropy ( const double alpha, const double beta );
Original file line number Diff line number Diff line change @@ -109,7 +109,7 @@ static double benchmark( void ) {
109109
110110 t = tic ();
111111 for ( i = 0 ; i < ITERATIONS ; i ++ ) {
112- y = stdlib_base_dists_beta_entropy ( alpha [ i % 100 ], beta [ i % 100 ] );
112+ y = stdlib_base_dists_beta_entropy ( alpha [ i % 100 ], beta [ i % 100 ] );
113113 if ( y != y ) {
114114 printf ( "should not return NaN\n" );
115115 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 differential entropy of a beta distribution.
3030*
31+ * @private
3132* @param {PositiveNumber } alpha - first shape parameter
3233* @param {PositiveNumber } beta - second shape parameter
3334* @returns {NonPositiveNumber } differential entropy
Original file line number Diff line number Diff line change 3030* @example
3131* double y = stdlib_base_dists_beta_entropy( 1.0, 1.0 );
3232* // returns ~0.0
33- *
34- * @example
35- * double y = stdlib_base_dists_beta_entropy( 4.0, 12.0 );
36- * // returns ~-0.869
37- *
38- * @example
39- * double y = stdlib_base_dists_beta_entropy( 8.0, 2.0 );
40- * // returns NaN
41- *
42- * @example
43- * double y = stdlib_base_dists_beta_entropy( 1.0, -0.1 );
44- * // returns NaN
45- *
46- * @example
47- * double y = stdlib_base_dists_beta_entropy( -0.1, 1.0 );
48- * // returns NaN
49- *
50- * @example
51- * double y = stdlib_base_dists_beta_entropy( 2.0, NaN );
52- * // returns NaN
53- *
54- * @example
55- * double y = stdlib_base_dists_beta_entropy( NaN, 2.0 );
56- * // returns NaN
5733*/
5834double stdlib_base_dists_beta_entropy ( const double alpha , const double beta ) {
5935 double out ;
You can’t perform that action at this time.
0 commit comments