@stdlib/stats-base-dists-kumaraswamy-mode 0.0.7 → 0.2.0

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2022 The Stdlib Authors.
+Copyright (c) 2016-2024 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>
+
 # Mode
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -200,7 +211,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -213,8 +224,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-kumaraswamy-mode.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-kumaraswamy-mode
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-mode/actions/workflows/test.yml/badge.svg?branch=v0.0.7
-[test-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-mode/actions/workflows/test.yml?query=branch:v0.0.7
+[test-image]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-mode/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-mode/actions/workflows/test.yml?query=branch:v0.2.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-kumaraswamy-mode/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-kumaraswamy-mode?branch=main
@@ -227,7 +238,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
 
@@ -237,8 +248,11 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-mode/tree/deno
+[deno-readme]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-mode/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-mode/tree/umd
+[umd-readme]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-mode/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-mode/tree/esm
+[esm-readme]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-mode/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-mode/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-kumaraswamy-mode/main/LICENSE

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+> Policy for reporting security vulnerabilities.
+
+See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var s=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var u=s(function(q,i){
+var t=require('@stdlib/math-base-assert-is-nan/dist'),n=require('@stdlib/math-base-special-pow/dist');function o(e,r){return t(e)||e<1||t(r)||r<1||e===1&&r===1?NaN:n((e-1)/(e*r-1),1/e)}i.exports=o
+});var c=u();module.exports=c;
+/** @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 isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar pow = require( '@stdlib/math-base-special-pow' );\n\n\n// MAIN //\n\n/**\n* Returns the mode of a Kumaraswamy's double bounded distribution.\n*\n* @param {PositiveNumber} a - first shape parameter\n* @param {PositiveNumber} b - second shape parameter\n* @returns {PositiveNumber} mode\n*\n* @example\n* var v = mode( 1.5, 1.5 );\n* // returns ~0.543\n*\n* @example\n* var v = mode( 4.0, 12.0 );\n* // returns ~0.503\n*\n* @example\n* var v = mode( 12.0, 2.0 );\n* // returns ~0.94\n*\n* @example\n* var v = mode( 1.0, 1.0 );\n* // returns NaN\n*\n* @example\n* var v = mode( 1.5, -0.1 );\n* // returns NaN\n*\n* @example\n* var v = mode( -0.1, 1.5 );\n* // returns NaN\n*\n* @example\n* var v = mode( 2.0, NaN );\n* // returns NaN\n*\n* @example\n* var v = mode( NaN, 2.0 );\n* // returns NaN\n*/\nfunction mode( a, b ) {\n\tif (\n\t\tisnan( a ) ||\n\t\ta < 1.0 ||\n\t\tisnan( b ) ||\n\t\tb < 1.0 ||\n\t\t( a === 1.0 && b === 1.0 )\n\t) {\n\t\treturn NaN;\n\t}\n\treturn pow( ( a-1.0 ) / ( (a*b) - 1.0 ), 1.0/a );\n}\n\n\n// EXPORTS //\n\nmodule.exports = mode;\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* Kumaraswamy's double bounded distribution mode.\n*\n* @module @stdlib/stats-base-dists-kumaraswamy-mode\n*\n* @example\n* var mode = require( '@stdlib/stats-base-dists-kumaraswamy-mode' );\n*\n* var v = mode( 2.0, 1.5 );\n* // returns ~0.707\n*\n* v = mode( 4.0, 12.0 );\n* // returns ~0.503\n*\n* v = mode( 16.0, 8.0 );\n* // returns ~0.875\n*/\n\n// MODULES //\n\nvar mode = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = mode;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EA4CnD,SAASC,EAAMC,EAAGC,EAAI,CACrB,OACCJ,EAAOG,CAAE,GACTA,EAAI,GACJH,EAAOI,CAAE,GACTA,EAAI,GACFD,IAAM,GAAOC,IAAM,EAEd,IAEDH,GAAOE,EAAE,IAAWA,EAAEC,EAAK,GAAO,EAAID,CAAE,CAChD,CAKAJ,EAAO,QAAUG,IC3CjB,IAAIG,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "pow", "mode", "a", "b", "mode"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Returns the mode of a Kumaraswamy's double bounded distribution.

package/lib/index.js

@@ -38,7 +38,7 @@
 
 // MODULES //
 
-var mode = require( './mode.js' );
+var mode = require( './main.js' );
 
 
 // EXPORTS //

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-kumaraswamy-mode",
-  "version": "0.0.7",
+  "version": "0.2.0",
   "description": "Kumaraswamy's double bounded distribution mode.",
   "license": "Apache-2.0",
   "author": {
@@ -37,19 +37,20 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-special-pow": "^0.0.x"
+    "@stdlib/math-base-assert-is-nan": "^0.2.0",
+    "@stdlib/math-base-special-pow": "^0.2.0"
   },
   "devDependencies": {
-    "@stdlib/assert-is-number": "^0.0.x",
-    "@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/assert-is-number": "^0.1.1",
+    "@stdlib/constants-float64-eps": "^0.1.1",
+    "@stdlib/constants-float64-ninf": "^0.1.1",
+    "@stdlib/constants-float64-pinf": "^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",
+    "@stdlib/bench-harness": "^0.2.0",
+    "@stdlib/bench": "^0.3.1"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -84,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,33 +0,0 @@
-
-{{alias}}( a, b )
-    Returns the mode of a Kumaraswamy's double bounded distribution.
-
-    If provided `NaN` as any argument, the function returns `NaN`.
-
-    If `a < 1`, `b < 1`, or `a = b = 1`, the function returns `NaN`.
-
-    Parameters
-    ----------
-    a: number
-        First shape parameter.
-
-    b: number
-        Second shape parameter.
-
-    Returns
-    -------
-    out: number
-        Mode.
-
-    Examples
-    --------
-    > var v = {{alias}}( 1.5, 1.5 )
-    ~0.543
-    > v = {{alias}}( 4.0, 12.0 )
-    ~0.503
-    > v = {{alias}}( 16.0, 8.0 )
-    ~0.875
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,56 +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 mode = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	mode( 8, 2 ); // $ExpectType number
-}
-
-// The function does not compile if provided values other than two numbers...
-{
-	mode( true, 3 ); // $ExpectError
-	mode( false, 2 ); // $ExpectError
-	mode( '5', 1 ); // $ExpectError
-	mode( [], 1 ); // $ExpectError
-	mode( {}, 2 ); // $ExpectError
-	mode( ( x: number ): number => x, 2 ); // $ExpectError
-
-	mode( 9, true ); // $ExpectError
-	mode( 9, false ); // $ExpectError
-	mode( 5, '5' ); // $ExpectError
-	mode( 8, [] ); // $ExpectError
-	mode( 9, {} ); // $ExpectError
-	mode( 8, ( x: number ): number => x ); // $ExpectError
-
-	mode( [], true ); // $ExpectError
-	mode( {}, false ); // $ExpectError
-	mode( false, '5' ); // $ExpectError
-	mode( {}, [] ); // $ExpectError
-	mode( '5', ( x: number ): number => x ); // $ExpectError
-}
-
-// The function does not compile if provided insufficient arguments...
-{
-	mode(); // $ExpectError
-	mode( 3 ); // $ExpectError
-}