Skip to content

Commit f2f4fb0

Browse files
committed
fix: apply suggestions
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent d6126f1 commit f2f4fb0

7 files changed

Lines changed: 21 additions & 16 deletions

File tree

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/median/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ logEachMap( 'α: %0.4f, β: %0.4f, Median(X;α,β): %0.4f', alpha, beta, median
169169

170170
#### stdlib_base_dists_pareto_type1_median( alpha, beta )
171171

172-
Returns the median of a Pareto (Type I) distribution.
172+
Returns the median of a Pareto (Type I) distribution with parameters `alpha` (shape parameter) and `beta` (scale parameter).
173173

174174
```c
175175
double y = stdlib_base_dists_pareto_type1_median( 8.0, 2.0 );
@@ -178,8 +178,8 @@ double y = stdlib_base_dists_pareto_type1_median( 8.0, 2.0 );
178178

179179
The function accepts the following arguments:
180180

181-
- **alpha**: `[in] double` first shape parameter.
182-
- **beta**: `[in] double` second shape parameter.
181+
- **alpha**: `[in] double` shape parameter.
182+
- **beta**: `[in] double` scale parameter.
183183

184184
```c
185185
double stdlib_base_dists_pareto_type1_median( const double alpha, const double beta );
@@ -205,6 +205,7 @@ double stdlib_base_dists_pareto_type1_median( const double alpha, const double b
205205
206206
```c
207207
#include "stdlib/stats/base/dists/pareto-type1/median.h"
208+
#include "stdlib/constants/float64/eps.h"
208209
#include <stdlib.h>
209210
#include <stdio.h>
210211
@@ -220,8 +221,8 @@ int main( void ) {
220221
int i;
221222
222223
for ( i = 0; i < 25; i++ ) {
223-
alpha = random_uniform( 3.0, 13.0 );
224-
beta = random_uniform( 0.0, 10.0 );
224+
alpha = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 10.0 );
225+
beta = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 10.0 );
225226
y = stdlib_base_dists_pareto_type1_median( alpha, beta );
226227
printf( "α: %lf, β: %lf, median(X;α,β): %lf\n", alpha, beta, y );
227228
}

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/median/benchmark/c/benchmark.c

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
*/
1818

1919
#include "stdlib/stats/base/dists/pareto-type1/median.h"
20+
#include "stdlib/constants/float64/eps.h"
2021
#include <stdlib.h>
2122
#include <stdio.h>
2223
#include <math.h>
@@ -92,16 +93,16 @@ static double random_uniform( const double min, const double max ) {
9293
* @return elapsed time in seconds
9394
*/
9495
static double benchmark( void ) {
95-
double elapsed;
9696
double alpha[ 100 ];
9797
double beta[ 100 ];
98+
double elapsed;
9899
double y;
99100
double t;
100101
int i;
101102

102103
for ( i = 0; i < 100; i++ ) {
103-
alpha[ i ] = random_uniform( 3.0, 13.0 );
104-
beta[ i ] = random_uniform( 3.0, 13.0 );
104+
alpha[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 10.0 );
105+
beta[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 10.0 );
105106
}
106107

107108
t = tic();

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/median/examples/c/example.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
*/
1818

1919
#include "stdlib/stats/base/dists/pareto-type1/median.h"
20+
#include "stdlib/constants/float64/eps.h"
2021
#include <stdlib.h>
2122
#include <stdio.h>
2223

@@ -32,8 +33,8 @@ int main( void ) {
3233
int i;
3334

3435
for ( i = 0; i < 25; i++ ) {
35-
alpha = random_uniform( 3.0, 13.0 );
36-
beta = random_uniform( 0.0, 10.0 );
36+
alpha = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 10.0 );
37+
beta = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 10.0 );
3738
y = stdlib_base_dists_pareto_type1_median( alpha, beta );
3839
printf( "α: %lf, β: %lf, median(X;α,β): %lf\n", alpha, beta, y );
3940
}

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/median/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 median of a Pareto (Type I) distribution.
3030
*
31+
* @private
3132
* @param {PositiveNumber} alpha - shape parameter
3233
* @param {PositiveNumber} beta - scale parameter
3334
* @returns {PositiveNumber} median

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/median/manifest.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@
5454
"libraries": [],
5555
"libpath": [],
5656
"dependencies": [
57-
"@stdlib/math/base/special/pow"
57+
"@stdlib/math/base/special/pow",
58+
"@stdlib/constants/float64/eps"
5859
]
5960
},
6061
{
@@ -69,7 +70,8 @@
6970
"libraries": [],
7071
"libpath": [],
7172
"dependencies": [
72-
"@stdlib/math/base/special/pow"
73+
"@stdlib/math/base/special/pow",
74+
"@stdlib/constants/float64/eps"
7375
]
7476
}
7577
]

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/median/src/addon.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,4 @@
1919
#include "stdlib/stats/base/dists/pareto-type1/median.h"
2020
#include "stdlib/math/base/napi/binary.h"
2121

22-
// cppcheck-suppress shadowFunction
2322
STDLIB_MATH_BASE_NAPI_MODULE_DD_D( stdlib_base_dists_pareto_type1_median )

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/median/src/main.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@
2222
/**
2323
* Returns the median of a Pareto (Type I) distribution.
2424
*
25-
* @param {PositiveNumber} alpha - shape parameter
26-
* @param {PositiveNumber} beta - scale parameter
27-
* @returns {PositiveNumber} median
25+
* @param alpha shape parameter
26+
* @param beta scale parameter
27+
* @return median
2828
*
2929
* @example
3030
* var v = median( 4.0, 12.0 );

0 commit comments

Comments
 (0)