@stdlib/stats-base-dists-erlang-logpdf 0.2.1 → 0.2.3

package/NOTICE

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

package/README.md

@@ -155,23 +155,19 @@ y = mylogpdf( 4.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 discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
+var logEachMap = require( '@stdlib/console-log-each-map' );
 var logpdf = require( '@stdlib/stats-base-dists-erlang-logpdf' );
 
-var lambda;
-var k;
-var x;
-var y;
-var i;
-
-for ( i = 0; i < 20; i++ ) {
-    x = randu() * 10.0;
-    k = round( randu() * 10.0 );
-    lambda = randu() * 5.0;
-    y = logpdf( x, k, lambda );
-    console.log( 'x: %d, k: %d, λ: %d, ln(f(x;k,λ)): %d', x.toFixed( 4 ), k, lambda.toFixed( 4 ), y.toFixed( 4 ) );
-}
+var opts = {
+    'dtype': 'float64'
+};
+var x = uniform( 20, 0.0, 10.0, opts );
+var k = discreteUniform( 20, 0, 10, opts );
+var lambda = uniform( 20, 0.0, 5.0, opts );
+
+logEachMap( 'x: %0.4f, k: %d, λ: %0.4f, ln(f(x;k,λ)): %0.4f', x, k, lambda, logpdf );
 ```
 
 </section>
@@ -212,7 +208,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>
 
@@ -225,8 +221,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-erlang-logpdf.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-erlang-logpdf
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-erlang-logpdf/actions/workflows/test.yml/badge.svg?branch=v0.2.1
-[test-url]: https://github.com/stdlib-js/stats-base-dists-erlang-logpdf/actions/workflows/test.yml?query=branch:v0.2.1
+[test-image]: https://github.com/stdlib-js/stats-base-dists-erlang-logpdf/actions/workflows/test.yml/badge.svg?branch=v0.2.3
+[test-url]: https://github.com/stdlib-js/stats-base-dists-erlang-logpdf/actions/workflows/test.yml?query=branch:v0.2.3
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-erlang-logpdf/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-erlang-logpdf?branch=main
@@ -238,8 +234,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 logPDF from '../docs/types/index';
-export = logPDF;
+import logpdf from '../docs/types/index';
+export = logpdf;

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 isNonNegativeInteger = require( '@stdlib/math-base-assert-is-nonnegative-integer' );\nvar gammaLogPDF = require( '@stdlib/stats-base-dists-gamma-logpdf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the natural logarithm of the probability density function (PDF) for an Erlang distribution with shape parameter `k` and rate parameter `lambda` at a value `x`.\n*\n* @param {number} x - input value\n* @param {NonNegativeInteger} k - shape parameter\n* @param {PositiveNumber} lambda - rate parameter\n* @returns {number} evaluated logPDF\n*\n* @example\n* var y = logpdf( 0.1, 1, 1.0 );\n* // returns ~-0.1\n*\n* @example\n* var y = logpdf( 0.5, 2, 2.5 );\n* // returns ~-0.111\n*\n* @example\n* var y = logpdf( -1.0, 4, 2.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logpdf( NaN, 1, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 0.0, NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 0.0, 1, NaN );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 2.0, -2, 0.5 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 2.0, 0.5, 0.5 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 2.0, 0.0, 2.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logpdf( 0.0, 0.0, 2.0 );\n* // returns Infinity\n*\n* @example\n* var y = logpdf( 2.0, 1, 0.0 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 2.0, 1, -1.0 );\n* // returns NaN\n*/\nfunction logpdf( x, k, lambda ) {\n\tif ( !isNonNegativeInteger( k ) ) {\n\t\treturn NaN;\n\t}\n\treturn gammaLogPDF( x, k, lambda );\n}\n\n\n// EXPORTS //\n\nmodule.exports = logpdf;\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 isNonNegativeInteger = require( '@stdlib/math-base-assert-is-nonnegative-integer' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar factoryGamma = require( '@stdlib/stats-base-dists-gamma-logpdf' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the natural logarithm of the probability density function (PDF) for an Erlang distribution with shape parameter `k` and rate parameter `lambda`.\n*\n* @param {NonNegativeInteger} k - shape parameter\n* @param {PositiveNumber} lambda - rate parameter\n* @returns {Function} logPDF\n*\n* @example\n* var myLogPDF = factory( 6.0, 7.0 );\n* var y = myLogPDF( 7.0 );\n* // returns ~-32.382\n*/\nfunction factory( k, lambda ) {\n\tif ( !isNonNegativeInteger( k ) ) {\n\t\treturn constantFunction( NaN );\n\t}\n\treturn factoryGamma( k, lambda );\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* Natural logarithm of the probability density function (PDF) for an Erlang distribution.\n*\n* @module @stdlib/stats-base-dists-erlang-logpdf\n*\n* @example\n* var logpdf = require( '@stdlib/stats-base-dists-erlang-logpdf' );\n*\n* var y = logpdf( 0.5, 2, 2.5 );\n* // returns ~-0.111\n*\n* var myLogPDF = logpdf.factory( 6, 7.0 );\n* y = myLogPDF( 7.0 );\n* // returns ~-1.864\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 isNonNegativeInteger = require( '@stdlib/math-base-assert-is-nonnegative-integer' );\nvar gammaLogPDF = require( '@stdlib/stats-base-dists-gamma-logpdf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the natural logarithm of the probability density function (PDF) for an Erlang distribution with shape parameter `k` and rate parameter `lambda` at a value `x`.\n*\n* @param {number} x - input value\n* @param {NonNegativeInteger} k - shape parameter\n* @param {PositiveNumber} lambda - rate parameter\n* @returns {number} evaluated logPDF\n*\n* @example\n* var y = logpdf( 0.1, 1, 1.0 );\n* // returns ~-0.1\n*\n* @example\n* var y = logpdf( 0.5, 2, 2.5 );\n* // returns ~-0.111\n*\n* @example\n* var y = logpdf( -1.0, 4, 2.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logpdf( NaN, 1, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 0.0, NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 0.0, 1, NaN );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 2.0, -2, 0.5 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 2.0, 0.5, 0.5 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 2.0, 0.0, 2.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logpdf( 0.0, 0.0, 2.0 );\n* // returns Infinity\n*\n* @example\n* var y = logpdf( 2.0, 1, 0.0 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 2.0, 1, -1.0 );\n* // returns NaN\n*/\nfunction logpdf( x, k, lambda ) {\n\tif ( !isNonNegativeInteger( k ) ) {\n\t\treturn NaN;\n\t}\n\treturn gammaLogPDF( x, k, lambda );\n}\n\n\n// EXPORTS //\n\nmodule.exports = logpdf;\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 isNonNegativeInteger = require( '@stdlib/math-base-assert-is-nonnegative-integer' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar factoryGamma = require( '@stdlib/stats-base-dists-gamma-logpdf' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the natural logarithm of the probability density function (PDF) for an Erlang distribution with shape parameter `k` and rate parameter `lambda`.\n*\n* @param {NonNegativeInteger} k - shape parameter\n* @param {PositiveNumber} lambda - rate parameter\n* @returns {Function} logPDF\n*\n* @example\n* var myLogPDF = factory( 6.0, 7.0 );\n* var y = myLogPDF( 7.0 );\n* // returns ~-32.382\n*/\nfunction factory( k, lambda ) {\n\tif ( !isNonNegativeInteger( k ) ) {\n\t\treturn constantFunction( NaN );\n\t}\n\treturn factoryGamma( k, lambda );\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* Natural logarithm of the probability density function (PDF) for an Erlang distribution.\n*\n* @module @stdlib/stats-base-dists-erlang-logpdf\n*\n* @example\n* var logpdf = require( '@stdlib/stats-base-dists-erlang-logpdf' );\n*\n* var y = logpdf( 0.5, 2, 2.5 );\n* // returns ~-0.111\n*\n* var myLogPDF = logpdf.factory( 6, 7.0 );\n* y = myLogPDF( 7.0 );\n* // returns ~-32.382\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,EAAuB,QAAS,iDAAkD,EAClFC,EAAc,QAAS,uCAAwC,EA6DnE,SAASC,EAAQC,EAAGC,EAAGC,EAAS,CAC/B,OAAML,EAAsBI,CAAE,EAGvBH,EAAaE,EAAGC,EAAGC,CAAO,EAFzB,GAGT,CAKAN,EAAO,QAAUG,IC9FjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,iDAAkD,EAClFC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAe,QAAS,uCAAwC,EAAE,QAiBtE,SAASC,EAASC,EAAGC,EAAS,CAC7B,OAAML,EAAsBI,CAAE,EAGvBF,EAAcE,EAAGC,CAAO,EAFvBJ,EAAkB,GAAI,CAG/B,CAKAF,EAAO,QAAUI,ICbjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
   "names": ["require_main", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "gammaLogPDF", "logpdf", "x", "k", "lambda", "require_factory", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "constantFunction", "factoryGamma", "factory", "k", "lambda", "setReadOnly", "main", "factory"]
 }

package/docs/types/index.d.ts

@@ -122,11 +122,11 @@ interface LogPDF {
 *
 * var myLogPDF = logpdf.factory( 6, 7.0 );
 * y = myLogPDF( 7.0 );
-* // returns ~-1.864
+* // returns ~-32.382
 */
-declare var logPDF: LogPDF;
+declare var logpdf: LogPDF;
 
 
 // EXPORTS //
 
-export = logPDF;
+export = logpdf;

package/lib/index.js

@@ -31,7 +31,7 @@
 *
 * var myLogPDF = logpdf.factory( 6, 7.0 );
 * y = myLogPDF( 7.0 );
-* // returns ~-1.864
+* // returns ~-32.382
 */
 
 // MODULES //

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-erlang-logpdf",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Natural logarithm of the probability density function (PDF) for an Erlang distribution.",
   "license": "Apache-2.0",
   "author": {
@@ -30,10 +30,10 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-assert-is-nonnegative-integer": "^0.1.2",
-    "@stdlib/stats-base-dists-gamma-logpdf": "^0.2.1",
-    "@stdlib/utils-constant-function": "^0.2.1",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1"
+    "@stdlib/math-base-assert-is-nonnegative-integer": "^0.2.2",
+    "@stdlib/stats-base-dists-gamma-logpdf": "^0.3.0",
+    "@stdlib/utils-constant-function": "^0.2.3",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3"
   },
   "devDependencies": {},
   "engines": {