@stdlib/stats-base-dists-rayleigh-quantile 0.0.7 → 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>
+
 # Quantile Function
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -189,7 +200,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>
 
@@ -202,8 +213,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-rayleigh-quantile.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-rayleigh-quantile
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-quantile/actions/workflows/test.yml/badge.svg?branch=v0.0.7
-[test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-quantile/actions/workflows/test.yml?query=branch:v0.0.7
+[test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-quantile/actions/workflows/test.yml/badge.svg?branch=v0.1.1
+[test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-quantile/actions/workflows/test.yml?query=branch:v0.1.1
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-rayleigh-quantile/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-rayleigh-quantile?branch=main
@@ -216,7 +227,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 quantile from '../docs/types/index';
+export = quantile;

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var q=n(function(j,i){
+var a=require('@stdlib/math-base-assert-is-nan/dist'),s=require('@stdlib/math-base-special-log1p/dist'),N=require('@stdlib/math-base-special-sqrt/dist');function l(e,r){var t;return a(r)||r<0?NaN:a(e)||e<0||e>1?NaN:r===0?0:(t=r*r,N(-2*t*s(-e)))}i.exports=l
+});var v=n(function(k,f){
+var y=require('@stdlib/utils-constant-function/dist'),x=require('@stdlib/stats-base-dists-degenerate-quantile/dist').factory,o=require('@stdlib/math-base-assert-is-nan/dist'),d=require('@stdlib/math-base-special-log1p/dist'),F=require('@stdlib/math-base-special-sqrt/dist');function O(e){var r;if(o(e)||e<0)return y(NaN);if(e===0)return x(0);return r=e*e,t;function t(u){return o(u)||u<0||u>1?NaN:F(-2*r*d(-u))}}f.exports=O
+});var R=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),c=q(),b=v();R(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/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 log1p = require( '@stdlib/math-base-special-log1p' );\nvar sqrt = require( '@stdlib/math-base-special-sqrt' );\n\n\n// MAIN //\n\n/**\n* Evaluates the quantile function for a Rayleigh distribution with scale parameter `sigma` at a probability `p`.\n*\n* @param {Probability} p - input value\n* @param {NonNegativeNumber} sigma - scale parameter\n* @returns {number} evaluated quantile function\n*\n* @example\n* var y = quantile( 0.8, 1.0 );\n* // returns ~1.794\n*\n* @example\n* var y = quantile( 0.5, 4.0 );\n* // returns ~4.71\n*\n* @example\n* var y = quantile( 1.1, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = quantile( -0.2, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = quantile( NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = quantile( 0.0, NaN );\n* // returns NaN\n*\n* @example\n* // Negative scale parameter:\n* var y = quantile( 0.5, -1.0 );\n* // returns NaN\n*/\nfunction quantile( p, sigma ) {\n\tvar s2;\n\tif ( isnan( sigma ) || sigma < 0.0 ) {\n\t\treturn NaN;\n\t}\n\tif ( isnan( p ) || p < 0.0 || p > 1.0 ) {\n\t\treturn NaN;\n\t}\n\tif ( sigma === 0.0 ) {\n\t\treturn 0.0;\n\t}\n\ts2 = sigma * sigma;\n\treturn sqrt( -2.0 * s2 * log1p( -p ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = quantile;\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 degenerate = require( '@stdlib/stats-base-dists-degenerate-quantile' ).factory;\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar log1p = require( '@stdlib/math-base-special-log1p' );\nvar sqrt = require( '@stdlib/math-base-special-sqrt' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the quantile function for a Rayleigh distribution with scale parameter `sigma`.\n*\n* @param {NonNegativeNumber} sigma - scale parameter\n* @returns {Function} quantile function\n*\n* @example\n* var quantile = factory( 10.0 );\n* var y = quantile( 0.5 );\n* // returns ~11.774\n*\n* y = quantile( 0.8 );\n* // returns ~17.941\n*/\nfunction factory( sigma ) {\n\tvar s2;\n\tif ( isnan( sigma ) || sigma < 0.0 ) {\n\t\treturn constantFunction( NaN );\n\t}\n\tif ( sigma === 0.0 ) {\n\t\treturn degenerate( 0.0 );\n\t}\n\ts2 = sigma * sigma;\n\treturn quantile;\n\n\t/**\n\t* Evaluates the quantile function for a Rayleigh distribution.\n\t*\n\t* @private\n\t* @param {Probability} p - input value\n\t* @returns {number} evaluated quantile function\n\t*\n\t* @example\n\t* var y = quantile( 0.3 );\n\t* // returns <number>\n\t*/\n\tfunction quantile( p ) {\n\t\tif ( isnan( p ) || p < 0.0 || p > 1.0 ) {\n\t\t\treturn NaN;\n\t\t}\n\t\treturn sqrt( -2.0 * s2 * log1p( -p ) );\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* Rayleigh distribution quantile function.\n*\n* @module @stdlib/stats-base-dists-rayleigh-quantile\n*\n* @example\n* var quantile = require( '@stdlib/stats-base-dists-rayleigh-quantile' );\n*\n* var y = quantile( 0.5, 4.0 );\n* // returns ~4.71\n*\n* var myQuantile = quantile.factory( 0.4 );\n*\n* y = myQuantile( 0.4 );\n* // returns ~0.404\n*\n* y = myQuantile( 1.0 );\n* // returns Infinity\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,EAAQ,QAAS,iCAAkC,EACnDC,EAAO,QAAS,gCAAiC,EAyCrD,SAASC,EAAUC,EAAGC,EAAQ,CAC7B,IAAIC,EACJ,OAAKN,EAAOK,CAAM,GAAKA,EAAQ,EACvB,IAEHL,EAAOI,CAAE,GAAKA,EAAI,GAAOA,EAAI,EAC1B,IAEHC,IAAU,EACP,GAERC,EAAKD,EAAQA,EACNH,EAAM,GAAOI,EAAKL,EAAO,CAACG,CAAE,CAAE,EACtC,CAKAL,EAAO,QAAUI,ICnFjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAa,QAAS,8CAA+C,EAAE,QACvEC,EAAQ,QAAS,iCAAkC,EACnDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAO,QAAS,gCAAiC,EAmBrD,SAASC,EAASC,EAAQ,CACzB,IAAIC,EACJ,GAAKL,EAAOI,CAAM,GAAKA,EAAQ,EAC9B,OAAON,EAAkB,GAAI,EAE9B,GAAKM,IAAU,EACd,OAAOL,EAAY,CAAI,EAExB,OAAAM,EAAKD,EAAQA,EACNE,EAaP,SAASA,EAAUC,EAAI,CACtB,OAAKP,EAAOO,CAAE,GAAKA,EAAI,GAAOA,EAAI,EAC1B,IAEDL,EAAM,GAAOG,EAAKJ,EAAO,CAACM,CAAE,CAAE,CACtC,CACD,CAKAV,EAAO,QAAUM,ICpCjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "log1p", "sqrt", "quantile", "p", "sigma", "s2", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "degenerate", "isnan", "log1p", "sqrt", "factory", "sigma", "s2", "quantile", "p", "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 quantile function for a Rayleigh distribution.

package/lib/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-rayleigh-quantile",
-  "version": "0.0.7",
+  "version": "0.1.1",
   "description": "Rayleigh distribution quantile function.",
   "license": "Apache-2.0",
   "author": {
@@ -37,22 +37,22 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-special-log1p": "^0.0.x",
-    "@stdlib/math-base-special-sqrt": "^0.0.x",
-    "@stdlib/stats-base-dists-degenerate-quantile": "^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.1",
+    "@stdlib/math-base-special-log1p": "^0.1.1",
+    "@stdlib/math-base-special-sqrt": "^0.1.1",
+    "@stdlib/stats-base-dists-degenerate-quantile": "^0.1.1",
+    "@stdlib/utils-constant-function": "^0.1.1",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^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/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/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",
@@ -86,7 +86,7 @@
     "continuous"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,71 +0,0 @@
-
-{{alias}}( p, sigma )
-    Evaluates the quantile function for a Rayleigh distribution with scale
-    parameter `sigma` at a probability `p`.
-
-    If `p < 0` or `p > 1`, the function returns `NaN`.
-
-    If provided `NaN` as any argument, the function returns `NaN`.
-
-    If provided a negative probability for `sigma`, the function returns `NaN`.
-
-    Parameters
-    ----------
-    p: number
-        Input probability.
-
-    sigma: number
-        Scale parameter.
-
-    Returns
-    -------
-    out: number
-        Evaluated quantile function.
-
-    Examples
-    --------
-    > var y = {{alias}}( 0.8, 1.0 )
-    ~1.794
-    > y = {{alias}}( 0.5, 4.0 )
-    ~4.71
-
-    > y = {{alias}}( 1.1, 1.0 )
-    NaN
-    > y = {{alias}}( -0.2, 1.0 )
-    NaN
-
-    > y = {{alias}}( NaN, 1.0 )
-    NaN
-    > y = {{alias}}( 0.0, NaN )
-    NaN
-
-    // Negative scale parameter:
-    > y = {{alias}}( 0.5, -1.0 )
-    NaN
-
-
-{{alias}}.factory( sigma )
-    Returns a function for evaluating the quantile function of a Rayleigh
-    distribution with scale parameter `sigma`.
-
-    Parameters
-    ----------
-    sigma: number
-        Scale parameter.
-
-    Returns
-    -------
-    quantile: Function
-        Quantile function.
-
-    Examples
-    --------
-    > var myQuantile = {{alias}}.factory( 0.4 );
-    > var y = myQuantile( 0.4 )
-    ~0.404
-    > y = myQuantile( 1.0 )
-    Infinity
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,98 +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 quantile = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	quantile( 0.2, 2 ); // $ExpectType number
-	quantile( 0.1, 2 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function is provided values other than two numbers...
-{
-	quantile( true, 3 ); // $ExpectError
-	quantile( false, 2 ); // $ExpectError
-	quantile( '5', 1 ); // $ExpectError
-	quantile( [], 1 ); // $ExpectError
-	quantile( {}, 2 ); // $ExpectError
-	quantile( ( x: number ): number => x, 2 ); // $ExpectError
-
-	quantile( 0.9, true ); // $ExpectError
-	quantile( 0.9, false ); // $ExpectError
-	quantile( 0.5, '5' ); // $ExpectError
-	quantile( 0.8, [] ); // $ExpectError
-	quantile( 0.9, {} ); // $ExpectError
-	quantile( 0.8, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	quantile(); // $ExpectError
-	quantile( 0.2 ); // $ExpectError
-	quantile( 0.2, 0, 4 ); // $ExpectError
-}
-
-// Attached to main export is a `factory` method which returns a function...
-{
-	quantile.factory( 3 ); // $ExpectType Unary
-}
-
-// The `factory` method returns a function which returns a number...
-{
-	const fcn = quantile.factory( 3 );
-	fcn( 0.2 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function returned by the `factory` method is provided an invalid argument...
-{
-	const fcn = quantile.factory( 3 );
-	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 = quantile.factory( 3 );
-	fcn(); // $ExpectError
-	fcn( 0.2, 0 ); // $ExpectError
-	fcn( 0.2, 0, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided a value other than a number...
-{
-	quantile.factory( true ); // $ExpectError
-	quantile.factory( false ); // $ExpectError
-	quantile.factory( '5' ); // $ExpectError
-	quantile.factory( [] ); // $ExpectError
-	quantile.factory( {} ); // $ExpectError
-	quantile.factory( ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
-{
-	quantile.factory( 2, 2 ); // $ExpectError
-	quantile.factory( 3, 4, 8 ); // $ExpectError
-}