Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) {
Expand Down
Loading