@stdlib/stats-base-dists-signrank-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] -->
@@ -172,7 +183,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>
 
@@ -185,8 +196,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-signrank-pdf.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-signrank-pdf
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-signrank-pdf/actions/workflows/test.yml/badge.svg?branch=v0.0.7
-[test-url]: https://github.com/stdlib-js/stats-base-dists-signrank-pdf/actions/workflows/test.yml?query=branch:v0.0.7
+[test-image]: https://github.com/stdlib-js/stats-base-dists-signrank-pdf/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-signrank-pdf/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-signrank-pdf/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-signrank-pdf?branch=main
@@ -199,7 +210,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,9 @@
+"use strict";var a=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var s=a(function(D,v){
+var m=require('@stdlib/utils-memoize/dist'),u;function p(r,e){var i;return e===0?r===0?1:0:(i=e*(e+1)/2,r<0||r>i?0:(r>i/2&&(r=i-r),u(r-e,e-1)+u(r,e-1)))}u=m(p);v.exports=u
+});var f=a(function(E,n){
+var N=require('@stdlib/math-base-assert-is-positive-integer/dist'),l=require('@stdlib/math-base-assert-is-finite/dist'),g=require('@stdlib/math-base-assert-is-nan/dist'),d=require('@stdlib/math-base-special-exp/dist'),y=require('@stdlib/math-base-special-ln/dist'),h=require('@stdlib/constants-float64-ln-two/dist'),w=s();function z(r,e){var i;return g(r)||!N(e)||!l(e)?NaN:(i=e*(e+1)/2,r<0||r>i?0:d(y(w(r,e))-e*h))}n.exports=z
+});var o=a(function(G,q){
+var I=require('@stdlib/math-base-assert-is-positive-integer/dist'),L=require('@stdlib/utils-constant-function/dist'),P=require('@stdlib/math-base-assert-is-finite/dist'),F=require('@stdlib/math-base-assert-is-nan/dist'),O=require('@stdlib/math-base-special-exp/dist'),R=require('@stdlib/math-base-special-ln/dist'),b=require('@stdlib/constants-float64-ln-two/dist'),j=s();function k(r){var e;if(!I(r)||!P(r))return L(NaN);return e=r*(r+1)/2,i;function i(t){return F(t)?NaN:t<0||t>e?0:O(R(j(t,r))-r*b)}}q.exports=k
+});var A=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),c=f(),B=o();A(c,"factory",B);module.exports=c;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/weights.js", "../lib/main.js", "../lib/factory.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 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 memoize = require( '@stdlib/utils-memoize' );\n\n\n// VARIABLES //\n\nvar memoized;\n\n\n// FUNCTIONS //\n\n/**\n* Calculates the weight for the `(x,n)` pair and memoizes the result.\n*\n* @private\n* @param {number} x - input value\n* @param {NonNegativeInteger} n - number of observations\n* @returns {number} weight\n*/\nfunction weights( x, n ) {\n\tvar mlim;\n\n\tif ( n === 0 ) {\n\t\treturn ( x === 0 ) ? 1 : 0;\n\t}\n\tmlim = n * ( n + 1 ) / 2;\n\tif ( x < 0 || x > mlim ) {\n\t\treturn 0;\n\t}\n\tif ( x > mlim / 2 ) {\n\t\tx = mlim - x;\n\t}\n\treturn memoized( x - n, n - 1 ) + memoized( x, n - 1 );\n}\n\n\n// MAIN //\n\nmemoized = memoize( weights );\n\n\n// EXPORTS //\n\nmodule.exports = memoized;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 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 isPositiveInteger = require( '@stdlib/math-base-assert-is-positive-integer' );\nvar isfinite = require( '@stdlib/math-base-assert-is-finite' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar exp = require( '@stdlib/math-base-special-exp' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar LN2 = require( '@stdlib/constants-float64-ln-two' );\nvar weights = require( './weights.js' );\n\n\n// MAIN //\n\n/**\n* Evaluates the probability density function (PDF) of the Wilcoxon signed rank test statistic with `n` observations.\n*\n* @param {number} x - input value\n* @param {PositiveInteger} n - number of observations\n* @returns {Probability} evaluated PDF\n*\n* @example\n* var y = pdf( 7.0, 9 );\n* // returns ~0.01\n*\n* @example\n* var y = pdf( 7.0, 6 );\n* // returns ~0.063\n*\n* @example\n* var y = pdf( -1.0, 40 );\n* // returns 0.0\n*\n* @example\n* var y = pdf( NaN, 10 );\n* // returns NaN\n*\n* @example\n* var y = pdf( 0.0, NaN );\n* // returns NaN\n*\n* @example\n* var y = pdf( 2.0, -1 );\n* // returns NaN\n*\n* @example\n* var y = pdf( 2.0, 1.8 );\n* // returns NaN\n*/\nfunction pdf( x, n ) {\n\tvar mlim;\n\tif (\n\t\tisnan( x ) ||\n\t\t!isPositiveInteger( n ) ||\n\t\t!isfinite( n )\n\t) {\n\t\treturn NaN;\n\t}\n\tmlim = ( n * ( n + 1 ) ) / 2;\n\tif ( x < 0.0 || x > mlim ) {\n\t\treturn 0.0;\n\t}\n\treturn exp( ln( weights( x, n ) ) - ( n * LN2 ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = pdf;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 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 isPositiveInteger = require( '@stdlib/math-base-assert-is-positive-integer' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar isfinite = require( '@stdlib/math-base-assert-is-finite' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar exp = require( '@stdlib/math-base-special-exp' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar LN2 = require( '@stdlib/constants-float64-ln-two' );\nvar weights = require( './weights.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the probability density function (PDF) for the distribution of the Wilcoxon signed rank test statistic with `n` observations.\n*\n* @param {PositiveInteger} n - number of observations\n* @returns {Function} PDF\n*\n* @example\n* var pdf = factory( 8 );\n* var y = pdf( 4.0 );\n* // returns ~0.008\n*\n* y = pdf( 17.0 );\n* // returns ~0.051\n*/\nfunction factory( n ) {\n\tvar mlim;\n\tif ( !isPositiveInteger( n ) || !isfinite( n ) ) {\n\t\treturn constantFunction( NaN );\n\t}\n\tmlim = n * ( n + 1 ) / 2;\n\treturn pdf;\n\n\t/**\n\t* Evaluates the probability density function (PDF) for the distribution of the Wilcoxon signed rank test statistic.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {Probability} evaluated PDF\n\t*\n\t* @example\n\t* var y = pdf( 2 );\n\t* // returns <number>\n\t*/\n\tfunction pdf( x ) {\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tif ( x < 0.0 || x > mlim ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\treturn exp( ln( weights( x, n ) ) - ( n * LN2 ) );\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 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* Wilcoxon signed rank test statistic probability density function (PDF).\n*\n* @module @stdlib/stats-base-dists-signrank-pdf\n*\n* @example\n* var pdf = require( '@stdlib/stats-base-dists-signrank-pdf' );\n*\n* var y = pdf( 7.0, 9 );\n* // returns ~0.01\n*\n* var mypdf = pdf.factory( 8 );\n* y = mypdf( 4.0 );\n* // returns ~0.008\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,EAAU,QAAS,uBAAwB,EAK3CC,EAaJ,SAASC,EAASC,EAAGC,EAAI,CACxB,IAAIC,EAEJ,OAAKD,IAAM,EACDD,IAAM,EAAM,EAAI,GAE1BE,EAAOD,GAAMA,EAAI,GAAM,EAClBD,EAAI,GAAKA,EAAIE,EACV,GAEHF,EAAIE,EAAO,IACfF,EAAIE,EAAOF,GAELF,EAAUE,EAAIC,EAAGA,EAAI,CAAE,EAAIH,EAAUE,EAAGC,EAAI,CAAE,GACtD,CAKAH,EAAWD,EAASE,CAAQ,EAK5BH,EAAO,QAAUE,IChEjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,8CAA+C,EAC5EC,EAAW,QAAS,oCAAqC,EACzDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAM,QAAS,kCAAmC,EAClDC,EAAU,IAwCd,SAASC,EAAKC,EAAGC,EAAI,CACpB,IAAIC,EACJ,OACCR,EAAOM,CAAE,GACT,CAACR,EAAmBS,CAAE,GACtB,CAACR,EAAUQ,CAAE,EAEN,KAERC,EAASD,GAAMA,EAAI,GAAQ,EACtBD,EAAI,GAAOA,EAAIE,EACZ,EAEDP,EAAKC,EAAIE,EAASE,EAAGC,CAAE,CAAE,EAAMA,EAAIJ,CAAM,EACjD,CAKAN,EAAO,QAAUQ,ICvFjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,8CAA+C,EAC5EC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAW,QAAS,oCAAqC,EACzDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAM,QAAS,kCAAmC,EAClDC,EAAU,IAmBd,SAASC,EAASC,EAAI,CACrB,IAAIC,EACJ,GAAK,CAACV,EAAmBS,CAAE,GAAK,CAACP,EAAUO,CAAE,EAC5C,OAAOR,EAAkB,GAAI,EAE9B,OAAAS,EAAOD,GAAMA,EAAI,GAAM,EAChBE,EAaP,SAASA,EAAKC,EAAI,CACjB,OAAKT,EAAOS,CAAE,EACN,IAEHA,EAAI,GAAOA,EAAIF,EACZ,EAEDN,EAAKC,EAAIE,EAASK,EAAGH,CAAE,CAAE,EAAMA,EAAIH,CAAM,CACjD,CACD,CAKAP,EAAO,QAAUS,IC3CjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "names": ["require_weights", "__commonJSMin", "exports", "module", "memoize", "memoized", "weights", "x", "n", "mlim", "require_main", "__commonJSMin", "exports", "module", "isPositiveInteger", "isfinite", "isnan", "exp", "ln", "LN2", "weights", "pdf", "x", "n", "mlim", "require_factory", "__commonJSMin", "exports", "module", "isPositiveInteger", "constantFunction", "isfinite", "isnan", "exp", "ln", "LN2", "weights", "factory", "n", "mlim", "pdf", "x", "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) of the Wilcoxon signed rank test statistic.

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-signrank-pdf",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Wilcoxon signed rank test statistic probability density function (PDF).",
   "license": "Apache-2.0",
   "author": {
@@ -37,28 +37,28 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/constants-float64-ln-two": "^0.0.x",
-    "@stdlib/math-base-assert-is-finite": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-assert-is-positive-integer": "^0.0.x",
-    "@stdlib/math-base-special-exp": "^0.0.x",
-    "@stdlib/math-base-special-ln": "^0.0.x",
-    "@stdlib/utils-constant-function": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
-    "@stdlib/utils-memoize": "^0.0.x"
+    "@stdlib/constants-float64-ln-two": "^0.1.0",
+    "@stdlib/math-base-assert-is-finite": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-assert-is-positive-integer": "^0.1.0",
+    "@stdlib/math-base-special-exp": "^0.1.0",
+    "@stdlib/math-base-special-ln": "^0.1.0",
+    "@stdlib/utils-constant-function": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
+    "@stdlib/utils-memoize": "^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/math-base-special-abs": "^0.0.x",
-    "@stdlib/math-base-special-ceil": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
-    "@stdlib/stats-base-dists-signrank-pdf": "^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/math-base-special-abs": "^0.1.0",
+    "@stdlib/math-base-special-ceil": "^0.1.0",
+    "@stdlib/random-base-randu": "^0.0.8",
+    "@stdlib/stats-base-dists-signrank-pdf": "^0.0.7",
     "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",
@@ -92,7 +92,7 @@
     "continuous"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,63 +0,0 @@
-
-{{alias}}( x, n )
-    Evaluates the probability density function (PDF) for the distribution of
-    the Wilcoxon signed rank test statistic with `n` observations.
-
-    If provided `NaN` as any argument, the function returns `NaN`.
-
-    If provided a negative value for `x`, the function returns `NaN`.
-
-    If not provided a positive integer for `n`, the function returns `NaN`.
-
-    Parameters
-    ----------
-    x: number
-        Input value.
-
-    n: integer
-        Number of observations.
-
-    Returns
-    -------
-    out: number
-        Evaluated PDF.
-
-    Examples
-    --------
-    > var y = {{alias}}( 3, 7 )
-    ~0.0156
-    > y = {{alias}}( 1.8, 3 )
-    0.0
-    > y = {{alias}}( -1.0, 40 )
-    0.0
-    > y = {{alias}}( NaN, 10 )
-    NaN
-    > y = {{alias}}( 0.0, NaN )
-    NaN
-
-
-{{alias}}.factory( n )
-    Returns a function for evaluating the probability density function (PDF)
-    of the distribution of the Wilcoxon signed rank test statistic.
-
-    Parameters
-    ----------
-    n: integer
-        Number of observations.
-
-    Returns
-    -------
-    pdf: Function
-        Probability density function (PDF).
-
-    Examples
-    --------
-    > var myPDF = {{alias}}.factory( 8 );
-    > var y = myPDF( 6.0 )
-    ~0.0156
-    > y = myPDF( 2.0 )
-    ~0.0039
-
-    See Also
-    --------
-

package/docs/types/test.ts

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