@stdlib/stats-base-dists-exponential-entropy 0.2.1 → 0.3.0

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2026 The Stdlib Authors.

package/README.md

@@ -116,18 +116,103 @@ var v = entropy( -1.0 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var randu = require( '@stdlib/random-base-randu' );
-var round = require( '@stdlib/math-base-special-round' );
+var uniform = require( '@stdlib/random-array-uniform' );
+var logEachMap = require( '@stdlib/console-log-each-map' );
 var entropy = require( '@stdlib/stats-base-dists-exponential-entropy' );
 
-var lambda;
-var v;
-var i;
+var opts = {
+    'dtype': 'float64'
+};
+var lambda = uniform( 10, 0.0, 20.0, opts );
 
-for ( i = 0; i < 10; i++ ) {
-    lambda = randu() * 20.0;
-    v = entropy( lambda );
-    console.log( 'λ: %d, h(X;λ): %d', lambda.toFixed( 4 ), v.toFixed( 4 ) );
+logEachMap( 'λ: %0.4f, h(X;λ): %0.4f', lambda, entropy );
+```
+
+</section>
+
+<!-- /.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/exponential/entropy.h"
+```
+
+#### stdlib_base_dists_exponential_entropy( lambda )
+
+Returns the [differential entropy][entropy] of an [exponential][exponential-distribution] distribution with rate parameter `lambda` (in [nats][nats]).
+
+```c
+double out = stdlib_base_dists_exponential_entropy( 9.0 );
+// returns ~-1.197
+```
+
+The function accepts the following arguments:
+
+-   **lambda**: `[in] double` rate parameter.
+
+```c
+double stdlib_base_dists_exponential_entropy( const double lambda );
+```
+
+</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/exponential/entropy.h"
+#include <stdlib.h>
+#include <stdio.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) );
+}
+
+int main( void ) {
+    double lambda;
+    double y;
+    int i;
+
+    for ( i = 0; i < 25; i++ ) {
+        lambda = random_uniform( 0.0, 20.0 );
+        y = stdlib_base_dists_exponential_entropy( lambda );
+        printf( "λ: %lf, h(X;λ): %lf\n", lambda, y );
+    }
 }
 ```
 
@@ -135,6 +220,10 @@ for ( i = 0; i < 10; i++ ) {
 
 <!-- /.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">
@@ -177,7 +266,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -190,8 +279,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-exponential-entropy.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-exponential-entropy
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-exponential-entropy/actions/workflows/test.yml/badge.svg?branch=v0.2.1
-[test-url]: https://github.com/stdlib-js/stats-base-dists-exponential-entropy/actions/workflows/test.yml?query=branch:v0.2.1
+[test-image]: https://github.com/stdlib-js/stats-base-dists-exponential-entropy/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-exponential-entropy/actions/workflows/test.yml?query=branch:v0.3.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-exponential-entropy/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-exponential-entropy?branch=main
@@ -203,8 +292,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 -->
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
+[chat-url]: https://stdlib.zulipchat.com
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/dist/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../lib/main.js", "../lib/index.js"],
-  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar ln = require( '@stdlib/math-base-special-ln' );\n\n\n// MAIN //\n\n/**\n* Returns the entropy of an exponential distribution.\n*\n* @param {NonNegativeNumber} lambda - rate parameter\n* @returns {number} entropy\n*\n* @example\n* var v = entropy( 9.0 );\n* // returns ~-1.197\n*\n* @example\n* var v = entropy( 1.0 );\n* // returns 1.0\n*\n* @example\n* var v = entropy( -0.2 );\n* // returns NaN\n*\n* @example\n* var v = entropy( NaN );\n* // returns NaN\n*/\nfunction entropy( lambda ) {\n\tif ( isnan( lambda ) || lambda < 0.0 ) {\n\t\treturn NaN;\n\t}\n\treturn 1.0 - ln( lambda );\n}\n\n\n// EXPORTS //\n\nmodule.exports = entropy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Exponential distribution differential entropy.\n*\n* @module @stdlib/stats-base-dists-exponential-entropy\n*\n* @example\n* var entropy = require( '@stdlib/stats-base-dists-exponential-entropy' );\n*\n* var v = entropy( 11.0 );\n* // returns ~-1.398\n*\n* v = entropy( 4.5 );\n* // returns ~-0.504\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar ln = require( '@stdlib/math-base-special-ln' );\n\n\n// MAIN //\n\n/**\n* Returns the differential entropy of an exponential distribution.\n*\n* @param {NonNegativeNumber} lambda - rate parameter\n* @returns {number} differential entropy\n*\n* @example\n* var v = entropy( 9.0 );\n* // returns ~-1.197\n*\n* @example\n* var v = entropy( 1.0 );\n* // returns 1.0\n*\n* @example\n* var v = entropy( -0.2 );\n* // returns NaN\n*\n* @example\n* var v = entropy( NaN );\n* // returns NaN\n*/\nfunction entropy( lambda ) {\n\tif ( isnan( lambda ) || lambda < 0.0 ) {\n\t\treturn NaN;\n\t}\n\treturn 1.0 - ln( lambda );\n}\n\n\n// EXPORTS //\n\nmodule.exports = entropy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Exponential distribution differential entropy.\n*\n* @module @stdlib/stats-base-dists-exponential-entropy\n*\n* @example\n* var entropy = require( '@stdlib/stats-base-dists-exponential-entropy' );\n*\n* var v = entropy( 11.0 );\n* // returns ~-1.398\n*\n* v = entropy( 4.5 );\n* // returns ~-0.504\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
   "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,iCAAkC,EACnDC,EAAK,QAAS,8BAA+B,EA2BjD,SAASC,EAASC,EAAS,CAC1B,OAAKH,EAAOG,CAAO,GAAKA,EAAS,EACzB,IAED,EAAMF,EAAIE,CAAO,CACzB,CAKAJ,EAAO,QAAUG,ICvBjB,IAAIE,EAAO,IAKX,OAAO,QAAUA",
   "names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "ln", "entropy", "lambda", "main"]
 }

package/docs/types/index.d.ts

@@ -19,14 +19,14 @@
 // TypeScript Version: 4.1
 
 /**
-* Returns the entropy of an exponential distribution.
+* Returns the differential entropy of an exponential distribution.
 *
 * ## Notes
 *
 * -   If provided a negative value for `λ`, the function returns `NaN`.
 *
 * @param lambda - rate parameter
-* @returns entropy
+* @returns differential entropy
 *
 * @example
 * var v = entropy( 9.0 );

package/include/stdlib/stats/base/dists/exponential/entropy.h

@@ -0,0 +1,38 @@
+/**
+* @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.
+*/
+
+#ifndef STDLIB_STATS_BASE_DISTS_EXPONENTIAL_ENTROPY_H
+#define STDLIB_STATS_BASE_DISTS_EXPONENTIAL_ENTROPY_H
+
+/*
+* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
+*/
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+* Returns the entropy of an exponential distribution.
+*/
+double stdlib_base_dists_exponential_entropy( const double lambda );
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // !STDLIB_STATS_BASE_DISTS_EXPONENTIAL_ENTROPY_H

package/lib/main.js

@@ -27,10 +27,10 @@ var ln = require( '@stdlib/math-base-special-ln' );
 // MAIN //
 
 /**
-* Returns the entropy of an exponential distribution.
+* Returns the differential entropy of an exponential distribution.
 *
 * @param {NonNegativeNumber} lambda - rate parameter
-* @returns {number} entropy
+* @returns {number} differential entropy
 *
 * @example
 * var v = entropy( 9.0 );

package/lib/native.js

@@ -0,0 +1,58 @@
+/**
+* @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 addon = require( './../src/addon.node' );
+
+
+// MAIN //
+
+/**
+* Returns the entropy of an exponential distribution.
+*
+* @private
+* @param {NonNegativeNumber} lambda - rate parameter
+* @returns {number} entropy
+*
+* @example
+* var v = entropy( 9.0 );
+* // returns ~-1.197
+*
+* @example
+* var v = entropy( 1.0 );
+* // returns 1.0
+*
+* @example
+* var v = entropy( -0.2 );
+* // returns NaN
+*
+* @example
+* var v = entropy( NaN );
+* // returns NaN
+*/
+function entropy( lambda ) {
+	return addon( lambda );
+}
+
+
+// EXPORTS //
+
+module.exports = entropy;

package/manifest.json

@@ -0,0 +1,80 @@
+{
+  "options": {
+    "task": "build",
+    "wasm": false
+  },
+  "fields": [
+    {
+      "field": "src",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "include",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "libraries",
+      "resolve": false,
+      "relative": false
+    },
+    {
+      "field": "libpath",
+      "resolve": true,
+      "relative": false
+    }
+  ],
+  "confs": [
+    {
+      "task": "build",
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math-base-napi-unary",
+        "@stdlib/math-base-assert-is-nan",
+        "@stdlib/math-base-special-ln"
+      ]
+    },
+    {
+      "task": "benchmark",
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math-base-assert-is-nan",
+        "@stdlib/constants-float64-eps",
+        "@stdlib/math-base-special-ln"
+      ]
+    },
+    {
+      "task": "examples",
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math-base-assert-is-nan",
+        "@stdlib/math-base-special-ln"
+      ]
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-exponential-entropy",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Exponential distribution differential entropy.",
   "license": "Apache-2.0",
   "author": {
@@ -14,9 +14,12 @@
     }
   ],
   "main": "./lib",
+  "gypfile": false,
   "directories": {
     "doc": "./docs",
+    "include": "./include",
     "lib": "./lib",
+    "src": "./src",
     "dist": "./dist"
   },
   "types": "./docs/types",
@@ -30,8 +33,10 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-assert-is-nan": "^0.2.1",
-    "@stdlib/math-base-special-ln": "^0.2.1"
+    "@stdlib/math-base-assert-is-nan": "^0.2.2",
+    "@stdlib/math-base-napi-unary": "^0.2.4",
+    "@stdlib/math-base-special-ln": "^0.2.4",
+    "@stdlib/utils-library-manifest": "^0.2.3"
   },
   "devDependencies": {},
   "engines": {

package/src/addon.c

@@ -0,0 +1,22 @@
+/**
+* @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.
+*/
+
+#include "stdlib/stats/base/dists/exponential/entropy.h"
+#include "stdlib/math/base/napi/unary.h"
+
+STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_dists_exponential_entropy )

package/src/main.c

@@ -0,0 +1,38 @@
+/**
+* @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.
+*/
+
+#include "stdlib/stats/base/dists/exponential/entropy.h"
+#include "stdlib/math/base/assert/is_nan.h"
+#include "stdlib/math/base/special/ln.h"
+
+/**
+* Returns the entropy of an exponential distribution.
+*
+* @param lambda    rate parameter
+* @return          entropy
+*
+* @example
+* double y = stdlib_base_exponential_entropy( 9.0 );
+* // returns ~-1.197
+*/
+double stdlib_base_dists_exponential_entropy( const double lambda ) {
+	if ( stdlib_base_is_nan( lambda ) || lambda < 0.0 ) {
+		return 0.0 / 0.0; // NaN
+	}
+	return 1.0 - stdlib_base_ln( lambda );
+}