@stdlib/stats-base-dists-laplace-pdf 0.0.7 → 0.1.0

package/CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2022 The Stdlib Authors.
+Copyright (c) 2016-2023 The Stdlib Authors.

package/README.md

@@ -18,6 +18,17 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # Probability Density Function
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -183,7 +194,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -196,8 +207,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-laplace-pdf.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-laplace-pdf
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-laplace-pdf/actions/workflows/test.yml/badge.svg?branch=v0.0.7
-[test-url]: https://github.com/stdlib-js/stats-base-dists-laplace-pdf/actions/workflows/test.yml?query=branch:v0.0.7
+[test-image]: https://github.com/stdlib-js/stats-base-dists-laplace-pdf/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-laplace-pdf/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-laplace-pdf/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-laplace-pdf?branch=main
@@ -210,7 +221,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 -->
 
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";var s=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var c=s(function(g,v){
+var i=require('@stdlib/math-base-assert-is-nan/dist'),p=require('@stdlib/math-base-special-abs/dist'),N=require('@stdlib/math-base-special-exp/dist');function y(e,r,a){var t;return i(e)||i(r)||i(a)||a<=0?NaN:(t=(e-r)/a,.5*N(-p(t))/a)}v.exports=y
+});var o=s(function(h,f){
+var d=require('@stdlib/utils-constant-function/dist'),n=require('@stdlib/math-base-assert-is-nan/dist'),x=require('@stdlib/math-base-special-abs/dist'),z=require('@stdlib/math-base-special-exp/dist');function l(e,r){if(n(e)||n(r)||r<=0)return d(NaN);return a;function a(t){var u;return n(t)?NaN:(u=(t-e)/r,.5*z(-x(u))/r)}}f.exports=l
+});var F=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),q=c(),O=o();F(q,"factory",O);module.exports=q;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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 isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar abs = require( '@stdlib/math-base-special-abs' );\nvar exp = require( '@stdlib/math-base-special-exp' );\n\n\n// MAIN //\n\n/**\n* Evaluates the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`.\n*\n* @param {number} x - input value\n* @param {number} mu - location parameter\n* @param {PositiveNumber} b - scale parameter\n* @returns {number} evaluated PDF\n*\n* @example\n* var y = pdf( 2.0, 0.0, 1.0 );\n* // returns ~0.068\n*\n* @example\n* var y = pdf( -1.0, 2.0, 3.0 );\n* // returns ~0.061\n*\n* @example\n* var y = pdf( 2.5, 2.0, 3.0 );\n* // returns ~0.141\n*\n* @example\n* var y = pdf( NaN, 0.0, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = pdf( 0.0, NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = pdf( 0.0, 0.0, NaN );\n* // returns NaN\n*\n* @example\n* // Negative scale parameter:\n* var y = pdf( 2.0, 0.0, -1.0 );\n* // returns NaN\n*/\nfunction pdf( x, mu, b ) {\n\tvar z;\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( mu ) ||\n\t\tisnan( b ) ||\n\t\tb <= 0.0\n\t) {\n\t\treturn NaN;\n\t}\n\tz = ( x - mu ) / b;\n\treturn 0.5 * exp( -abs( z ) ) / b;\n}\n\n\n// EXPORTS //\n\nmodule.exports = pdf;\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 isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar abs = require( '@stdlib/math-base-special-abs' );\nvar exp = require( '@stdlib/math-base-special-exp' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b`.\n*\n* @param {number} mu - location parameter\n* @param {PositiveNumber} b - scale parameter\n* @returns {Function} PDF\n*\n* @example\n* var pdf = factory( 10.0, 2.0 );\n*\n* var y = pdf( 10.0 );\n* // returns 0.25\n*\n* y = pdf( 5.0 );\n* // returns ~0.021\n*\n* y = pdf( 12.0 );\n* // returns ~0.092\n*/\nfunction factory( mu, b ) {\n\tif (\n\t\tisnan( mu ) ||\n\t\tisnan( b ) ||\n\t\tb <= 0.0\n\t) {\n\t\treturn constantFunction( NaN );\n\t}\n\treturn pdf;\n\n\t/**\n\t* Evaluates the probability density function (PDF) for a Laplace distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {number} evaluated PDF\n\t*\n\t* var y = pdf( -3.14 );\n\t* // returns <number>\n\t*/\n\tfunction pdf( x ) {\n\t\tvar z;\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tz = ( x - mu ) / b;\n\t\treturn 0.5 * exp( -abs( z ) ) / b;\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* Laplace distribution probability density function (PDF).\n*\n* @module @stdlib/stats-base-dists-laplace-pdf\n*\n* @example\n* var pdf = require( '@stdlib/stats-base-dists-laplace-pdf' );\n*\n* var y = pdf( 2.0, 0.0, 1.0 );\n* // returns ~0.068\n*\n* var myPDF = pdf.factory( 10.0, 2.0 );\n* y = myPDF( 10.0 );\n* // returns 0.25\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,EAAM,QAAS,+BAAgC,EAC/CC,EAAM,QAAS,+BAAgC,EA0CnD,SAASC,EAAKC,EAAGC,EAAIC,EAAI,CACxB,IAAIC,EACJ,OACCP,EAAOI,CAAE,GACTJ,EAAOK,CAAG,GACVL,EAAOM,CAAE,GACTA,GAAK,EAEE,KAERC,GAAMH,EAAIC,GAAOC,EACV,GAAMJ,EAAK,CAACD,EAAKM,CAAE,CAAE,EAAID,EACjC,CAKAP,EAAO,QAAUI,ICnFjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAM,QAAS,+BAAgC,EAwBnD,SAASC,EAASC,EAAIC,EAAI,CACzB,GACCL,EAAOI,CAAG,GACVJ,EAAOK,CAAE,GACTA,GAAK,EAEL,OAAON,EAAkB,GAAI,EAE9B,OAAOO,EAYP,SAASA,EAAKC,EAAI,CACjB,IAAIC,EACJ,OAAKR,EAAOO,CAAE,EACN,KAERC,GAAMD,EAAIH,GAAOC,EACV,GAAMH,EAAK,CAACD,EAAKO,CAAE,CAAE,EAAIH,EACjC,CACD,CAKAP,EAAO,QAAUK,IC5CjB,IAAIM,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "abs", "exp", "pdf", "x", "mu", "b", "z", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "isnan", "abs", "exp", "factory", "mu", "b", "pdf", "x", "z", "setReadOnly", "main", "factory"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Evaluates the probability density function (PDF) for a Laplace distribution.

package/lib/index.js

@@ -37,15 +37,15 @@
 // MODULES //
 
 var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
-var pdf = require( './pdf.js' );
+var main = require( './main.js' );
 var factory = require( './factory.js' );
 
 
 // MAIN //
 
-setReadOnly( pdf, 'factory', factory );
+setReadOnly( main, 'factory', factory );
 
 
 // EXPORTS //
 
-module.exports = pdf;
+module.exports = main;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-laplace-pdf",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Laplace distribution probability density function (PDF).",
   "license": "Apache-2.0",
   "author": {
@@ -37,21 +37,21 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-special-abs": "^0.0.x",
-    "@stdlib/math-base-special-exp": "^0.0.x",
-    "@stdlib/utils-constant-function": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-special-abs": "^0.1.0",
+    "@stdlib/math-base-special-exp": "^0.1.0",
+    "@stdlib/utils-constant-function": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/constants-float64-eps": "^0.0.x",
-    "@stdlib/constants-float64-ninf": "^0.0.x",
-    "@stdlib/constants-float64-pinf": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/constants-float64-eps": "^0.1.0",
+    "@stdlib/constants-float64-ninf": "^0.1.0",
+    "@stdlib/constants-float64-pinf": "^0.1.0",
+    "@stdlib/random-base-randu": "^0.0.8",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -85,7 +85,7 @@
     "univariate"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,72 +0,0 @@
-
-{{alias}}( x, μ, b )
-    Evaluates the probability density function (PDF) for a Laplace
-    distribution with scale parameter `b` and location parameter `μ` at a
-    value `x`.
-
-    If provided `NaN` as any argument, the function returns `NaN`.
-
-    If provided `b <= 0`, the function returns `NaN`.
-
-    Parameters
-    ----------
-    x: number
-        Input value.
-
-    μ: number
-        Location parameter.
-
-    b: number
-        Scale parameter.
-
-    Returns
-    -------
-    out: number
-        Evaluated PDF.
-
-    Examples
-    --------
-    > var y = {{alias}}( 2.0, 0.0, 1.0 )
-    ~0.068
-    > y = {{alias}}( -1.0, 2.0, 3.0 )
-    ~0.061
-    > y = {{alias}}( 2.5, 2.0, 3.0 )
-    ~0.141
-    > y = {{alias}}( NaN, 0.0, 1.0 )
-    NaN
-    > y = {{alias}}( 0.0, NaN, 1.0 )
-    NaN
-    > y = {{alias}}( 0.0, 0.0, NaN )
-    NaN
-    // Negative scale parameter:
-    > y = {{alias}}( 2.0, 0.0, -1.0 )
-    NaN
-
-
-{{alias}}.factory( μ, b )
-    Returns a function for evaluating the probability density function (PDF)
-    of a Laplace distribution with scale parameter `b` and location parameter
-    `μ`.
-
-    Parameters
-    ----------
-    μ: number
-        Location parameter.
-
-    b: number
-        Scale parameter.
-
-    Returns
-    -------
-    pdf: Function
-        Probability density function (PDF).
-
-    Examples
-    --------
-    > var myPDF = {{alias}}.factory( 10.0, 2.0 );
-    > var y = myPDF( 10.0 )
-    0.25
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,119 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2019 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.
-*/
-
-import pdf = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	pdf( 2, 2, 4 ); // $ExpectType number
-	pdf( 1, 2, 8 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function is provided values other than three numbers...
-{
-	pdf( true, 3, 6 ); // $ExpectError
-	pdf( false, 2, 4 ); // $ExpectError
-	pdf( '5', 1, 2 ); // $ExpectError
-	pdf( [], 1, 2 ); // $ExpectError
-	pdf( {}, 2, 4 ); // $ExpectError
-	pdf( ( x: number ): number => x, 2, 4 ); // $ExpectError
-
-	pdf( 9, true, 12 ); // $ExpectError
-	pdf( 9, false, 12 ); // $ExpectError
-	pdf( 5, '5', 10 ); // $ExpectError
-	pdf( 8, [], 16 ); // $ExpectError
-	pdf( 9, {}, 18 ); // $ExpectError
-	pdf( 8, ( x: number ): number => x, 16 ); // $ExpectError
-
-	pdf( 9, 5, true ); // $ExpectError
-	pdf( 9, 5, false ); // $ExpectError
-	pdf( 5, 2, '5' ); // $ExpectError
-	pdf( 8, 4, [] ); // $ExpectError
-	pdf( 9, 4, {} ); // $ExpectError
-	pdf( 8, 5, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	pdf(); // $ExpectError
-	pdf( 2 ); // $ExpectError
-	pdf( 2, 0 ); // $ExpectError
-	pdf( 2, 0, 4, 1 ); // $ExpectError
-}
-
-// Attached to main export is a `factory` method which returns a function...
-{
-	pdf.factory( 3, 4 ); // $ExpectType Unary
-}
-
-// The `factory` method returns a function which returns a number...
-{
-	const fcn = pdf.factory( 3, 4 );
-	fcn( 2 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments...
-{
-	const fcn = pdf.factory( 3, 4 );
-	fcn( true ); // $ExpectError
-	fcn( false ); // $ExpectError
-	fcn( '5' ); // $ExpectError
-	fcn( [] ); // $ExpectError
-	fcn( {} ); // $ExpectError
-	fcn( ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments...
-{
-	const fcn = pdf.factory( 3, 4 );
-	fcn(); // $ExpectError
-	fcn( 2, 0 ); // $ExpectError
-	fcn( 2, 0, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided values other than two numbers...
-{
-	pdf.factory( true, 3 ); // $ExpectError
-	pdf.factory( false, 2 ); // $ExpectError
-	pdf.factory( '5', 1 ); // $ExpectError
-	pdf.factory( [], 1 ); // $ExpectError
-	pdf.factory( {}, 2 ); // $ExpectError
-	pdf.factory( ( x: number ): number => x, 2 ); // $ExpectError
-
-	pdf.factory( 9, true ); // $ExpectError
-	pdf.factory( 9, false ); // $ExpectError
-	pdf.factory( 5, '5' ); // $ExpectError
-	pdf.factory( 8, [] ); // $ExpectError
-	pdf.factory( 9, {} ); // $ExpectError
-	pdf.factory( 8, ( x: number ): number => x ); // $ExpectError
-
-	pdf.factory( [], true ); // $ExpectError
-	pdf.factory( {}, false ); // $ExpectError
-	pdf.factory( false, '5' ); // $ExpectError
-	pdf.factory( {}, [] ); // $ExpectError
-	pdf.factory( '5', ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
-{
-	pdf.factory( 0 ); // $ExpectError
-	pdf.factory( 0, 4, 8 ); // $ExpectError
-}