Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,14 +4,37 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-04-29)
+## Unreleased (2025-07-25)
+
+<section class="features">
+
+### Features
+
+-   [`394df9c`](https://github.com/stdlib-js/stdlib/commit/394df9cbfe1e319625331814813bfffb5113d8d6) - add C implementation for `stats/base/dists/binomial/entropy` [(#4016)](https://github.com/stdlib-js/stdlib/pull/4016)
+
+</section>
+
+<!-- /.features -->
+
+<section class="issues">
+
+### Closed Issues
+
+This release closes the following issue:
+
+[#3466](https://github.com/stdlib-js/stdlib/issues/3466)
+
+</section>
+
+<!-- /.issues -->
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`394df9c`](https://github.com/stdlib-js/stdlib/commit/394df9cbfe1e319625331814813bfffb5113d8d6) - **feat:** add C implementation for `stats/base/dists/binomial/entropy` [(#4016)](https://github.com/stdlib-js/stdlib/pull/4016) _(by Divyansh Seth, Philipp Burckhardt, stdlib-bot)_
 -   [`c1df69c`](https://github.com/stdlib-js/stdlib/commit/c1df69ccf92f1ce80f08883226dd4252644f0324) - **docs:** replace manual `for` loop in examples [(#6848)](https://github.com/stdlib-js/stdlib/pull/6848) _(by Harsh, Athan Reines)_
 -   [`7279e43`](https://github.com/stdlib-js/stdlib/commit/7279e433dc1936056560624b5892eea8d9350ef1) - **bench:** update random value generation [(#6853)](https://github.com/stdlib-js/stdlib/pull/6853) _(by Harsh)_
 -   [`af55f0d`](https://github.com/stdlib-js/stdlib/commit/af55f0d6d6b4d06c36f46357740ea89a4639ab5b) - **bench:** refactor random number generation in `stats/base/dists/binomial` [(#4841)](https://github.com/stdlib-js/stdlib/pull/4841) _(by Karan Anand)_
@@ -26,11 +49,13 @@
 
 ### Contributors
 
-A total of 3 people contributed to this release. Thank you to the following contributors:
+A total of 5 people contributed to this release. Thank you to the following contributors:
 
 -   Athan Reines
+-   Divyansh Seth
 -   Harsh
 -   Karan Anand
+-   Philipp Burckhardt
 
 </section>
 

CONTRIBUTORS

@@ -21,11 +21,17 @@ Ali Salesi <ali_sal1381@yahoo.com>
 AlyAbdelmoneim <148393799+AlyAbdelmoneim@users.noreply.github.com>
 Aman Bhansali <bhansali.1@iitj.ac.in>
 AmanBhadkariya <140033975+AmanBhadkariya@users.noreply.github.com>
+Amisha Chhajed <136238836+amishhaa@users.noreply.github.com>
 Amit Jimiwal <amitjimiwal45@gmail.com>
+Anmol Sah <113588714+anmolsah@users.noreply.github.com>
+Annamalai Prabu <apfossdev@gmail.com>
 Anshu Kumar <132515490+anxhukumar@users.noreply.github.com>
 Anshu Kumar <contact.anshukumar@protonmail.com>
 Anudeep Sanapala <anudeep0306@gmail.com>
+Arihant Pal <arihant0pal@gmail.com>
+Aryan Bhirud <112156883+AryanBhirud@users.noreply.github.com>
 Athan Reines <kgryte@gmail.com>
+Atharva Patil <124063987+atharva-patil-23@users.noreply.github.com>
 Ayaka <73595362+USERSATOSHI@users.noreply.github.com>
 Bhavishy Agrawal <90029607+bhavishy2801@users.noreply.github.com>
 Brendan Graetz <bguiz@users.noreply.github.com>
@@ -34,10 +40,13 @@ Bryan Elee <rxbryn@gmail.com>
 Chinmay Joshi <86140365+JawHawk@users.noreply.github.com>
 Christopher Dambamuromo <chridam@gmail.com>
 Dan Rose <danoftheroses@gmail.com>
+Daniel Hernandez Gomez <156333015+dhernandeez13@users.noreply.github.com>
 Daniel Killenberger <daniel.killenberger@gmail.com>
 Daniel Yu <40680511+Daniel777y@users.noreply.github.com>
 Debashis Maharana <debashismaharana7854@gmail.com>
 Deep Trivedi <128926685+thedeeppp@users.noreply.github.com>
+Deepak Singh <78257493+Deepak91168@users.noreply.github.com>
+Deepak Singh <negid0253@gmail.com>
 Desh Deepak Kant <118960904+DeshDeepakKant@users.noreply.github.com>
 Dev Goel <135586571+corsairier@users.noreply.github.com>
 Dhanyabad behera <110620935+dhanyabad11@users.noreply.github.com>
@@ -53,14 +62,19 @@ Frank Kovacs <fran70kk@gmail.com>
 GK Bishnoi <gkishan1kyt@gmail.com>
 GURU PRASAD SHARMA <168292003+GURUPRASADSHARMA@users.noreply.github.com>
 Gaurav <gaurav70380@gmail.com>
+Gautam Kaushik <162317291+Kaushikgtm@users.noreply.github.com>
 Gautam sharma <gautamkrishnasharma1@gmail.com>
+GeoDaoyu <geodaoyu@foxmail.com>
+Girish Garg <garggirish2020@gmail.com>
 Golden Kumar <103646877+AuenKr@users.noreply.github.com>
 Gunj Joshi <gunjjoshi8372@gmail.com>
 Gururaj Gurram <gururajgurram1512@gmail.com>
+Harishchandra Reddy <harish.7000@gmail.com>
 Haroon Rasheed <51189276+haroon26@users.noreply.github.com>
-Harsh <149176984+hrshya@users.noreply.github.com>
+Harsh <harshyadav6078@gmail.com>
 HarshaNP <96897754+GittyHarsha@users.noreply.github.com>
 Harshita Kalani <harshitakalani02@gmail.com>
+Hemang Choudhary <coehemang@gmail.com>
 Hemant M Mehta <92446645+hemantmm@users.noreply.github.com>
 Hridyanshu <124202756+HRIDYANSHU054@users.noreply.github.com>
 Jaimin Godhani <112328542+Jai0401@users.noreply.github.com>
@@ -78,6 +92,7 @@ Joris Labie <joris.labie1@gmail.com>
 Justin Dennison <justin1dennison@gmail.com>
 Justyn Shelby <96994781+ShelbyJustyn@users.noreply.github.com>
 Karan Anand <anandkarancompsci@gmail.com>
+Karan Vasudevamurthy <karanlvm123@gmail.com>
 Karan Yadav <77043443+karanBRAVO@users.noreply.github.com>
 Karthik Prakash <116057817+skoriop@users.noreply.github.com>
 Kaushikgtm <162317291+Kaushikgtm@users.noreply.github.com>
@@ -86,6 +101,8 @@ Kohantika Nath <145763549+kohantikanath@users.noreply.github.com>
 Krishnam Agarwal <83017176+888krishnam@users.noreply.github.com>
 Krishnendu Das <86651039+itskdhere@users.noreply.github.com>
 Kshitij-Dale <152467202+Kshitij-Dale@users.noreply.github.com>
+Lalit Narayan Yadav <162928571+LalitNarayanYadav@users.noreply.github.com>
+Lokesh Ranjan <lokesh.ranjan.phe23@itbhu.ac.in>
 Lovelin Dhoni J B <100030865+lovelindhoni@users.noreply.github.com>
 MANI <77221000+Eternity0207@users.noreply.github.com>
 Mahfuza Humayra Mohona <mhmohona@gmail.com>
@@ -114,6 +131,7 @@ Ognjen Jevremović <ognjenjevremovic@users.noreply.github.com>
 Oneday12323 <107678750+Oneday12323@users.noreply.github.com>
 Ori Miles <97595296+orimiles5@users.noreply.github.com>
 Philipp Burckhardt <pburckhardt@outlook.com>
+Pierre Forstmann <15964998+pierreforstmann@users.noreply.github.com>
 Prajjwal Bajpai <142303989+prajjwalbajpai@users.noreply.github.com>
 Prajwal Kulkarni <prajwalkulkarni76@gmail.com>
 Pranav Goswami <pranavchiku11@gmail.com>
@@ -143,16 +161,19 @@ Ryan Seal <splrk@users.noreply.github.com>
 Rylan Yang <137365285+rylany27@users.noreply.github.com>
 SAHIL KUMAR <168997976+sahilk45@users.noreply.github.com>
 SHIVAM YADAV <120725381+Shivam-1827@users.noreply.github.com>
+Sachin Raj <120590207+schnrj@users.noreply.github.com>
 Sahil Goyal <87982509+sahil20021008@users.noreply.github.com>
 Sai Avinash <120403424+nasarobot@users.noreply.github.com>
 Sai Srikar Dumpeti <80447788+the-r3aper7@users.noreply.github.com>
 Sanchay Ketan Sinha <122982233+satansin123@users.noreply.github.com>
 Sarthak Paandey <145528240+SarthakPaandey@users.noreply.github.com>
+Satyajeet Chavan <chavansatyajeet2004@gmail.com>
 Saurabh Singh <saurabhsraghuvanshi@gmail.com>
 Seyyed Parsa Neshaei <spneshaei@users.noreply.github.com>
 Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com>
 Shashank Shekhar Singh <shashankshekharsingh1205@gmail.com>
 Shivam Ahir <11shivam00@gmail.com>
+Shivansh <114570926+shiv343@users.noreply.github.com>
 Shraddheya Shendre <shendreshraddheya@gmail.com>
 Shubh Mehta <93862397+Shubh942@users.noreply.github.com>
 Shubham Mishra <shubh622005@gmail.com>
@@ -163,14 +184,19 @@ Spandan Barve <contact@marsian.dev>
 Stephannie Jiménez Gacha <steff456@hotmail.com>
 Suhaib Ilahi <suhaib.elahi87@gmail.com>
 Suraj Kumar <125961509+kumarsuraj212003@users.noreply.github.com>
+Swapnil Hajare <69076366+Swapnil-2502@users.noreply.github.com>
 Tanishq Ahuja <68651083+TheGEN1U5@users.noreply.github.com>
 Tirtadwipa Manunggal <tirtadwipa.manunggal@gmail.com>
 Tudor Pagu <104032457+tudor-pagu@users.noreply.github.com>
 Tufailahmed Bargir <142114244+Tufailahmed-Bargir@users.noreply.github.com>
+Tushar Bhardwaj <155543597+TusharBhardwaj441@users.noreply.github.com>
+Uday Kakade <141299403+udaykakade25@users.noreply.github.com>
+Ujjwal Kirti <64329707+ujjwalkirti@users.noreply.github.com>
 Utkarsh <http://utkarsh11105@gmail.com>
 Utkarsh Raj <rajutkarsh2505@gmail.com>
 UtkershBasnet <119008923+UtkershBasnet@users.noreply.github.com>
 Vaibhav Patel <98279986+noobCoderVP@users.noreply.github.com>
+Vara Rahul Rajana <123227543+rajanarahul93@users.noreply.github.com>
 Varad Gupta <varadgupta21@gmail.com>
 Vinit Pandit <106718914+MeastroZI@users.noreply.github.com>
 Vivek Maurya <vm8118134@gmail.com>
@@ -179,14 +205,17 @@ Yaswanth Kosuru <116426380+yaswanthkosuru@users.noreply.github.com>
 Yernar Yergaziyev <yernar.yergaziyev@erg.kz>
 Yugal Kaushik <yugalkaushik14@gmail.com>
 Yuvi Mittal <128018763+yuvi-mittal@users.noreply.github.com>
+deepak427 <62477872+deepak427@users.noreply.github.com>
 devshree-bhati <147095250+devshree-bhati@users.noreply.github.com>
 ditsu <170345142+ditsus@users.noreply.github.com>
 ekambains <bainsinbusiness@gmail.com>
 fadiothman22 <48636283+fadiothman22@users.noreply.github.com>
 iraandrushko <71790513+iraandrushko@users.noreply.github.com>
+jsai28 <54253219+jsai28@users.noreply.github.com>
 lohithganni <116790357+lohithganni@users.noreply.github.com>
 olenkabilonizhka <62379231+olenkabilonizhka@users.noreply.github.com>
 pranav-1720 <123018993+pranav-1720@users.noreply.github.com>
 rahulrangers <127782777+rahulrangers@users.noreply.github.com>
 rainn <88160429+AmCodesLame@users.noreply.github.com>
 rei2hu <reimu@reimu.ws>
+zhanggy <geodaoyu@foxmail.com>

README.md

@@ -171,6 +171,106 @@ logEachMap( 'n: %0.4f, p: %0.4f, H(X;n,p): %0.4f', n, p, entropy );
 
 <!-- /.examples -->
 
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/stats/base/dists/binomial/entropy.h"
+```
+
+#### stdlib_base_dists_binomial_entropy( n, p )
+
+Evaluates the [entropy][entropy] of a [Binomial][binomial-distribution] distribution with `n` the number of trials and `p` the success probability.
+
+```c
+double out = stdlib_base_dists_binomial_entropy( 20, 0.1 );
+// returns ~1.667
+```
+
+The function accepts the following arguments:
+
+-   **n**: `[in] int32_t` number of trials.
+-   **p**: `[in] double` success probability.
+
+```c
+double stdlib_base_dists_binomial_entropy( const int32_t n, const double p );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/stats/base/dists/binomial/entropy.h"
+#include <stdlib.h>
+#include <stdio.h>
+#include <stdint.h>
+
+static double random_uniform( const double min, const double max ) {
+    double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
+    return min + ( v*(max-min) );
+}
+
+static int32_t random_int( const int32_t min, const int32_t max ) {
+    return min + (int32_t)( random_uniform( 0.0, 1.0 ) * ( max - min + 1 ) );
+}
+
+int main( void ) {
+    int32_t n;
+    double p;
+    double v;
+    int i;
+
+    for ( i = 0; i < 25; i++ ) {
+        n = random_int( 0, 100 );
+        p = random_uniform( 0.0, 1.0 );
+        v = stdlib_base_dists_binomial_entropy( n, p );
+        printf( "n: %d, p: %lf, H(X;n,p): %lf\n", n, p, v );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
 
 <section class="references">

benchmark/benchmark.native.js

@@ -0,0 +1,66 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var resolve = require( 'path' ).resolve;
+var bench = require( '@stdlib/bench-harness' );
+var uniform = require( '@stdlib/random-array-uniform' );
+var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
+var tryRequire = require( '@stdlib/utils-try-require' );
+var isnan = require( '@stdlib/math-base-assert-is-nan' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var entropy = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+	'skip': ( entropy instanceof Error )
+};
+
+
+// MAIN //
+
+bench( pkg+'::native', opts, function benchmark( b ) {
+	var len;
+	var n;
+	var p;
+	var y;
+	var i;
+
+	len = 100;
+	n = discreteUniform( len, 0, 100 );
+	p = uniform( len, 0.0, 1.0 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = entropy( n[ i % len ], p[ i % len ] );
+		if ( isnan( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});