@stdlib/stats-base-dists-binomial-pmf 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 Mass Function
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -194,7 +205,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>
 
@@ -207,8 +218,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-binomial-pmf.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-binomial-pmf
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-binomial-pmf/actions/workflows/test.yml/badge.svg?branch=v0.0.7
-[test-url]: https://github.com/stdlib-js/stats-base-dists-binomial-pmf/actions/workflows/test.yml?query=branch:v0.0.7
+[test-image]: https://github.com/stdlib-js/stats-base-dists-binomial-pmf/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-binomial-pmf/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-binomial-pmf/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-binomial-pmf?branch=main
@@ -221,7 +232,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 pmf from '../docs/types/index';
+export = pmf;

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";var v=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var q=v(function(C,o){
+var f=require('@stdlib/math-base-assert-is-nonnegative-integer/dist'),m=require('@stdlib/math-base-special-binomcoefln/dist'),a=require('@stdlib/math-base-assert-is-nan/dist'),y=require('@stdlib/math-base-special-log1p/dist'),I=require('@stdlib/math-base-special-exp/dist'),F=require('@stdlib/math-base-special-ln/dist'),b=require('@stdlib/constants-float64-pinf/dist');function d(e,r,u){var i;return a(e)||a(r)||a(u)||u<0||u>1||!f(r)||r===b?NaN:f(e)?e>r?0:u===0?e===0?1:0:u===1?e===r?1:0:(i=m(r,e),i+=e*F(u)+(r-e)*y(-u),I(i)):0}o.exports=d
+});var l=v(function(D,N){
+var s=require('@stdlib/math-base-assert-is-nonnegative-integer/dist'),P=require('@stdlib/utils-constant-function/dist'),O=require('@stdlib/math-base-special-binomcoefln/dist'),c=require('@stdlib/stats-base-dists-degenerate-pmf/dist').factory,n=require('@stdlib/math-base-assert-is-nan/dist'),R=require('@stdlib/math-base-special-log1p/dist'),h=require('@stdlib/math-base-special-exp/dist'),j=require('@stdlib/math-base-special-ln/dist'),k=require('@stdlib/constants-float64-pinf/dist');function w(e,r){if(n(e)||n(r)||!s(e)||e===k||r<0||r>1)return P(NaN);if(r===0||e===0)return c(0);if(r===1)return c(e);return u;function u(i){var t;return n(i)?NaN:s(i)?i>e?0:(t=O(e,i),t+=i*j(r)+(e-i)*R(-r),h(t)):0}}N.exports=w
+});var z=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),g=q(),A=l();z(g,"factory",A);module.exports=g;
+/** @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 isNonNegativeInteger = require( '@stdlib/math-base-assert-is-nonnegative-integer' );\nvar binomcoefln = require( '@stdlib/math-base-special-binomcoefln' );\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 ln = require( '@stdlib/math-base-special-ln' );\nvar PINF = require( '@stdlib/constants-float64-pinf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the probability mass function (PMF) for a binomial distribution with number of trials `n` and success probability `p` at a value `x`.\n*\n* @param {number} x - input value\n* @param {NonNegativeInteger} n - number of trials\n* @param {Probability} p - success probability\n* @returns {Probability} evaluated PMF\n*\n* @example\n* var y = pmf( 3.0, 20, 0.2 );\n* // returns ~0.205\n*\n* @example\n* var y = pmf( 21.0, 20, 0.2 );\n* // returns 0.0\n*\n* @example\n* var y = pmf( 5.0, 10, 0.4 );\n* // returns ~0.201\n*\n* @example\n* var y = pmf( 0.0, 10, 0.4 );\n* // returns ~0.006\n*\n* @example\n* var y = pmf( NaN, 20, 0.5 );\n* // returns NaN\n*\n* @example\n* var y = pmf( 0.0, NaN, 0.5 );\n* // returns NaN\n*\n* @example\n* var y = pmf( 0.0, 20, NaN );\n* // returns NaN\n*\n* @example\n* var y = pmf( 2.0, 1.5, 0.5 );\n* // returns NaN\n*\n* @example\n* var y = pmf( 2.0, -2.0, 0.5 );\n* // returns NaN\n*\n* @example\n* var y = pmf( 2.0, 20, -1.0 );\n* // returns NaN\n*\n* @example\n* var y = pmf( 2.0, 20, 1.5 );\n* // returns NaN\n*/\nfunction pmf( x, n, p ) {\n\tvar lnl;\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( n ) ||\n\t\tisnan( p ) ||\n\t\tp < 0.0 ||\n\t\tp > 1.0 ||\n\t\t!isNonNegativeInteger( n ) ||\n\t\tn === PINF\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( isNonNegativeInteger( x ) ) {\n\t\tif ( x > n ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\tif ( p === 0.0 ) {\n\t\t\treturn ( x === 0 ) ? 1.0 : 0.0;\n\t\t}\n\t\tif ( p === 1.0 ) {\n\t\t\treturn ( x === n ) ? 1.0 : 0.0;\n\t\t}\n\t\tlnl = binomcoefln( n, x );\n\t\tlnl += (x * ln( p )) + (( n - x ) * log1p( -p ));\n\t\treturn exp( lnl );\n\t}\n\treturn 0.0;\n}\n\n\n// EXPORTS //\n\nmodule.exports = pmf;\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 binomcoefln = require( '@stdlib/math-base-special-binomcoefln' );\nvar degenerate = require( '@stdlib/stats-base-dists-degenerate-pmf' ).factory;\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 ln = require( '@stdlib/math-base-special-ln' );\nvar PINF = require( '@stdlib/constants-float64-pinf' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the probability mass function (PMF) for a binomial distribution with number of trials `n` and success probability `p`.\n*\n* @param {NonNegativeInteger} n - number of trials\n* @param {Probability} p - success probability\n* @returns {Function} PMF\n*\n* @example\n* var pmf = factory( 10, 0.5 );\n* var y = pmf( 3.0 );\n* // returns ~0.117\n*\n* y = pmf( 5.0 );\n* // returns ~0.246\n*/\nfunction factory( n, p ) {\n\tif (\n\t\tisnan( n ) ||\n\t\tisnan( p ) ||\n\t\t!isNonNegativeInteger( n ) ||\n\t\tn === PINF ||\n\t\tp < 0.0 ||\n\t\tp > 1.0\n\t) {\n\t\treturn constantFunction( NaN );\n\t}\n\tif ( p === 0.0 || n === 0 ) {\n\t\treturn degenerate( 0.0 );\n\t}\n\tif ( p === 1.0 ) {\n\t\treturn degenerate( n );\n\t}\n\treturn pmf;\n\n\t/**\n\t* Evaluates the probability mass function (PMF) for a binomial distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {Probability} evaluated PMF\n\t*\n\t* @example\n\t* var y = pmf( 2.0 );\n\t* // returns <number>\n\t*/\n\tfunction pmf( x ) {\n\t\tvar lnl;\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tif ( isNonNegativeInteger( x ) ) {\n\t\t\tif ( x > n ) {\n\t\t\t\treturn 0.0;\n\t\t\t}\n\t\t\tlnl = binomcoefln( n, x );\n\t\t\tlnl += (x * ln( p )) + ((n - x) * log1p( -p ));\n\t\t\treturn exp( lnl );\n\t\t}\n\t\treturn 0.0;\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* Binomial distribution probability mass function (PMF).\n*\n* @module @stdlib/stats-base-dists-binomial-pmf\n*\n* @example\n* var pmf = require( '@stdlib/stats-base-dists-binomial-pmf' );\n*\n* var y = pmf( 3.0, 20, 0.2 );\n* // returns ~0.205\n*\n* y = pmf( 21.0, 20, 0.2 );\n* // returns 0.0\n*\n* y = pmf( 5.0, 10, 0.4 );\n* // returns ~0.201\n*\n* y = pmf( 0.0, 10, 0.4 );\n* // returns ~0.06\n*\n* @example\n* var factory = require( '@stdlib/stats-base-dists-binomial-pmf' ).factory;\n*\n* var pmf = factory( 10, 0.5 );\n*\n* var y = pmf( 3.0 );\n* // returns ~0.117\n*\n* y = pmf( 5.0 );\n* // returns ~0.246\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,EAC/DC,EAAQ,QAAS,iCAAkC,EACnDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EAyDrD,SAASC,EAAKC,EAAGC,EAAGC,EAAI,CACvB,IAAIC,EACJ,OACCT,EAAOM,CAAE,GACTN,EAAOO,CAAE,GACTP,EAAOQ,CAAE,GACTA,EAAI,GACJA,EAAI,GACJ,CAACV,EAAsBS,CAAE,GACzBA,IAAMH,EAEC,IAEHN,EAAsBQ,CAAE,EACvBA,EAAIC,EACD,EAEHC,IAAM,EACDF,IAAM,EAAM,EAAM,EAEvBE,IAAM,EACDF,IAAMC,EAAM,EAAM,GAE5BE,EAAMV,EAAaQ,EAAGD,CAAE,EACxBG,GAAQH,EAAIH,EAAIK,CAAE,GAAQD,EAAID,GAAML,EAAO,CAACO,CAAE,EACvCN,EAAKO,CAAI,GAEV,CACR,CAKAZ,EAAO,QAAUQ,ICtHjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,iDAAkD,EAClFC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAc,QAAS,uCAAwC,EAC/DC,EAAa,QAAS,yCAA0C,EAAE,QAClEC,EAAQ,QAAS,iCAAkC,EACnDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EAoBrD,SAASC,EAASC,EAAGC,EAAI,CACxB,GACCP,EAAOM,CAAE,GACTN,EAAOO,CAAE,GACT,CAACX,EAAsBU,CAAE,GACzBA,IAAMF,GACNG,EAAI,GACJA,EAAI,EAEJ,OAAOV,EAAkB,GAAI,EAE9B,GAAKU,IAAM,GAAOD,IAAM,EACvB,OAAOP,EAAY,CAAI,EAExB,GAAKQ,IAAM,EACV,OAAOR,EAAYO,CAAE,EAEtB,OAAOE,EAaP,SAASA,EAAKC,EAAI,CACjB,IAAIC,EACJ,OAAKV,EAAOS,CAAE,EACN,IAEHb,EAAsBa,CAAE,EACvBA,EAAIH,EACD,GAERI,EAAMZ,EAAaQ,EAAGG,CAAE,EACxBC,GAAQD,EAAIN,EAAII,CAAE,GAAOD,EAAIG,GAAKR,EAAO,CAACM,CAAE,EACrCL,EAAKQ,CAAI,GAEV,CACR,CACD,CAKAf,EAAO,QAAUU,IC9CjB,IAAIM,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "binomcoefln", "isnan", "log1p", "exp", "ln", "PINF", "pmf", "x", "n", "p", "lnl", "require_factory", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "constantFunction", "binomcoefln", "degenerate", "isnan", "log1p", "exp", "ln", "PINF", "factory", "n", "p", "pmf", "x", "lnl", "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 mass function (PMF) for a binomial distribution.

package/lib/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-binomial-pmf",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Binomial distribution probability mass function (PMF).",
   "license": "Apache-2.0",
   "author": {
@@ -37,28 +37,28 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/constants-float64-pinf": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-assert-is-nonnegative-integer": "^0.0.x",
-    "@stdlib/math-base-special-binomcoefln": "^0.0.x",
-    "@stdlib/math-base-special-exp": "^0.0.x",
-    "@stdlib/math-base-special-ln": "^0.0.x",
-    "@stdlib/math-base-special-log1p": "^0.0.x",
-    "@stdlib/stats-base-dists-degenerate-pmf": "^0.0.x",
-    "@stdlib/utils-constant-function": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
+    "@stdlib/constants-float64-pinf": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-assert-is-nonnegative-integer": "^0.1.0",
+    "@stdlib/math-base-special-binomcoefln": "^0.1.0",
+    "@stdlib/math-base-special-exp": "^0.1.0",
+    "@stdlib/math-base-special-ln": "^0.1.0",
+    "@stdlib/math-base-special-log1p": "^0.1.0",
+    "@stdlib/stats-base-dists-degenerate-pmf": "^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/math-base-special-abs": "^0.0.x",
-    "@stdlib/math-base-special-ceil": "^0.0.x",
-    "@stdlib/math-base-special-round": "^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/math-base-special-abs": "^0.1.0",
+    "@stdlib/math-base-special-ceil": "^0.1.0",
+    "@stdlib/math-base-special-round": "^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",
@@ -97,7 +97,7 @@
     "univariate"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,82 +0,0 @@
-
-{{alias}}( x, n, p )
-    Evaluates the probability mass function (PMF) for a binomial distribution
-    with number of trials `n` and success probability `p` at a value `x`.
-
-    If provided `NaN` as any argument, the function returns `NaN`.
-
-    If provided a number of trials `n` which is not a nonnegative integer, the
-    function returns `NaN`.
-
-    If `p < 0` or `p > 1`, the function returns `NaN`.
-
-    Parameters
-    ----------
-    x: number
-        Input value.
-
-    n: integer
-        Number of trials.
-
-    p: number
-        Success probability.
-
-    Returns
-    -------
-    out: number
-        Evaluated PMF.
-
-    Examples
-    --------
-    > var y = {{alias}}( 3.0, 20, 0.2 )
-    ~0.205
-    > y = {{alias}}( 21.0, 20, 0.2 )
-    0.0
-    > y = {{alias}}( 5.0, 10, 0.4 )
-    ~0.201
-    > y = {{alias}}( 0.0, 10, 0.4 )
-    ~0.006
-    > y = {{alias}}( NaN, 20, 0.5 )
-    NaN
-    > y = {{alias}}( 0.0, NaN, 0.5 )
-    NaN
-    > y = {{alias}}( 0.0, 20, NaN )
-    NaN
-    > y = {{alias}}( 2.0, 1.5, 0.5 )
-    NaN
-    > y = {{alias}}( 2.0, -2.0, 0.5 )
-    NaN
-    > y = {{alias}}( 2.0, 20, -1.0 )
-    NaN
-    > y = {{alias}}( 2.0, 20, 1.5 )
-    NaN
-
-
-{{alias}}.factory( n, p )
-    Returns a function for evaluating the probability mass function (PMF) of a
-    binomial distribution with number of trials `n` and success probability `p`.
-
-    Parameters
-    ----------
-    n: integer
-        Number of trials.
-
-    p: number
-        Success probability.
-
-    Returns
-    -------
-    pmf: Function
-        Probability mass function (PMF).
-
-    Examples
-    --------
-    > var mypmf = {{alias}}.factory( 10, 0.5 );
-    > var y = mypmf( 3.0 )
-    ~0.117
-    > y = mypmf( 5.0 )
-    ~0.246
-
-    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 pmf = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	pmf( 2, 2, 0.4 ); // $ExpectType number
-	pmf( 1, 2, 0.8 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function is provided values other than three numbers...
-{
-	pmf( true, 3, 0.6 ); // $ExpectError
-	pmf( false, 2, 0.4 ); // $ExpectError
-	pmf( '5', 1, 0.2 ); // $ExpectError
-	pmf( [], 1, 0.2 ); // $ExpectError
-	pmf( {}, 2, 0.4 ); // $ExpectError
-	pmf( ( x: number ): number => x, 2, 0.4 ); // $ExpectError
-
-	pmf( 9, true, 0.2 ); // $ExpectError
-	pmf( 9, false, 0.2 ); // $ExpectError
-	pmf( 5, '5', 0.1 ); // $ExpectError
-	pmf( 8, [], 0.6 ); // $ExpectError
-	pmf( 9, {}, 0.8 ); // $ExpectError
-	pmf( 8, ( x: number ): number => x, 0.6 ); // $ExpectError
-
-	pmf( 9, 5, true ); // $ExpectError
-	pmf( 9, 5, false ); // $ExpectError
-	pmf( 5, 2, '5' ); // $ExpectError
-	pmf( 8, 4, [] ); // $ExpectError
-	pmf( 9, 4, {} ); // $ExpectError
-	pmf( 8, 5, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	pmf(); // $ExpectError
-	pmf( 2 ); // $ExpectError
-	pmf( 2, 0 ); // $ExpectError
-	pmf( 2, 0, 0.4, 1 ); // $ExpectError
-}
-
-// Attached to main export is a `factory` method which returns a function...
-{
-	pmf.factory( 3, 0.4 ); // $ExpectType Unary
-}
-
-// The `factory` method returns a function which returns a number...
-{
-	const fcn = pmf.factory( 3, 0.4 );
-	fcn( 2 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments...
-{
-	const fcn = pmf.factory( 3, 0.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 = pmf.factory( 3, 0.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...
-{
-	pmf.factory( true, 0.3 ); // $ExpectError
-	pmf.factory( false, 0.2 ); // $ExpectError
-	pmf.factory( '5', 0.1 ); // $ExpectError
-	pmf.factory( [], 0.1 ); // $ExpectError
-	pmf.factory( {}, 0.2 ); // $ExpectError
-	pmf.factory( ( x: number ): number => x, 0.2 ); // $ExpectError
-
-	pmf.factory( 9, true ); // $ExpectError
-	pmf.factory( 9, false ); // $ExpectError
-	pmf.factory( 5, '5' ); // $ExpectError
-	pmf.factory( 8, [] ); // $ExpectError
-	pmf.factory( 9, {} ); // $ExpectError
-	pmf.factory( 8, ( x: number ): number => x ); // $ExpectError
-
-	pmf.factory( [], true ); // $ExpectError
-	pmf.factory( {}, false ); // $ExpectError
-	pmf.factory( false, '5' ); // $ExpectError
-	pmf.factory( {}, [] ); // $ExpectError
-	pmf.factory( '5', ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
-{
-	pmf.factory( 3 ); // $ExpectError
-	pmf.factory( 3, 0.4, 8 ); // $ExpectError
-}