@stdlib/stats-base-dists-binomial-kurtosis 0.0.8 → 0.1.1

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>
+
 # Kurtosis
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -191,7 +202,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>
 
@@ -204,8 +215,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-binomial-kurtosis.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-binomial-kurtosis
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-binomial-kurtosis/actions/workflows/test.yml/badge.svg?branch=v0.0.8
-[test-url]: https://github.com/stdlib-js/stats-base-dists-binomial-kurtosis/actions/workflows/test.yml?query=branch:v0.0.8
+[test-image]: https://github.com/stdlib-js/stats-base-dists-binomial-kurtosis/actions/workflows/test.yml/badge.svg?branch=v0.1.1
+[test-url]: https://github.com/stdlib-js/stats-base-dists-binomial-kurtosis/actions/workflows/test.yml?query=branch:v0.1.1
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-binomial-kurtosis/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-binomial-kurtosis?branch=main
@@ -218,7 +229,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 kurtosis from '../docs/types/index';
+export = kurtosis;

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var a=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var u=a(function(c,s){
+var n=require('@stdlib/math-base-assert-is-nonnegative-integer/dist'),t=require('@stdlib/math-base-assert-is-nan/dist'),v=require('@stdlib/constants-float64-pinf/dist');function o(e,r){var i;return t(e)||t(r)||r<0||r>1||!n(e)||e===v?NaN:(i=r*(1-r),(1-6*i)/(e*i))}s.exports=o
+});var q=u();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/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 isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar PINF = require( '@stdlib/constants-float64-pinf' );\n\n\n// MAIN //\n\n/**\n* Returns the kurtosis of a binomial distribution.\n*\n* @param {NonNegativeInteger} n - number of trials\n* @param {Probability} p - success probability\n* @returns {number} excess kurtosis\n*\n* @example\n* var v = kurtosis( 100, 0.1 );\n* // returns ~0.051\n*\n* @example\n* var v = kurtosis( 20, 0.5 );\n* // returns ~-0.1\n*\n* @example\n* var v = kurtosis( 10.3, 0.5 );\n* // returns NaN\n*\n* @example\n* var v = kurtosis( 20, 1.1 );\n* // returns NaN\n*\n* @example\n* var v = kurtosis( 20, NaN );\n* // returns NaN\n*/\nfunction kurtosis( n, p ) {\n\tvar pq;\n\tif (\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\tpq = p * ( 1.0 - p );\n\treturn ( 1.0 - ( 6.0 * pq ) ) / ( n * pq );\n}\n\n\n// EXPORTS //\n\nmodule.exports = kurtosis;\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 excess kurtosis.\n*\n* @module @stdlib/stats-base-dists-binomial-kurtosis\n*\n* @example\n* var kurtosis = require( '@stdlib/stats-base-dists-binomial-kurtosis' );\n*\n* var v = kurtosis( 100, 0.1 );\n* // returns ~0.051\n*\n* v = kurtosis( 20, 0.5 );\n* // returns ~-0.1\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,iDAAkD,EAClFC,EAAQ,QAAS,iCAAkC,EACnDC,EAAO,QAAS,gCAAiC,EAgCrD,SAASC,EAAUC,EAAGC,EAAI,CACzB,IAAIC,EACJ,OACCL,EAAOG,CAAE,GACTH,EAAOI,CAAE,GACTA,EAAI,GACJA,EAAI,GACJ,CAACL,EAAsBI,CAAE,GACzBA,IAAMF,EAEC,KAERI,EAAKD,GAAM,EAAMA,IACR,EAAQ,EAAMC,IAAWF,EAAIE,GACvC,CAKAP,EAAO,QAAUI,ICtCjB,IAAII,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "isnan", "PINF", "kurtosis", "n", "p", "pq", "main"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Returns the kurtosis of a binomial distribution.

package/lib/index.js

@@ -35,9 +35,9 @@
 
 // MODULES //
 
-var kurtosis = require( './kurtosis.js' );
+var main = require( './main.js' );
 
 
 // EXPORTS //
 
-module.exports = kurtosis;
+module.exports = main;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-binomial-kurtosis",
-  "version": "0.0.8",
+  "version": "0.1.1",
   "description": "Binomial distribution excess kurtosis.",
   "license": "Apache-2.0",
   "author": {
@@ -37,21 +37,21 @@
     "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/constants-float64-pinf": "^0.1.1",
+    "@stdlib/math-base-assert-is-nan": "^0.1.1",
+    "@stdlib/math-base-assert-is-nonnegative-integer": "^0.1.1"
   },
   "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.1",
+    "@stdlib/constants-float64-ninf": "^0.1.1",
+    "@stdlib/math-base-special-abs": "^0.1.0",
+    "@stdlib/math-base-special-ceil": "^0.1.0",
+    "@stdlib/math-base-special-round": "^0.1.1",
+    "@stdlib/random-base-randu": "^0.1.0",
     "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",
@@ -89,7 +89,7 @@
     "univariate"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,40 +0,0 @@
-
-{{alias}}( n, p )
-    Returns the excess kurtosis of a binomial distribution.
-
-    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
-    ----------
-    n: integer
-        Number of trials.
-
-    p: number
-        Success probability.
-
-    Returns
-    -------
-    out: number
-        Excess kurtosis.
-
-    Examples
-    --------
-    > var v = {{alias}}( 100, 0.1 )
-    ~0.051
-    > v = {{alias}}( 20, 0.5 )
-    ~-0.1
-    > v = {{alias}}( 10.3, 0.5 )
-    NaN
-    > v = {{alias}}( 20, 1.1 )
-    NaN
-    > v = {{alias}}( 20, NaN )
-    NaN
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,53 +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 kurtosis = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	kurtosis( 10, 0.3 ); // $ExpectType number
-}
-
-// The function does not compile if provided a first argument which is not a number...
-{
-	kurtosis( true, 0.5 ); // $ExpectError
-	kurtosis( false, 0.5 ); // $ExpectError
-	kurtosis( '5', 0.5 ); // $ExpectError
-	kurtosis( [], 0.5 ); // $ExpectError
-	kurtosis( {}, 0.5 ); // $ExpectError
-	kurtosis( ( x: number ): number => x, 0.5 ); // $ExpectError
-}
-
-// The function does not compile if provided a second argument which is not a number...
-{
-	kurtosis( 8, true ); // $ExpectError
-	kurtosis( 8, false ); // $ExpectError
-	kurtosis( 8, '5' ); // $ExpectError
-	kurtosis( 8, [] ); // $ExpectError
-	kurtosis( 8, {} ); // $ExpectError
-	kurtosis( 8, ( x: number ): number => x ); // $ExpectError
-}
-
-// The function does not compile if provided insufficient arguments...
-{
-	kurtosis(); // $ExpectError
-	kurtosis( 8 ); // $ExpectError
-}