@stdlib/stats-base-dists-rayleigh-cdf 0.2.2 → 0.3.0

package/NOTICE

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

package/README.md

@@ -123,7 +123,7 @@ Returns a function for evaluating the [cumulative distribution function][cdf] of
 
 ```javascript
 var myCDF = cdf.factory( 0.5 );
-y = myCDF( 1.0 );
+var y = myCDF( 1.0 );
 // returns ~0.865
 
 y = myCDF( 0.5 );
@@ -141,19 +141,107 @@ y = myCDF( 0.5 );
 <!-- 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 cdf = require( '@stdlib/stats-base-dists-rayleigh-cdf' );
 
-var sigma;
-var x;
-var y;
-var i;
+var opts = {
+    'dtype': 'float64'
+};
+var x = uniform( 10, 0.0, 10.0, opts );
+var sigma = uniform( 10, 0.0, 10.0, opts );
 
-for ( i = 0; i < 10; i++ ) {
-    x = randu() * 10.0;
-    sigma = randu() * 10.0;
-    y = cdf( x, sigma );
-    console.log( 'x: %d, σ: %d, F(x;σ): %d', x.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
+logEachMap( 'x: %0.4f, σ: %0.4f, F(x;σ): %0.4f', x, sigma, cdf );
+```
+
+</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/rayleigh/cdf.h"
+```
+
+#### stdlib_base_dists_rayleigh_cdf( x, sigma )
+
+Evaluates the cumulative distribution function (CDF) for a Rayleigh distribution.
+
+```c
+double out = stdlib_base_dists_rayleigh_cdf( 2.0, 3.0 );
+// returns ~0.199
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] double` input value.
+-   **sigma**: `[in] double` scale parameter.
+
+```c
+double stdlib_base_dists_rayleigh_cdf( const double x, const double sigma );
+```
+
+</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/rayleigh/cdf.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 sigma;
+    double x;
+    double y;
+    int i;
+
+    for ( i = 0; i < 25; i++ ) {
+        x = random_uniform( 0.0, 10.0 );
+        sigma = random_uniform( 0.0, 10.0 );
+        y = stdlib_base_dists_rayleigh_cdf( x, sigma );
+        printf( "x: %lf, σ: %lf, F(x;σ): %lf\n", x, sigma, y );
+    }
 }
 ```
 
@@ -161,6 +249,10 @@ for ( i = 0; i < 10; i++ ) {
 
 <!-- /.examples -->
 
+</section>
+
+<!-- /.c -->
+
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">
@@ -195,7 +287,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>
 
@@ -208,8 +300,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-rayleigh-cdf.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-rayleigh-cdf
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-cdf/actions/workflows/test.yml/badge.svg?branch=v0.2.2
-[test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-cdf/actions/workflows/test.yml?query=branch:v0.2.2
+[test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-cdf/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-cdf/actions/workflows/test.yml?query=branch:v0.3.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-rayleigh-cdf/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-rayleigh-cdf?branch=main
@@ -221,8 +313,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/docs/types/index.d.ts

@@ -94,11 +94,11 @@ interface CDF {
 *
 * @example
 * var y = cdf( 2.0, 0.0, 1.0 );
-* // returns ~0.977
+* // returns 1.0
 *
 * var myCDF = cdf.factory( 10.0, 2.0 );
 * y = myCDF( 10.0 );
-* // returns 0.5
+* // returns ~0.393
 */
 declare var cdf: CDF;
 

package/include/stdlib/stats/base/dists/rayleigh/cdf.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_RAYLEIGH_CDF_H
+#define STDLIB_STATS_BASE_DISTS_RAYLEIGH_CDF_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
+
+/**
+* Evaluates the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`.
+*/
+double stdlib_base_dists_rayleigh_cdf( const double x, const double sigma );
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // !STDLIB_STATS_BASE_DISTS_RAYLEIGH_CDF_H

package/lib/native.js

@@ -0,0 +1,68 @@
+/**
+* @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 //
+
+/**
+* Evaluates the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`.
+*
+* @private
+* @param {number} x - input value
+* @param {NonNegativeNumber} sigma - scale parameter
+* @returns {Probability} evaluated CDF
+*
+* @example
+* var y = cdf( 2.0, 3.0 );
+* // returns ~0.199
+*
+* @example
+* var y = cdf( 1.0, 2.0 );
+* // returns ~0.118
+*
+* @example
+* var y = cdf( -1.0, 4.0 );
+* // returns 0.0
+*
+* @example
+* var y = cdf( NaN, 1.0 );
+* // returns NaN
+*
+* @example
+* var y = cdf( 0.0, NaN );
+* // returns NaN
+*
+* @example
+* // Negative scale parameter:
+* var y = cdf( 2.0, -1.0 );
+* // returns NaN
+*/
+function cdf( x, sigma ) {
+	return addon( x, sigma );
+}
+
+
+// EXPORTS //
+
+module.exports = cdf;

package/manifest.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-rayleigh-cdf",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Rayleigh distribution cumulative distribution function (CDF).",
   "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",
@@ -31,11 +34,13 @@
   },
   "dependencies": {
     "@stdlib/math-base-assert-is-nan": "^0.2.2",
-    "@stdlib/math-base-special-exp": "^0.2.3",
+    "@stdlib/math-base-napi-binary": "^0.3.1",
+    "@stdlib/math-base-special-exp": "^0.2.4",
     "@stdlib/math-base-special-pow": "^0.3.0",
-    "@stdlib/stats-base-dists-degenerate-cdf": "^0.2.2",
+    "@stdlib/stats-base-dists-degenerate-cdf": "^0.3.0",
     "@stdlib/utils-constant-function": "^0.2.2",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2"
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2",
+    "@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/rayleigh/cdf.h"
+#include "stdlib/math/base/napi/binary.h"
+
+STDLIB_MATH_BASE_NAPI_MODULE_DD_D( stdlib_base_dists_rayleigh_cdf )

package/src/main.c

@@ -0,0 +1,52 @@
+/**
+* @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/rayleigh/cdf.h"
+#include "stdlib/math/base/assert/is_nan.h"
+#include "stdlib/math/base/special/exp.h"
+#include "stdlib/math/base/special/pow.h"
+
+/**
+* Evaluates the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`.
+*
+* @param x        input value
+* @param sigma    scale parameter
+* @return         evaluated CDF
+*
+* @example
+* double y = stdlib_base_dists_rayleigh_cdf( 2.0, 3.0 );
+* // returns ~0.199
+*/
+double stdlib_base_dists_rayleigh_cdf( const double x, const double sigma ) {
+	double s2;
+	if (
+		stdlib_base_is_nan( x ) ||
+		stdlib_base_is_nan( sigma ) ||
+		sigma < 0.0
+	) {
+		return 0.0/0.0; // NaN
+	}
+	if ( sigma == 0.0 ) {
+		return ( x < 0.0 ) ? 0.0 : 1.0;
+	}
+	if ( x < 0.0 ) {
+		return 0.0;
+	}
+	s2 = stdlib_base_pow( sigma, 2.0 );
+	return 1.0 - stdlib_base_exp( -stdlib_base_pow( x, 2.0 ) / ( 2.0 * s2 ) );
+}