Skip to content

Commit 699f984

Browse files
committed
refactor: apply suggestions from previous PRs
--- 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: na - 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: na - task: lint_c_benchmarks status: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: passed - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent 3c6a7dd commit 699f984

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

lib/node_modules/@stdlib/stats/base/dists/hypergeometric/logpmf/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ for ( i = 0; i < 10; i++ ) {
185185

186186
#### stdlib_base_dists_hypergeometric_logpmf( x, N, K, n )
187187

188-
Evaluates the natural logarithm of the probability mass function (PMF) for a hypergeometric distribution.
188+
Evaluates the natural logarithm of the [probability mass function][pmf] (PMF) for a [hypergeometric][hypergeometric-distribution] distribution with parameters `N` (population size), `K` (subpopulation size), and `n` (number of draws).
189189

190190
```c
191191
double out = stdlib_base_dists_hypergeometric_logpmf( 1.0, 8, 4, 2 );

lib/node_modules/@stdlib/stats/base/dists/hypergeometric/logpmf/benchmark/c/benchmark.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@
1616
* limitations under the License.
1717
*/
1818

19-
#include <sys/time.h>
2019
#include "stdlib/math/base/special/round.h"
2120
#include "stdlib/stats/base/dists/hypergeometric/logpmf.h"
2221
#include <math.h>
2322
#include <stdio.h>
2423
#include <stdlib.h>
2524
#include <time.h>
25+
#include <sys/time.h>
2626

2727
#define NAME "hypergeometric-logpmf"
2828
#define ITERATIONS 1000000

lib/node_modules/@stdlib/stats/base/dists/hypergeometric/logpmf/src/main.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@
2525
#include "stdlib/math/base/special/min.h"
2626

2727
/**
28-
* Evaluates the natural logarithm of the probability mass function (PMF) for a hypergeometric distribution.
28+
* Evaluates the natural logarithm of the probability mass function (PMF) for a hypergeometric distribution with population size `N`, subpopulation size `K` and number of draws `n`.
2929
*
3030
* @param x input value
3131
* @param N population size
3232
* @param K subpopulation size
3333
* @param n number of draws
34-
* @return evaluated logPMF, or NaN if inputs are invalid
34+
* @return evaluated logPMF
3535
*
3636
* @example
3737
* double y = stdlib_base_dists_hypergeometric_logpmf( 1.0, 8, 4, 2 );

0 commit comments

Comments
 (0)