@stdlib/stats-base-dists-cauchy-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

@@ -127,20 +127,109 @@ v = entropy( 1.0, 0.0 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var randu = require( '@stdlib/random-base-randu' );
+var uniform = require( '@stdlib/random-array-uniform' );
+var logEachMap = require( '@stdlib/console-log-each-map' );
 var EPS = require( '@stdlib/constants-float64-eps' );
 var entropy = require( '@stdlib/stats-base-dists-cauchy-entropy' );
 
-var gamma;
-var x0;
-var v;
-var i;
+var opts = {
+    'dtype': 'float64'
+};
+var gamma = uniform( 10, EPS, 10.0, opts );
+var x0 = uniform( 10, 0.0, 100.0, opts );
 
-for ( i = 0; i < 10; i++ ) {
-    x0 = randu() * 100.0;
-    gamma = ( randu()*10.0 ) + EPS;
-    v = entropy( x0, gamma );
-    console.log( 'x0: %d, γ: %d, h(X;x0,γ): %d', x0.toFixed( 4 ), gamma.toFixed( 4 ), v.toFixed( 4 ) );
+logEachMap( 'x0: %0.4f, γ: %0.4f, h(X;x0,γ): %0.4f', x0, gamma, 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/cauchy/entropy.h"
+```
+
+#### stdlib_base_dists_cauchy_entropy( x0, gamma )
+
+Evaluates the [differential entropy][entropy] of a [Cauchy][cauchy-distribution] distribution with location parameter `x0` and scale parameter `gamma` (in [nats][nats]).
+
+```c
+double out = stdlib_base_dists_cauchy_entropy( 10.0, 5.0 );
+// returns ~4.14
+```
+
+The function accepts the following arguments:
+
+-   **x0**: `[in] double` location parameter.
+-   **gamma**: `[in] double` scale parameter.
+
+```c
+double stdlib_base_dists_cauchy_entropy( const double x0, const double gamma );
+```
+
+</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/cauchy/entropy.h"
+#include "stdlib/constants/float64/eps.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 gamma;
+    double x0;
+    double y;
+    int i;
+
+    for ( i = 0; i < 25; i++ ) {
+        x0 = random_uniform( 0.0, 100.0 );
+        gamma = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 10.0 );
+        y = stdlib_base_dists_cauchy_entropy( x0, gamma );
+        printf( "x0: %lf, γ: %lf, h(X;x0,γ): %lf\n", x0, gamma, y );
+    }
 }
 ```
 
@@ -148,6 +237,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">
@@ -190,7 +283,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>
 
@@ -203,8 +296,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-cauchy-entropy.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-cauchy-entropy
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-cauchy-entropy/actions/workflows/test.yml/badge.svg?branch=v0.2.1
-[test-url]: https://github.com/stdlib-js/stats-base-dists-cauchy-entropy/actions/workflows/test.yml?query=branch:v0.2.1
+[test-image]: https://github.com/stdlib-js/stats-base-dists-cauchy-entropy/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-cauchy-entropy/actions/workflows/test.yml?query=branch:v0.3.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-cauchy-entropy/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-cauchy-entropy?branch=main
@@ -216,8 +309,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/include/stdlib/stats/base/dists/cauchy/entropy.h

@@ -0,0 +1,38 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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_CAUCHY_ENTROPY_H
+#define STDLIB_STATS_BASE_DISTS_CAUCHY_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 differential entropy of a Cauchy distribution.
+*/
+double stdlib_base_dists_cauchy_entropy( const double x0, const double gamma );
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // !STDLIB_STATS_BASE_DISTS_CAUCHY_ENTROPY_H

package/lib/native.js

@@ -0,0 +1,55 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 differential entropy of a Cauchy distribution.
+*
+* @private
+* @param {number} x0 - location parameter
+* @param {PositiveNumber} gamma - scale parameter
+* @returns {PositiveNumber} entropy
+*
+* @example
+* var v = entropy( 10.0, 5.0 );
+* // returns ~4.14
+*
+* @example
+* var v = entropy( 7.0, 0.1 );
+* // returns ~0.228
+*
+* @example
+* var v = entropy( 10.0, -0.5 );
+* // returns NaN
+*/
+function entropy( x0, gamma ) {
+	return addon( x0, gamma );
+}
+
+
+// EXPORTS //
+
+module.exports = entropy;

package/manifest.json

@@ -0,0 +1,84 @@
+{
+  "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-binary",
+        "@stdlib/math-base-assert-is-nan",
+        "@stdlib/math-base-special-ln",
+        "@stdlib/constants-float64-pi"
+      ]
+    },
+    {
+      "task": "benchmark",
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math-base-assert-is-nan",
+        "@stdlib/math-base-special-ln",
+        "@stdlib/constants-float64-eps",
+        "@stdlib/constants-float64-pi"
+      ]
+    },
+    {
+      "task": "examples",
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math-base-assert-is-nan",
+        "@stdlib/math-base-special-ln",
+        "@stdlib/constants-float64-eps",
+        "@stdlib/constants-float64-pi"
+      ]
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-cauchy-entropy",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Cauchy 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,9 +33,11 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/constants-float64-pi": "^0.2.1",
-    "@stdlib/math-base-assert-is-nan": "^0.2.1",
-    "@stdlib/math-base-special-ln": "^0.2.1"
+    "@stdlib/constants-float64-pi": "^0.2.2",
+    "@stdlib/math-base-assert-is-nan": "^0.2.2",
+    "@stdlib/math-base-napi-binary": "^0.3.1",
+    "@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) 2024 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/cauchy/entropy.h"
+#include "stdlib/math/base/napi/binary.h"
+
+STDLIB_MATH_BASE_NAPI_MODULE_DD_D( stdlib_base_dists_cauchy_entropy )

package/src/main.c

@@ -0,0 +1,44 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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/cauchy/entropy.h"
+#include "stdlib/math/base/assert/is_nan.h"
+#include "stdlib/math/base/special/ln.h"
+#include "stdlib/constants/float64/pi.h"
+
+/**
+* Returns the differential entropy of a Cauchy distribution.
+*
+* @param x0       location parameter
+* @param gamma    scale parameter
+* @return         entropy
+*
+* @example
+* double y = stdlib_base_dists_cauchy_entropy( 10.0, 5.0 );
+* // returns ~4.14
+*/
+double stdlib_base_dists_cauchy_entropy( const double x0, const double gamma ) {
+	if (
+		stdlib_base_is_nan( gamma ) ||
+		stdlib_base_is_nan( x0 ) ||
+		gamma <= 0.0
+	) {
+		return 0.0/0.0; // NaN
+	}
+	return stdlib_base_ln( gamma ) + stdlib_base_ln( 4.0*STDLIB_CONSTANT_FLOAT64_PI );
+}