@stdlib/stats-base-dists-logistic-cdf 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>
+
 # Cumulative Distribution Function
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -190,7 +201,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>
 
@@ -203,8 +214,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-logistic-cdf.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-logistic-cdf
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-logistic-cdf/actions/workflows/test.yml/badge.svg?branch=v0.0.7
-[test-url]: https://github.com/stdlib-js/stats-base-dists-logistic-cdf/actions/workflows/test.yml?query=branch:v0.0.7
+[test-image]: https://github.com/stdlib-js/stats-base-dists-logistic-cdf/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-logistic-cdf/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-logistic-cdf/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-logistic-cdf?branch=main
@@ -217,7 +228,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 cdf from '../docs/types/index';
+export = cdf;

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";var c=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var o=c(function(O,f){
+var a=require('@stdlib/math-base-assert-is-nan/dist'),N=require('@stdlib/math-base-special-exp/dist');function p(e,r,t){var n;return a(e)||a(r)||a(t)||t<0?NaN:t===0?e<r?0:1:(n=(e-r)/t,1/(1+N(-n)))}f.exports=p
+});var q=c(function(R,v){
+var y=require('@stdlib/utils-constant-function/dist'),d=require('@stdlib/stats-base-dists-degenerate-cdf/dist').factory,i=require('@stdlib/math-base-assert-is-nan/dist'),x=require('@stdlib/math-base-special-exp/dist');function z(e,r){if(i(e)||i(r)||r<0)return y(NaN);if(r===0)return d(e);return t;function t(n){var u;return i(n)?NaN:(u=(n-e)/r,1/(1+x(-u)))}}v.exports=z
+});var g=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),s=o(),l=q();g(s,"factory",l);module.exports=s;
+/** @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 exp = require( '@stdlib/math-base-special-exp' );\n\n\n// MAIN //\n\n/**\n* Evaluates the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`.\n*\n* @param {number} x - input value\n* @param {number} mu - location parameter\n* @param {NonNegativeNumber} s - scale parameter\n* @returns {Probability} evaluated CDF\n*\n* @example\n* var y = cdf( 2.0, 0.0, 1.0 );\n* // returns ~0.881\n*\n* @example\n* var y = cdf( 5.0, 10.0, 3.0 );\n* // returns ~0.159\n*\n* @example\n* var y = cdf( 2.0, 0.0, NaN );\n* // returns NaN\n*\n* @example\n* var y = cdf( 2.0, NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = cdf( NaN, 0.0, 1.0 );\n* // returns NaN\n*/\nfunction cdf( x, mu, s ) {\n\tvar z;\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( mu ) ||\n\t\tisnan( s ) ||\n\t\ts < 0.0\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( s === 0.0 ) {\n\t\treturn ( x < mu ) ? 0.0 : 1.0;\n\t}\n\tz = ( x - mu ) / s;\n\treturn 1.0 / ( 1.0 + exp( -z ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = cdf;\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-cdf' ).factory;\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar exp = require( '@stdlib/math-base-special-exp' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s`.\n*\n* @param {number} mu - location parameter\n* @param {NonNegativeNumber} s - scale parameter\n* @returns {Function} CDF\n*\n* @example\n* var cdf = factory( 3.0, 1.5 );\n*\n* var y = cdf( 1.0 );\n* // returns ~0.209\n*\n* y = cdf( 4.0 );\n* // returns ~0.661\n*/\nfunction factory( mu, s ) {\n\tif ( isnan( mu ) || isnan( s ) || s < 0.0 ) {\n\t\treturn constantFunction( NaN );\n\t}\n\tif ( s === 0.0 ) {\n\t\treturn degenerate( mu );\n\t}\n\treturn cdf;\n\n\t/**\n\t* Evaluates the cumulative distribution function (CDF) for a logistic distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {Probability} evaluated CDF\n\t*\n\t* @example\n\t* var y = cdf( 2.0 );\n\t* // returns <number>\n\t*/\n\tfunction cdf( x ) {\n\t\tvar z;\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tz = ( x - mu ) / s;\n\t\treturn 1.0 / ( 1.0 + exp( -z ) );\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* Logistic distribution cumulative distribution function (CDF).\n*\n* @module @stdlib/stats-base-dists-logistic-cdf\n*\n* @example\n* var cdf = require( '@stdlib/stats-base-dists-logistic-cdf' );\n*\n* var y = cdf( 2.0, 0.0, 1.0 );\n* // returns ~0.881\n*\n* var mycdf = cdf.factory( 3.0, 1.5 );\n*\n* y = mycdf( 1.0 );\n* // returns ~0.209\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,EAAM,QAAS,+BAAgC,EAiCnD,SAASC,EAAKC,EAAGC,EAAIC,EAAI,CACxB,IAAIC,EACJ,OACCN,EAAOG,CAAE,GACTH,EAAOI,CAAG,GACVJ,EAAOK,CAAE,GACTA,EAAI,EAEG,IAEHA,IAAM,EACDF,EAAIC,EAAO,EAAM,GAE3BE,GAAMH,EAAIC,GAAOC,EACV,GAAQ,EAAMJ,EAAK,CAACK,CAAE,GAC9B,CAKAP,EAAO,QAAUG,IC5EjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAa,QAAS,yCAA0C,EAAE,QAClEC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAqBnD,SAASC,EAASC,EAAIC,EAAI,CACzB,GAAKJ,EAAOG,CAAG,GAAKH,EAAOI,CAAE,GAAKA,EAAI,EACrC,OAAON,EAAkB,GAAI,EAE9B,GAAKM,IAAM,EACV,OAAOL,EAAYI,CAAG,EAEvB,OAAOE,EAaP,SAASA,EAAKC,EAAI,CACjB,IAAIC,EACJ,OAAKP,EAAOM,CAAE,EACN,KAERC,GAAMD,EAAIH,GAAOC,EACV,GAAQ,EAAMH,EAAK,CAACM,CAAE,GAC9B,CACD,CAKAV,EAAO,QAAUK,ICxCjB,IAAIM,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "exp", "cdf", "x", "mu", "s", "z", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "degenerate", "isnan", "exp", "factory", "mu", "s", "cdf", "x", "z", "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 cumulative distribution function (CDF) for a logistic distribution.

package/lib/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-logistic-cdf",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Logistic distribution cumulative distribution function (CDF).",
   "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-exp": "^0.0.x",
-    "@stdlib/stats-base-dists-degenerate-cdf": "^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.0",
+    "@stdlib/math-base-special-exp": "^0.1.0",
+    "@stdlib/stats-base-dists-degenerate-cdf": "^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/constants-float64-pinf": "^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.0",
+    "@stdlib/constants-float64-ninf": "^0.1.0",
+    "@stdlib/constants-float64-pinf": "^0.1.0",
+    "@stdlib/math-base-special-abs": "^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",
@@ -85,7 +85,7 @@
     "continuous"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,76 +0,0 @@
-
-{{alias}}( x, μ, s )
-    Evaluates the cumulative distribution function (CDF) for a logistic
-    distribution with location parameter `μ` and scale parameter `s` at a value
-    `x`.
-
-    If provided `NaN` as any argument, the function returns `NaN`.
-
-    If provided `s < 0`, the function returns `NaN`.
-
-    Parameters
-    ----------
-    x: number
-        Input value.
-
-    μ: number
-        Location parameter.
-
-    s: number
-        Scale parameter.
-
-    Returns
-    -------
-    out: number
-        Evaluated CDF.
-
-    Examples
-    --------
-    > var y = {{alias}}( 2.0, 0.0, 1.0 )
-    ~0.881
-    > y = {{alias}}( 5.0, 10.0, 3.0 )
-    ~0.159
-
-    > y = {{alias}}( 2.0, 0.0, NaN )
-    NaN
-    > y = {{alias}}( 2.0, NaN, 1.0 )
-    NaN
-    > y = {{alias}}( NaN, 0.0, 1.0 )
-    NaN
-
-    // Degenerate distribution centered at `μ` when `s = 0.0`:
-    > y = {{alias}}( 2.0, 8.0, 0.0 )
-    0.0
-    > y = {{alias}}( 8.0, 8.0, 0.0 )
-    1.0
-    > y = {{alias}}( 10.0, 8.0, 0.0 )
-    1.0
-
-
-{{alias}}.factory( μ, s )
-    Returns a function for evaluating the cumulative distribution function (CDF)
-    of a logistic distribution with location parameter `μ` and scale parameter
-    `s`.
-
-    Parameters
-    ----------
-    μ: number
-        Location parameter.
-
-    s: number
-        Scale parameter.
-
-    Returns
-    -------
-    cdf: Function
-        Cumulative distribution function (CDF).
-
-    Examples
-    --------
-    > var mycdf = {{alias}}.factory( 3.0, 1.5 );
-    > var y = mycdf( 1.0 )
-    ~0.209
-
-    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 cdf = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	cdf( 2, 2, 4 ); // $ExpectType number
-	cdf( 1, 2, 8 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function is provided values other than three numbers...
-{
-	cdf( true, 3, 6 ); // $ExpectError
-	cdf( false, 2, 4 ); // $ExpectError
-	cdf( '5', 1, 2 ); // $ExpectError
-	cdf( [], 1, 2 ); // $ExpectError
-	cdf( {}, 2, 4 ); // $ExpectError
-	cdf( ( x: number ): number => x, 2, 4 ); // $ExpectError
-
-	cdf( 9, true, 12 ); // $ExpectError
-	cdf( 9, false, 12 ); // $ExpectError
-	cdf( 5, '5', 10 ); // $ExpectError
-	cdf( 8, [], 16 ); // $ExpectError
-	cdf( 9, {}, 18 ); // $ExpectError
-	cdf( 8, ( x: number ): number => x, 16 ); // $ExpectError
-
-	cdf( 9, 5, true ); // $ExpectError
-	cdf( 9, 5, false ); // $ExpectError
-	cdf( 5, 2, '5' ); // $ExpectError
-	cdf( 8, 4, [] ); // $ExpectError
-	cdf( 9, 4, {} ); // $ExpectError
-	cdf( 8, 5, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	cdf(); // $ExpectError
-	cdf( 2 ); // $ExpectError
-	cdf( 2, 0 ); // $ExpectError
-	cdf( 2, 0, 4, 1 ); // $ExpectError
-}
-
-// Attached to main export is a `factory` method which returns a function...
-{
-	cdf.factory( 3, 4 ); // $ExpectType Unary
-}
-
-// The `factory` method returns a function which returns a number...
-{
-	const fcn = cdf.factory( 3, 4 );
-	fcn( 2 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments...
-{
-	const fcn = cdf.factory( 3, 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 = cdf.factory( 3, 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...
-{
-	cdf.factory( true, 3 ); // $ExpectError
-	cdf.factory( false, 2 ); // $ExpectError
-	cdf.factory( '5', 1 ); // $ExpectError
-	cdf.factory( [], 1 ); // $ExpectError
-	cdf.factory( {}, 2 ); // $ExpectError
-	cdf.factory( ( x: number ): number => x, 2 ); // $ExpectError
-
-	cdf.factory( 9, true ); // $ExpectError
-	cdf.factory( 9, false ); // $ExpectError
-	cdf.factory( 5, '5' ); // $ExpectError
-	cdf.factory( 8, [] ); // $ExpectError
-	cdf.factory( 9, {} ); // $ExpectError
-	cdf.factory( 8, ( x: number ): number => x ); // $ExpectError
-
-	cdf.factory( [], true ); // $ExpectError
-	cdf.factory( {}, false ); // $ExpectError
-	cdf.factory( false, '5' ); // $ExpectError
-	cdf.factory( {}, [] ); // $ExpectError
-	cdf.factory( '5', ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
-{
-	cdf.factory( 0 ); // $ExpectError
-	cdf.factory( 0, 4, 8 ); // $ExpectError
-}