Skip to content

Commit e96e673

Browse files
authored
chore: apply suggestions from code review
Signed-off-by: Philipp Burckhardt <[email protected]>
1 parent cd4fa38 commit e96e673

File tree

1 file changed

+1
-29
lines changed
  • lib/node_modules/@stdlib/stats/base/dists/betaprime/mode/src

1 file changed

+1
-29
lines changed

lib/node_modules/@stdlib/stats/base/dists/betaprime/mode/src/main.c

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -24,39 +24,11 @@
2424
* @param x input value
2525
* @param alpha first shape parameter
2626
* @param beta second shape parameter
27-
* @returns evaluated logPDF
27+
* @returns mode
2828
*
2929
* @example
3030
* double y = stdlib_base_dists_betaprime_mode( 1.0, 2.0 );
3131
* // returns ~0.0
32-
*
33-
* @example
34-
* double y = stdlib_base_dists_betaprime_mode( 4.0, 12.0 );
35-
* // returns ~0.231
36-
*
37-
* @example
38-
* double y = stdlib_base_dists_betaprime_mode( 8.0, 2.0 );
39-
* // returns ~2.333
40-
*
41-
* @example
42-
* double y = stdlib_base_dists_betaprime_mode( 1.0, 1.0 );
43-
* // returns ~0.0
44-
*
45-
* @example
46-
* double y = stdlib_base_dists_betaprime_mode( 1.0, -0.1 );
47-
* // returns NaN
48-
*
49-
* @example
50-
* double y = stdlib_base_dists_betaprime_mode( -0.1, 1.0 );
51-
* // returns NaN
52-
*
53-
* @example
54-
* double y = stdlib_base_dists_betaprime_mode( 2.0, NaN );
55-
* // returns NaN
56-
*
57-
* @example
58-
* double y = stdlib_base_dists_betaprime_mode( NaN, 2.0 );
59-
* // returns NaN
6032
*/
6133
double stdlib_base_dists_betaprime_mode( double alpha, const double beta ) {
6234
if ( alpha <= 0.0 || beta <= 0.0 ) {

0 commit comments

Comments
 (0)