Skip to content

Commit 27fca27

Browse files
chore: changes from code review
1 parent 756718e commit 27fca27

File tree

4 files changed

+4
-27
lines changed

4 files changed

+4
-27
lines changed

lib/node_modules/@stdlib/stats/base/dists/beta/entropy/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,8 @@ double y = stdlib_base_dists_beta_entropy( 1.0, 1.0 );
182182

183183
The 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
189189
double stdlib_base_dists_beta_entropy( const double alpha, const double beta );

lib/node_modules/@stdlib/stats/base/dists/beta/entropy/benchmark/c/benchmark.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff 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;

lib/node_modules/@stdlib/stats/base/dists/beta/entropy/lib/native.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff 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

lib/node_modules/@stdlib/stats/base/dists/beta/entropy/src/main.c

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -30,30 +30,6 @@
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
*/
5834
double stdlib_base_dists_beta_entropy( const double alpha, const double beta ) {
5935
double out;

0 commit comments

Comments
 (0)