docs: fix function names in C example code

Planeshifter · Planeshifter · commit ba0c854e87d0 · 2025-02-08T12:24:30.000-05:00
---
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: na
  - 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: passed
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - 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: na
  - task: run_c_benchmarks
    status: na
  - 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
---
diff --git a/lib/node_modules/@stdlib/math/base/special/boxcox1pinv/src/main.c b/lib/node_modules/@stdlib/math/base/special/boxcox1pinv/src/main.c
@@ -30,7 +30,7 @@
 * @return          inverse of the Box-Cox transformation
 *
 * @example
-* double v = boxcox1pinv( 1.0, 2.5 );
+* double v = stdlib_base_boxcox1pinv( 1.0, 2.5 );
 * // returns ~0.6505
 */
 double stdlib_base_boxcox1pinv( const double y, const double lambda ) {
diff --git a/lib/node_modules/@stdlib/math/base/special/boxcoxinv/src/main.c b/lib/node_modules/@stdlib/math/base/special/boxcoxinv/src/main.c
@@ -29,7 +29,7 @@
 * @return          inverse of the Box-Cox transformation
 *
 * @example
-* double v = boxcoxinv( 1.0, 2.5 );
+* double v = stdlib_base_boxcoxinv( 1.0, 2.5 );
 * // returns ~1.6505
 */
 double stdlib_base_boxcoxinv( const double y, const double lambda ) {
diff --git a/lib/node_modules/@stdlib/math/base/special/gammasgn/src/main.c b/lib/node_modules/@stdlib/math/base/special/gammasgn/src/main.c
@@ -27,7 +27,7 @@
 * @return        sign of the gamma function
 *
 * @example
-* double v = gammasgn( 1.0 );
+* double v = stdlib_base_gammasgn( 1.0 );
 * // returns 1.0
 */
 double stdlib_base_gammasgn( const double x ) {
diff --git a/lib/node_modules/@stdlib/math/base/special/rampf/src/rampf.c b/lib/node_modules/@stdlib/math/base/special/rampf/src/rampf.c
@@ -26,11 +26,11 @@
 * @return        function value
 *
 * @example
-* float v = rampf( 3.14 );
+* float v = stdlib_base_rampf( 3.14 );
 * // returns 3.14
 *
 * @example
-* float v = rampf( -3.14 );
+* float v = stdlib_base_rampf( -3.14 );
 * // returns 0.0
 */
 float stdlib_base_rampf( const float x ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/mode/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/arcsine/mode/src/main.c
@@ -27,7 +27,7 @@
 * @return     mode
 *
 * @example
-* double v = mode( -4.0, 4.0 );
+* double v = stdlib_base_dists_arcsine_mode( -4.0, 4.0 );
 * // returns -4.0
 */
 double stdlib_base_dists_arcsine_mode( const double a, const double b ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/poisson/mean/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/poisson/mean/src/main.c
@@ -26,7 +26,7 @@
 * @return          expected value
 *
 * @example
-* double v = mean( 9.0 );
+* double v = stdlib_base_dists_poisson_mean( 9.0 );
 * // returns 9.0
 */
 double stdlib_base_dists_poisson_mean( const double lambda ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/entropy/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/entropy/src/main.c
@@ -28,7 +28,7 @@
 * @return    differential entropy
 *
 * @example
-* double v = entropy( 0.0, 1.0 );
+* double v = stdlib_base_dists_uniform_entropy( 0.0, 1.0 );
 * // returns 0.0
 */
 double stdlib_base_dists_uniform_entropy( const double a, const double b ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/pdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/pdf/src/main.c
@@ -28,7 +28,7 @@
 * @return     evaluated PDF
 *
 * @example
-* double y = pdf( 2.0, 0.0, 4.0 );
+* double y = stdlib_base_dists_uniform_pdf( 2.0, 0.0, 4.0 );
 * // returns 0.25
 */
 double stdlib_base_dists_uniform_pdf( const double x, const double a, const double b ) {

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`* @return inverse of the Box-Cox transformation`
`31`	`31`	`*`
`32`	`32`	`* @example`
`33`		`-* double v = boxcox1pinv( 1.0, 2.5 );`
	`33`	`+* double v = stdlib_base_boxcox1pinv( 1.0, 2.5 );`
`34`	`34`	`* // returns ~0.6505`
`35`	`35`	`*/`
`36`	`36`	`double stdlib_base_boxcox1pinv( const double y, const double lambda ) {`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`* @return inverse of the Box-Cox transformation`
`30`	`30`	`*`
`31`	`31`	`* @example`
`32`		`-* double v = boxcoxinv( 1.0, 2.5 );`
	`32`	`+* double v = stdlib_base_boxcoxinv( 1.0, 2.5 );`
`33`	`33`	`* // returns ~1.6505`
`34`	`34`	`*/`
`35`	`35`	`double stdlib_base_boxcoxinv( const double y, const double lambda ) {`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`* @return sign of the gamma function`
`28`	`28`	`*`
`29`	`29`	`* @example`
`30`		`-* double v = gammasgn( 1.0 );`
	`30`	`+* double v = stdlib_base_gammasgn( 1.0 );`
`31`	`31`	`* // returns 1.0`
`32`	`32`	`*/`
`33`	`33`	`double stdlib_base_gammasgn( const double x ) {`
Original file line number	Diff line number	Diff line change
`@@ -26,11 +26,11 @@`
`26`	`26`	`* @return function value`
`27`	`27`	`*`
`28`	`28`	`* @example`
`29`		`-* float v = rampf( 3.14 );`
	`29`	`+* float v = stdlib_base_rampf( 3.14 );`
`30`	`30`	`* // returns 3.14`
`31`	`31`	`*`
`32`	`32`	`* @example`
`33`		`-* float v = rampf( -3.14 );`
	`33`	`+* float v = stdlib_base_rampf( -3.14 );`
`34`	`34`	`* // returns 0.0`
`35`	`35`	`*/`
`36`	`36`	`float stdlib_base_rampf( const float x ) {`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`* @return expected value`
`27`	`27`	`*`
`28`	`28`	`* @example`
`29`		`-* double v = mean( 9.0 );`
	`29`	`+* double v = stdlib_base_dists_poisson_mean( 9.0 );`
`30`	`30`	`* // returns 9.0`
`31`	`31`	`*/`
`32`	`32`	`double stdlib_base_dists_poisson_mean( const double lambda ) {`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@`
`28`	`28`	`* @return differential entropy`
`29`	`29`	`*`
`30`	`30`	`* @example`
`31`		`-* double v = entropy( 0.0, 1.0 );`
	`31`	`+* double v = stdlib_base_dists_uniform_entropy( 0.0, 1.0 );`
`32`	`32`	`* // returns 0.0`
`33`	`33`	`*/`
`34`	`34`	`double stdlib_base_dists_uniform_entropy( const double a, const double b ) {`