docs: fix C examples

officiallyanee · kgryte · web-flow · commit f9dbbfaf48e1 · 2026-03-25T01:11:40.000-07:00
PR-URL: #11138 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/kurtosis/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/arcsine/kurtosis/src/main.c
@@ -28,7 +28,7 @@
 *
 * @example
 * double y = stdlib_base_dists_arcsine_kurtosis( 0.0, 1.0 );
-* // returns 1.5
+* // returns -1.5
 */
 double stdlib_base_dists_arcsine_kurtosis( const double a, const double b ) {
 	if (
diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/betaprime/logpdf/src/main.c
@@ -31,7 +31,7 @@
 * @return         evaluated logPDF
 *
 * @example
-* double y = stdlib_base_dists_beta_logpdf( 0.5, 1.0, 1.0 );
+* double y = stdlib_base_dists_betaprime_logpdf( 0.5, 1.0, 1.0 );
 * // returns ~-0.811
 */
 double stdlib_base_dists_betaprime_logpdf( const double x, const double alpha, const double beta ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/entropy/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/binomial/entropy/src/main.c
@@ -38,7 +38,7 @@
 * // returns NaN
 *
 * @example
-* double v = stdlib_base_dists_binomial_entropy( 20, NAN );
+* double v = stdlib_base_dists_binomial_entropy( 20, 0.0/0.0 );
 * // returns NaN
 */
 double stdlib_base_dists_binomial_entropy( const int32_t n, const double p ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/src/main.c
@@ -32,7 +32,7 @@ static const double ONE_OVER_PI = 0.3183098861837907;
 * @return          evaluated CDF
 *
 * @example
-* double y = stdlib_base_cauchy_cdf( 4.0, 0.0, 2.0 );
+* double y = stdlib_base_dists_cauchy_cdf( 4.0, 0.0, 2.0 );
 * // returns ~0.852
 */
 double stdlib_base_dists_cauchy_cdf( const double x, const double x0, const double gamma ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cauchy/pdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/cauchy/pdf/src/main.c
@@ -30,7 +30,7 @@
 * @return          evaluated PDF
 *
 * @example
-* double y = stdlib_base_weibull_pdf( 2.0, 1.0, 1.0 );
+* double y = stdlib_base_dists_cauchy_pdf( 2.0, 1.0, 1.0 );
 * // returns ~0.159
 */
 double stdlib_base_dists_cauchy_pdf( const double x, const double x0, const double gamma ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/chi/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/chi/logpdf/src/main.c
@@ -33,7 +33,7 @@
 *
 * @example
 * double y = stdlib_base_dists_chi_logpdf( 2.0, 2.0 );
-* // returns ~-1.309
+* // returns ~-1.307
 */
 double stdlib_base_dists_chi_logpdf( const double x, const double k ) {
 	double out;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/erlang/kurtosis/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/erlang/kurtosis/src/main.c
@@ -29,7 +29,7 @@
 * @return          excess kurtosis
 *
 * @example
-* double y = stdlib_base_dists_beta_kurtosis( 1, 1.0 );
+* double y = stdlib_base_dists_erlang_kurtosis( 1, 1.0 );
 * // returns 6.0
 */
 double stdlib_base_dists_erlang_kurtosis( const int32_t k, const double lambda ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/entropy/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/entropy/src/main.c
@@ -27,7 +27,7 @@
 * @return          entropy
 *
 * @example
-* double y = stdlib_base_exponential_entropy( 9.0 );
+* double y = stdlib_base_dists_exponential_entropy( 9.0 );
 * // returns ~-1.197
 */
 double stdlib_base_dists_exponential_entropy( const double lambda ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/mgf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/mgf/src/main.c
@@ -28,7 +28,7 @@
 * @return        evaluated MGF
 *
 * @example
-* double v = mgf( 2.0, 3.0 );
+* double v = stdlib_base_dists_exponential_mgf( 2.0, 3.0 );
 * // returns 3.0
 */
 double stdlib_base_dists_exponential_mgf( const double t, const double lambda ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/quantile/src/main.c
@@ -28,7 +28,7 @@
 * @return          quantile
 *
 * @example
-* double y = stdlib_base_exponential_quantile( 0.8, 1.0 );
+* double y = stdlib_base_dists_exponential_quantile( 0.8, 1.0 );
 * // returns ~1.609
 */
 double stdlib_base_dists_exponential_quantile( const double p, const double lambda ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/stdev/src/main.c
@@ -27,7 +27,7 @@
 *
 * @example
 * double y = stdlib_base_dists_exponential_stdev( 9.0 );
-* // returns ~0.333
+* // returns ~0.111
 */
 double stdlib_base_dists_exponential_stdev( const double lambda ) {
 	if ( stdlib_base_is_nan( lambda ) || lambda <= 0.0 ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/entropy/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/gumbel/entropy/src/main.c
@@ -29,7 +29,7 @@
 * @return        entropy
 *
 * @example
-* double y = stdlib_base_gumbel_entropy( 0.0, 1.0 );
+* double y = stdlib_base_dists_gumbel_entropy( 0.0, 1.0 );
 * // returns ~1.577
 */
 double stdlib_base_dists_gumbel_entropy( const double mu, const double beta ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/mean/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/gumbel/mean/src/main.c
@@ -28,7 +28,7 @@
 * @return        expected value
 *
 * @example
-* double y = stdlib_base_gumbel_mean( 0.0, 1.0 );
+* double y = stdlib_base_dists_gumbel_mean( 0.0, 1.0 );
 * // returns ~0.577
 */
 double stdlib_base_dists_gumbel_mean( const double mu, const double beta ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/median/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/gumbel/median/src/main.c
@@ -29,7 +29,7 @@ static const double LLN2 = -0.36651292058166432701243915823266946945426813397; /
 * @return        median
 *
 * @example
-* double y = stdlib_base_gumbel_median( 0.0, 1.0 );
+* double y = stdlib_base_dists_gumbel_median( 0.0, 1.0 );
 * // returns ~0.367
 */
 double stdlib_base_dists_gumbel_median( const double mu, const double beta ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/invgamma/mode/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/invgamma/mode/src/main.c
@@ -26,7 +26,7 @@
 * @return         mode
 *
 * @example
-* double y = stdlib_base_invgamma_mode( 1.0, 1.0 );
+* double y = stdlib_base_dists_invgamma_mode( 1.0, 1.0 );
 * // returns 0.5
 */
 double stdlib_base_dists_invgamma_mode( const double alpha, const double beta ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/cdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/cdf/src/main.c
@@ -29,7 +29,7 @@
 * @return     evaluated CDF
 *
 * @example
-* double y = stdlib_base_kumaraswamy_cdf( 0.5, 1.0, 1.0 );
+* double y = stdlib_base_dists_kumaraswamy_cdf( 0.5, 1.0, 1.0 );
 * // returns ~0.5
 */
 double stdlib_base_dists_kumaraswamy_cdf( const double x, const double a, const double b ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/quantile/src/main.c
@@ -29,7 +29,7 @@
 * @return    evaluated quantile function
 *
 * @example
-* var y = quantile( 0.5, 1.0, 1.0 );
+* double y = stdlib_base_dists_kumaraswamy_quantile( 0.5, 1.0, 1.0 );
 * // returns 0.5
 */
 double stdlib_base_dists_kumaraswamy_quantile( const double p, const double a, const double b ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/median/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/levy/median/src/main.c
@@ -31,8 +31,8 @@ static const double DENOM = 0.4549364231195728; // 2.0 * stdlib_base_pow( stdlib
 * @return      median
 *
 * @example
-* double y = stdlib_base_dists_levy_median( 9.0, 0.0, 10.0 );
-* // returns ~0.795
+* double y = stdlib_base_dists_levy_median( 0.0, 1.0 );
+* // returns ~2.198
 */
 double stdlib_base_dists_levy_median( const double mu, const double c ) {
 	if (
diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/levy/quantile/src/main.c
@@ -29,7 +29,7 @@
 * @return    evaluated quantile function
 *
 * @example
-* double y = stdlib_base_levy_quantile( 0.8, 0.0, 1.0 );
+* double y = stdlib_base_dists_levy_quantile( 0.8, 0.0, 1.0 );
 * // returns ~15.58
 */
 double stdlib_base_dists_levy_quantile( const double p, const double mu, const double c ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/variance/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/levy/variance/src/main.c
@@ -28,7 +28,7 @@
 * @return      variance
 *
 * @example
-* double y = stdlib_base_levy_variance( 0.0, 1.0 );
+* double y = stdlib_base_dists_levy_variance( 0.0, 1.0 );
 * // returns Infinity
 */
 double stdlib_base_dists_levy_variance( const double mu, const double c ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/pmf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/planck/pmf/src/main.c
@@ -31,7 +31,7 @@
 *
 * @example
 * double y = stdlib_base_dists_planck_pmf( 2.0, 0.5 );
-* // returns ~0.1839
+* // returns ~0.1447
 */
 double stdlib_base_dists_planck_pmf( const double x, const double lambda ) {
 	if ( stdlib_base_is_nan( x ) || stdlib_base_is_nan( lambda ) || lambda <= 0.0 ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/src/main.c
@@ -28,7 +28,7 @@
 *
 * @example
 * double y = stdlib_base_dists_rayleigh_mean( 9.0 );
-* // returns ~11.253
+* // returns ~11.2798
 */
 double stdlib_base_dists_rayleigh_mean( const double sigma ) {
 	if (
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/median/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/median/src/main.c
@@ -29,7 +29,7 @@ static const double SQRT2LN2 = 1.1774100225154747; // sqrt(2*ln(2))
 *
 * @example
 * double y = stdlib_base_dists_rayleigh_median( 9.0 );
-* // returns ~10.595
+* // returns ~10.597
 */
 double stdlib_base_dists_rayleigh_median( const double sigma ) {
 	if ( stdlib_base_is_nan( sigma ) || sigma < 0 ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/pdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/pdf/src/main.c
@@ -31,7 +31,7 @@
 *
 * @example
 * double y = stdlib_base_dists_rayleigh_pdf( 3.0, 1.0 );
-* // returns ~0.287
+* // returns ~0.0333
 */
 double stdlib_base_dists_rayleigh_pdf( const double x, const double sigma ) {
 	double s2;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/entropy/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/t/entropy/src/main.c
@@ -31,7 +31,7 @@
 *
 * @example
 * double y = stdlib_base_dists_t_entropy( 9.0 );
-* // returns ~1.553
+* // returns ~1.533
 */
 double stdlib_base_dists_t_entropy( const double v ) {
 	double out;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/t/logpdf/src/main.c
@@ -32,7 +32,7 @@
 *
 * @example
 * double y = stdlib_base_dists_t_logpdf( 0.5, 1.0 );
-* // returns ~-1.1447
+* // returns ~-1.368
 */
 double stdlib_base_dists_t_logpdf( const double x, const double v ) {
 	double betaTerm;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/triangular/quantile/src/main.c
@@ -30,7 +30,7 @@
 * @return     evaluated quantile function
 *
 * @example
-* double y = stdlib_base_triangular_quantile( 0.9, -1.0, 1.0, 0.0 );
+* double y = stdlib_base_dists_triangular_quantile( 0.9, -1.0, 1.0, 0.0 );
 * // returns ~0.553
 */
 double stdlib_base_dists_triangular_quantile( const double p, const double a, const double b, const double c ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/src/main.c
@@ -30,7 +30,7 @@
 * @return    evaluated logPDF
 *
 * @example
-* var y = logpdf( 2.0, 0.0, 4.0 );
+* double y = stdlib_base_dists_uniform_logpdf( 2.0, 0.0, 4.0 );
 * // returns ~-1.386
 */
 double stdlib_base_dists_uniform_logpdf( const double x, const double a, const double b ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c
@@ -29,7 +29,7 @@ static const double SQRT_ONE_TWELFTH = 0.28867513459481287; // stdlib_base_sqrt(
 * @return    standard deviation
 *
 * @example
-* double v = stdev( 4.0, 12.0 );
+* double v = stdlib_base_dists_uniform_stdev( 4.0, 12.0 );
 * // returns ~2.309
 */
 double stdlib_base_dists_uniform_stdev( const double a, const double b ) {

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@`
`28`	`28`	`*`
`29`	`29`	`* @example`
`30`	`30`	`* double y = stdlib_base_dists_arcsine_kurtosis( 0.0, 1.0 );`
`31`		`-* // returns 1.5`
	`31`	`+* // returns -1.5`
`32`	`32`	`*/`
`33`	`33`	`double stdlib_base_dists_arcsine_kurtosis( const double a, const double b ) {`
`34`	`34`	`if (`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`* @return evaluated logPDF`
`32`	`32`	`*`
`33`	`33`	`* @example`
`34`		`-* double y = stdlib_base_dists_beta_logpdf( 0.5, 1.0, 1.0 );`
	`34`	`+* double y = stdlib_base_dists_betaprime_logpdf( 0.5, 1.0, 1.0 );`
`35`	`35`	`* // returns ~-0.811`
`36`	`36`	`*/`
`37`	`37`	`double stdlib_base_dists_betaprime_logpdf( const double x, const double alpha, const double beta ) {`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@`
`38`	`38`	`* // returns NaN`
`39`	`39`	`*`
`40`	`40`	`* @example`
`41`		`-* double v = stdlib_base_dists_binomial_entropy( 20, NAN );`
	`41`	`+* double v = stdlib_base_dists_binomial_entropy( 20, 0.0/0.0 );`
`42`	`42`	`* // returns NaN`
`43`	`43`	`*/`
`44`	`44`	`double stdlib_base_dists_binomial_entropy( const int32_t n, const double p ) {`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ static const double ONE_OVER_PI = 0.3183098861837907;`
`32`	`32`	`* @return evaluated CDF`
`33`	`33`	`*`
`34`	`34`	`* @example`
`35`		`-* double y = stdlib_base_cauchy_cdf( 4.0, 0.0, 2.0 );`
	`35`	`+* double y = stdlib_base_dists_cauchy_cdf( 4.0, 0.0, 2.0 );`
`36`	`36`	`* // returns ~0.852`
`37`	`37`	`*/`
`38`	`38`	`double stdlib_base_dists_cauchy_cdf( const double x, const double x0, const double gamma ) {`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`* @return evaluated PDF`
`31`	`31`	`*`
`32`	`32`	`* @example`
`33`		`-* double y = stdlib_base_weibull_pdf( 2.0, 1.0, 1.0 );`
	`33`	`+* double y = stdlib_base_dists_cauchy_pdf( 2.0, 1.0, 1.0 );`
`34`	`34`	`* // returns ~0.159`
`35`	`35`	`*/`
`36`	`36`	`double stdlib_base_dists_cauchy_pdf( const double x, const double x0, const double gamma ) {`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`*`
`34`	`34`	`* @example`
`35`	`35`	`* double y = stdlib_base_dists_chi_logpdf( 2.0, 2.0 );`
`36`		`-* // returns ~-1.309`
	`36`	`+* // returns ~-1.307`
`37`	`37`	`*/`
`38`	`38`	`double stdlib_base_dists_chi_logpdf( const double x, const double k ) {`
`39`	`39`	`double out;`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`* @return excess kurtosis`
`30`	`30`	`*`
`31`	`31`	`* @example`
`32`		`-* double y = stdlib_base_dists_beta_kurtosis( 1, 1.0 );`
	`32`	`+* double y = stdlib_base_dists_erlang_kurtosis( 1, 1.0 );`
`33`	`33`	`* // returns 6.0`
`34`	`34`	`*/`
`35`	`35`	`double stdlib_base_dists_erlang_kurtosis( const int32_t k, const double lambda ) {`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`* @return entropy`
`28`	`28`	`*`
`29`	`29`	`* @example`
`30`		`-* double y = stdlib_base_exponential_entropy( 9.0 );`
	`30`	`+* double y = stdlib_base_dists_exponential_entropy( 9.0 );`
`31`	`31`	`* // returns ~-1.197`
`32`	`32`	`*/`
`33`	`33`	`double stdlib_base_dists_exponential_entropy( const double lambda ) {`