@stdlib/stats-base-dists-rayleigh-logcdf 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 logarithm of the [cumulative distribution
 
 ```javascript
 var mylogCDF = logcdf.factory( 0.5 );
-y = mylogCDF( 1.0 );
+var y = mylogCDF( 1.0 );
 // returns ~-0.145
 
 y = mylogCDF( 0.5 );
@@ -151,19 +151,107 @@ y = mylogCDF( 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 logcdf = require( '@stdlib/stats-base-dists-rayleigh-logcdf' );
 
-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 = logcdf( x, sigma );
-    console.log( 'x: %d, σ: %d, log(F(x;σ)): %d', x.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
+logEachMap( 'x: %0.4f, σ: %0.4f, ln(F(x;σ)): %0.4f', x, sigma, logcdf );
+```
+
+</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/logcdf.h"
+```
+
+#### stdlib_base_dists_rayleigh_logcdf( x, sigma )
+
+Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution.
+
+```c
+double out = stdlib_base_dists_rayleigh_logcdf( 2.0, 3.0 );
+// returns ~-1.613
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] double` input value.
+-   **sigma**: `[in] double` scale parameter.
+
+```c
+double stdlib_base_dists_rayleigh_logcdf( 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/logcdf.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_logcdf( x, sigma );
+        printf( "x: %lf, σ: %lf, ln(F(x;σ)): %lf\n", x, sigma, y );
+    }
 }
 ```
 
@@ -171,6 +259,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">
@@ -205,7 +297,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>
 
@@ -218,8 +310,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-rayleigh-logcdf.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-rayleigh-logcdf
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.2.2
-[test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/actions/workflows/test.yml?query=branch:v0.2.2
+[test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/actions/workflows/test.yml?query=branch:v0.3.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-rayleigh-logcdf/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-rayleigh-logcdf?branch=main
@@ -231,8 +323,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.d.ts

@@ -1,3 +1,3 @@
 /// <reference path="../docs/types/index.d.ts" />
-import logCDF from '../docs/types/index';
-export = logCDF;
+import logcdf from '../docs/types/index';
+export = logcdf;

package/dist/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../lib/main.js", "../lib/factory.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 expm1 = require( '@stdlib/math-base-special-expm1' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar log1p = require( '@stdlib/math-base-special-log1p' );\nvar exp = require( '@stdlib/math-base-special-exp' );\nvar pow = require( '@stdlib/math-base-special-pow' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar LNHALF = require( '@stdlib/constants-float64-ln-half' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`.\n*\n* @param {number} x - input value\n* @param {NonNegativeNumber} sigma - scale parameter\n* @returns {number} evaluated logCDF\n*\n* @example\n* var y = logcdf( 2.0, 3.0 );\n* // returns ~-1.613\n*\n* @example\n* var y = logcdf( 1.0, 2.0 );\n* // returns ~-2.141\n*\n* @example\n* var y = logcdf( -1.0, 4.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logcdf( NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logcdf( 0.0, NaN );\n* // returns NaN\n*\n* @example\n* // Negative scale parameter:\n* var y = logcdf( 2.0, -1.0 );\n* // returns NaN\n*/\nfunction logcdf( x, sigma ) {\n\tvar s2;\n\tvar p;\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( sigma ) ||\n\t\tsigma < 0.0\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( sigma === 0.0 ) {\n\t\treturn ( x < 0.0 ) ? NINF : 0.0;\n\t}\n\tif ( x < 0.0 ) {\n\t\treturn NINF;\n\t}\n\ts2 = pow( sigma, 2.0 );\n\tp = -pow( x, 2.0 ) / ( 2.0 * s2 );\n\treturn ( p < LNHALF ) ? log1p( -exp( p ) ) : ln( -expm1( p ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = logcdf;\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// MODULES //\n\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar degenerate = require( '@stdlib/stats-base-dists-degenerate-logcdf' ).factory;\nvar expm1 = require( '@stdlib/math-base-special-expm1' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar log1p = require( '@stdlib/math-base-special-log1p' );\nvar exp = require( '@stdlib/math-base-special-exp' );\nvar pow = require( '@stdlib/math-base-special-pow' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar LNHALF = require( '@stdlib/constants-float64-ln-half' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma`.\n*\n* @param {NonNegativeNumber} sigma - scale parameter\n* @returns {Function} logCDF\n*\n* @example\n* var logcdf = factory( 2.0 );\n* var y = logcdf( 3.0 );\n* // returns ~-0.393\n*\n* y = logcdf( 1.0 );\n* // returns ~-2.141\n*/\nfunction factory( sigma ) {\n\tvar s2;\n\tif ( isnan( sigma ) || sigma < 0.0 ) {\n\t\treturn constantFunction( NaN );\n\t}\n\tif ( sigma === 0.0 ) {\n\t\treturn degenerate( 0.0 );\n\t}\n\ts2 = pow( sigma, 2.0 );\n\treturn logcdf;\n\n\t/**\n\t* Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {number} evaluated logCDF\n\t*\n\t* @example\n\t* var y = logcdf( 2 );\n\t* // returns <number>\n\t*/\n\tfunction logcdf( x ) {\n\t\tvar p;\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tif ( x < 0.0 ) {\n\t\t\treturn NINF;\n\t\t}\n\t\tp = -pow( x, 2.0 ) / ( 2.0 * s2 );\n\t\treturn ( p < LNHALF ) ? log1p( -exp( p ) ) : ln( -expm1( p ) );\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\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* Rayleigh distribution logarithm of cumulative distribution function (CDF).\n*\n* @module @stdlib/stats-base-dists-rayleigh-logcdf\n*\n* @example\n* var logcdf = require( '@stdlib/stats-base-dists-rayleigh-logcdf' );\n*\n* var y = logcdf( 2.0, 5.0 );\n* // returns ~-2.564\n*\n* var mylogcdf = logcdf.factory( 0.5 );\n* y = mylogcdf( 1.0 );\n* // returns ~-0.145\n*\n* y = mylogcdf( 0.5 );\n* // returns ~-0.934\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\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 expm1 = require( '@stdlib/math-base-special-expm1' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar log1p = require( '@stdlib/math-base-special-log1p' );\nvar exp = require( '@stdlib/math-base-special-exp' );\nvar pow = require( '@stdlib/math-base-special-pow' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar LNHALF = require( '@stdlib/constants-float64-ln-half' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`.\n*\n* @param {number} x - input value\n* @param {NonNegativeNumber} sigma - scale parameter\n* @returns {number} evaluated logCDF\n*\n* @example\n* var y = logcdf( 2.0, 3.0 );\n* // returns ~-1.613\n*\n* @example\n* var y = logcdf( 1.0, 2.0 );\n* // returns ~-2.141\n*\n* @example\n* var y = logcdf( -1.0, 4.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logcdf( NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logcdf( 0.0, NaN );\n* // returns NaN\n*\n* @example\n* // Negative scale parameter:\n* var y = logcdf( 2.0, -1.0 );\n* // returns NaN\n*/\nfunction logcdf( x, sigma ) {\n\tvar s2;\n\tvar p;\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( sigma ) ||\n\t\tsigma < 0.0\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( sigma === 0.0 ) {\n\t\treturn ( x < 0.0 ) ? NINF : 0.0;\n\t}\n\tif ( x < 0.0 ) {\n\t\treturn NINF;\n\t}\n\ts2 = pow( sigma, 2.0 );\n\tp = -pow( x, 2.0 ) / ( 2.0 * s2 );\n\treturn ( p < LNHALF ) ? log1p( -exp( p ) ) : ln( -expm1( p ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = logcdf;\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// MODULES //\n\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar degenerate = require( '@stdlib/stats-base-dists-degenerate-logcdf' ).factory;\nvar expm1 = require( '@stdlib/math-base-special-expm1' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar log1p = require( '@stdlib/math-base-special-log1p' );\nvar exp = require( '@stdlib/math-base-special-exp' );\nvar pow = require( '@stdlib/math-base-special-pow' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar LNHALF = require( '@stdlib/constants-float64-ln-half' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma`.\n*\n* @param {NonNegativeNumber} sigma - scale parameter\n* @returns {Function} logCDF\n*\n* @example\n* var logcdf = factory( 2.0 );\n* var y = logcdf( 3.0 );\n* // returns ~-0.393\n*\n* y = logcdf( 1.0 );\n* // returns ~-2.141\n*/\nfunction factory( sigma ) {\n\tvar s2;\n\tif ( isnan( sigma ) || sigma < 0.0 ) {\n\t\treturn constantFunction( NaN );\n\t}\n\tif ( sigma === 0.0 ) {\n\t\treturn degenerate( 0.0 );\n\t}\n\ts2 = pow( sigma, 2.0 );\n\treturn logcdf;\n\n\t/**\n\t* Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {number} evaluated logCDF\n\t*\n\t* @example\n\t* var y = logcdf( 2 );\n\t* // returns <number>\n\t*/\n\tfunction logcdf( x ) {\n\t\tvar p;\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tif ( x < 0.0 ) {\n\t\t\treturn NINF;\n\t\t}\n\t\tp = -pow( x, 2.0 ) / ( 2.0 * s2 );\n\t\treturn ( p < LNHALF ) ? log1p( -exp( p ) ) : ln( -expm1( p ) );\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\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* Rayleigh distribution logarithm of cumulative distribution function (CDF).\n*\n* @module @stdlib/stats-base-dists-rayleigh-logcdf\n*\n* @example\n* var logcdf = require( '@stdlib/stats-base-dists-rayleigh-logcdf' );\n*\n* var y = logcdf( 2.0, 5.0 );\n* // returns ~-2.565\n*\n* var mylogcdf = logcdf.factory( 0.5 );\n* y = mylogcdf( 1.0 );\n* // returns ~-0.145\n*\n* y = mylogcdf( 0.5 );\n* // returns ~-0.933\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
   "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,iCAAkC,EACnDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAM,QAAS,+BAAgC,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAS,QAAS,mCAAoC,EACtDC,EAAO,QAAS,gCAAiC,EAqCrD,SAASC,EAAQC,EAAGC,EAAQ,CAC3B,IAAIC,EACAC,EACJ,OACCX,EAAOQ,CAAE,GACTR,EAAOS,CAAM,GACbA,EAAQ,EAED,IAEHA,IAAU,EACLD,EAAI,EAAQF,EAAO,EAExBE,EAAI,EACDF,GAERI,EAAKP,EAAKM,EAAO,CAAI,EACrBE,EAAI,CAACR,EAAKK,EAAG,CAAI,GAAM,EAAME,GACpBC,EAAIN,EAAWJ,EAAO,CAACC,EAAKS,CAAE,CAAE,EAAIP,EAAI,CAACL,EAAOY,CAAE,CAAE,EAC9D,CAKAb,EAAO,QAAUS,IC1FjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAa,QAAS,4CAA6C,EAAE,QACrEC,EAAQ,QAAS,iCAAkC,EACnDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAM,QAAS,+BAAgC,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAS,QAAS,mCAAoC,EACtDC,EAAO,QAAS,gCAAiC,EAmBrD,SAASC,EAASC,EAAQ,CACzB,IAAIC,EACJ,GAAKT,EAAOQ,CAAM,GAAKA,EAAQ,EAC9B,OAAOX,EAAkB,GAAI,EAE9B,GAAKW,IAAU,EACd,OAAOV,EAAY,CAAI,EAExB,OAAAW,EAAKN,EAAKK,EAAO,CAAI,EACdE,EAaP,SAASA,EAAQC,EAAI,CACpB,IAAIC,EACJ,OAAKZ,EAAOW,CAAE,EACN,IAEHA,EAAI,EACDL,GAERM,EAAI,CAACT,EAAKQ,EAAG,CAAI,GAAM,EAAMF,GACpBG,EAAIP,EAAWJ,EAAO,CAACC,EAAKU,CAAE,CAAE,EAAIR,EAAI,CAACL,EAAOa,CAAE,CAAE,EAC9D,CACD,CAKAhB,EAAO,QAAUW,IC/CjB,IAAIM,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
   "names": ["require_main", "__commonJSMin", "exports", "module", "expm1", "isnan", "log1p", "exp", "pow", "ln", "LNHALF", "NINF", "logcdf", "x", "sigma", "s2", "p", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "degenerate", "expm1", "isnan", "log1p", "exp", "pow", "ln", "LNHALF", "NINF", "factory", "sigma", "s2", "logcdf", "x", "p", "setReadOnly", "main", "factory"]
 }

package/docs/types/index.d.ts

@@ -94,18 +94,18 @@ interface LogCDF {
 *
 * @example
 * var y = logcdf( 2.0, 5.0 );
-* // returns ~-2.564
+* // returns ~-2.565
 *
 * var mylogcdf = logcdf.factory( 0.5 );
 * y = mylogcdf( 1.0 );
 * // returns ~-0.145
 *
 * y = mylogcdf( 0.5 );
-* // returns ~-0.934
+* // returns ~-0.933
 */
-declare var logCDF: LogCDF;
+declare var logcdf: LogCDF;
 
 
 // EXPORTS //
 
-export = logCDF;
+export = logcdf;

package/include/stdlib/stats/base/dists/rayleigh/logcdf.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_LOGCDF_H
+#define STDLIB_STATS_BASE_DISTS_RAYLEIGH_LOGCDF_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 logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`.
+*/
+double stdlib_base_dists_rayleigh_logcdf( const double x, const double sigma );
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // !STDLIB_STATS_BASE_DISTS_RAYLEIGH_LOGCDF_H

package/lib/index.js

@@ -27,14 +27,14 @@
 * var logcdf = require( '@stdlib/stats-base-dists-rayleigh-logcdf' );
 *
 * var y = logcdf( 2.0, 5.0 );
-* // returns ~-2.564
+* // returns ~-2.565
 *
 * var mylogcdf = logcdf.factory( 0.5 );
 * y = mylogcdf( 1.0 );
 * // returns ~-0.145
 *
 * y = mylogcdf( 0.5 );
-* // returns ~-0.934
+* // returns ~-0.933
 */
 
 // MODULES //

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 logarithm of 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 {number} evaluated logCDF
+*
+* @example
+* var y = logcdf( 2.0, 3.0 );
+* // returns ~-1.613
+*
+* @example
+* var y = logcdf( 1.0, 2.0 );
+* // returns ~-2.141
+*
+* @example
+* var y = logcdf( -1.0, 4.0 );
+* // returns -Infinity
+*
+* @example
+* var y = logcdf( NaN, 1.0 );
+* // returns NaN
+*
+* @example
+* var y = logcdf( 0.0, NaN );
+* // returns NaN
+*
+* @example
+* // Negative scale parameter:
+* var y = logcdf( 2.0, -1.0 );
+* // returns NaN
+*/
+function logcdf( x, sigma ) {
+	return addon( x, sigma );
+}
+
+
+// EXPORTS //
+
+module.exports = logcdf;

package/manifest.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-rayleigh-logcdf",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Rayleigh distribution logarithm of 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",
@@ -33,14 +36,16 @@
     "@stdlib/constants-float64-ln-half": "^0.2.2",
     "@stdlib/constants-float64-ninf": "^0.2.2",
     "@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-expm1": "^0.2.3",
     "@stdlib/math-base-special-ln": "^0.2.4",
     "@stdlib/math-base-special-log1p": "^0.2.3",
     "@stdlib/math-base-special-pow": "^0.3.0",
-    "@stdlib/stats-base-dists-degenerate-logcdf": "^0.2.2",
+    "@stdlib/stats-base-dists-degenerate-logcdf": "^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/logcdf.h"
+#include "stdlib/math/base/napi/binary.h"
+
+STDLIB_MATH_BASE_NAPI_MODULE_DD_D( stdlib_base_dists_rayleigh_logcdf )

package/src/main.c

@@ -0,0 +1,59 @@
+/**
+* @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/logcdf.h"
+#include "stdlib/math/base/special/expm1.h"
+#include "stdlib/math/base/assert/is_nan.h"
+#include "stdlib/math/base/special/log1p.h"
+#include "stdlib/math/base/special/exp.h"
+#include "stdlib/math/base/special/pow.h"
+#include "stdlib/math/base/special/ln.h"
+#include "stdlib/constants/float64/ln_half.h"
+#include "stdlib/constants/float64/ninf.h"
+
+/**
+* Evaluates the logarithm of 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 logCDF
+*
+* @example
+* double y = stdlib_base_dists_rayleigh_logcdf( 2.0, 3.0 );
+* // returns ~-1.613
+*/
+double stdlib_base_dists_rayleigh_logcdf( const double x, const double sigma ) {
+	double s2;
+	double p;
+	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 ) ? STDLIB_CONSTANT_FLOAT64_NINF : 0.0;
+	}
+	if ( x < 0.0 ) {
+		return STDLIB_CONSTANT_FLOAT64_NINF;
+	}
+	s2 = stdlib_base_pow( sigma, 2.0 );
+	p = -stdlib_base_pow( x, 2.0 ) / ( 2.0 * s2 );
+	return ( p < STDLIB_CONSTANT_FLOAT64_LN_HALF ) ? stdlib_base_log1p( -stdlib_base_exp( p ) ) : stdlib_base_ln( - stdlib_base_expm1( p ) );
+}