@stdlib/stats-base-dists-degenerate-logcdf 0.0.8 → 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>
+
 # Logarithm of 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] -->
@@ -156,7 +167,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>
 
@@ -169,8 +180,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-degenerate-logcdf.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-degenerate-logcdf
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-degenerate-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.0.8
-[test-url]: https://github.com/stdlib-js/stats-base-dists-degenerate-logcdf/actions/workflows/test.yml?query=branch:v0.0.8
+[test-image]: https://github.com/stdlib-js/stats-base-dists-degenerate-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-degenerate-logcdf/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-degenerate-logcdf/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-degenerate-logcdf?branch=main
@@ -183,7 +194,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 logCDF from '../docs/types/index';
+export = logCDF;

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 u=n(function(g,a){
+var i=require('@stdlib/math-base-assert-is-nan/dist'),N=require('@stdlib/constants-float64-ninf/dist');function q(e,r){return i(e)||i(r)?NaN:e<r?N:0}a.exports=q
+});var s=n(function(I,o){
+var v=require('@stdlib/utils-constant-function/dist'),c=require('@stdlib/math-base-assert-is-nan/dist'),y=require('@stdlib/constants-float64-ninf/dist');function d(e){if(c(e))return v(NaN);return r;function r(t){return c(t)?NaN:t<e?y:0}}o.exports=d
+});var l=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),f=u(),p=s();l(f,"factory",p);module.exports=f;
+/** @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 NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the natural logarithm of the cumulative distribution function (logCDF) for a degenerate distribution with mean `mu`.\n*\n* @param {number} x - input value\n* @param {number} mu - constant value of distribution\n* @returns {number} natural logarithm of cumulative distribution function\n*\n* @example\n* var y = logcdf( 2.0, 3.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logcdf( 4.0, 3.0 );\n* // returns 0.0\n*\n* @example\n* var y = logcdf( 3.0, 3.0 );\n* // returns 0.0\n*\n* @example\n* var y = logcdf( NaN, 0.0 );\n* // returns NaN\n*\n* @example\n* var y = logcdf( 0.0, NaN );\n* // returns NaN\n*/\nfunction logcdf( x, mu ) {\n\tif ( isnan( x ) || isnan( mu ) ) {\n\t\treturn NaN;\n\t}\n\treturn ( x < mu ) ? NINF : 0.0;\n}\n\n\n// EXPORTS //\n\nmodule.exports = logcdf;\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 isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the natural logarithm of the cumulative distribution function (logCDF) of a degenerate distribution centered at a provided mean value.\n*\n* @param {number} mu - value at which to center the distribution\n* @returns {Function} logCDF\n*\n* @example\n* var logcdf = factory( 5.0 );\n*\n* var y = logcdf( 3.0 );\n* // returns -Infinity\n*\n* y = logcdf( 6.0 );\n* // returns 0.0\n*\n* y = logcdf( NaN );\n* // returns NaN\n*/\nfunction factory( mu ) {\n\tif ( isnan( mu ) ) {\n\t\treturn constantFunction( NaN );\n\t}\n\treturn logcdf;\n\n\t/**\n\t* Evaluates the natural logarithm of the cumulative distribution function (logCDF) of a degenerate distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {number} natural logarithm of cumulative distribution function\n\t*\n\t* @example\n\t* var y = logcdf( 10.0 );\n\t* // returns <number>\n\t*/\n\tfunction logcdf( x ) {\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\treturn ( x < mu ) ? NINF : 0.0;\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* Degenerate distribution logarithm of cumulative distribution function (CDF).\n*\n* @module @stdlib/stats-base-dists-degenerate-logcdf\n*\n* @example\n* var logcdf = require( '@stdlib/stats-base-dists-degenerate-logcdf' );\n*\n* var y = logcdf( 2.0, 5.0 );\n* // returns -Infinity\n*\n* @example\n* var factory = require( '@stdlib/stats-base-dists-degenerate-logcdf' ).factory;\n*\n* var logcdf = factory( 5.0 );\n*\n* var y = logcdf( 3.0 );\n* // returns -Infinity\n*\n* y = logcdf( 6.0 );\n* // returns 0.0\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,EAAO,QAAS,gCAAiC,EAgCrD,SAASC,EAAQC,EAAGC,EAAK,CACxB,OAAKJ,EAAOG,CAAE,GAAKH,EAAOI,CAAG,EACrB,IAECD,EAAIC,EAAOH,EAAO,CAC5B,CAKAF,EAAO,QAAUG,ICjEjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAQ,QAAS,iCAAkC,EACnDC,EAAO,QAAS,gCAAiC,EAuBrD,SAASC,EAASC,EAAK,CACtB,GAAKH,EAAOG,CAAG,EACd,OAAOJ,EAAkB,GAAI,EAE9B,OAAOK,EAaP,SAASA,EAAQC,EAAI,CACpB,OAAKL,EAAOK,CAAE,EACN,IAECA,EAAIF,EAAOF,EAAO,CAC5B,CACD,CAKAH,EAAO,QAAUI,IC9BjB,IAAII,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "NINF", "logcdf", "x", "mu", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "isnan", "NINF", "factory", "mu", "logcdf", "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 natural logarithm of the cumulative distribution function (CDF) for a degenerate distribution.

package/lib/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-degenerate-logcdf",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "Degenerate distribution logarithm of cumulative distribution function (logCDF).",
   "license": "Apache-2.0",
   "author": {
@@ -37,18 +37,18 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/constants-float64-ninf": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/utils-constant-function": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
+    "@stdlib/constants-float64-ninf": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^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/math-base-special-round": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/math-base-special-round": "^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",
@@ -88,7 +88,7 @@
     "ln"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,60 +0,0 @@
-
-{{alias}}( x, μ )
-    Evaluates the natural logarithm of the cumulative distribution function
-    (logCDF) for a degenerate distribution with mean `μ`.
-
-    If provided `NaN` for any argument, the function returns `NaN`.
-
-    Parameters
-    ----------
-    x: number
-        Input value.
-
-    μ: number
-        Constant value of distribution.
-
-    Returns
-    -------
-    out: number
-        Natural logarithm of the CDF.
-
-    Examples
-    --------
-    > var y = {{alias}}( 2.0, 3.0 )
-    -Infinity
-    > y = {{alias}}( 4.0, 3.0 )
-    0
-    > y = {{alias}}( 3.0, 3.0 )
-    0
-    > y = {{alias}}( NaN, 0.0 )
-    NaN
-    > y = {{alias}}( 0.0, NaN )
-    NaN
-
-
-{{alias}}.factory( μ )
-    Returns a function for evaluating the natural logarithm of the cumulative
-    distribution function (logCDF) of a degenerate distribution with mean `μ`.
-
-    Parameters
-    ----------
-    μ: number
-        Constant value of distribution.
-
-    Returns
-    -------
-    logcdf: Function
-        Function to evaluate the natural logarithm of cumulative distribution
-        function (logCDF).
-
-    Examples
-    --------
-    > var mylogcdf = {{alias}}.factory( 5.0 );
-    > var y = mylogcdf( 3.0 )
-    -Infinity
-    > y = mylogcdf( 6.0 )
-    0
-
-    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 logcdf = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	logcdf( 2, 4 ); // $ExpectType number
-	logcdf( 1, 2 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function is provided values other than two numbers...
-{
-	logcdf( true, 3 ); // $ExpectError
-	logcdf( false, 2 ); // $ExpectError
-	logcdf( '5', 1 ); // $ExpectError
-	logcdf( [], 1 ); // $ExpectError
-	logcdf( {}, 4 ); // $ExpectError
-	logcdf( ( x: number ): number => x, 2 ); // $ExpectError
-
-	logcdf( 9, true ); // $ExpectError
-	logcdf( 9, false ); // $ExpectError
-	logcdf( 5, '5' ); // $ExpectError
-	logcdf( 8, [] ); // $ExpectError
-	logcdf( 9, {} ); // $ExpectError
-	logcdf( 8, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	logcdf(); // $ExpectError
-	logcdf( 2 ); // $ExpectError
-	logcdf( 2, 0, 4 ); // $ExpectError
-}
-
-// Attached to main export is a `factory` method which returns a function...
-{
-	logcdf.factory( 4 ); // $ExpectType Unary
-}
-
-// The `factory` method returns a function which returns a number...
-{
-	const fcn = logcdf.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 = logcdf.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 = logcdf.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...
-{
-	logcdf.factory( true ); // $ExpectError
-	logcdf.factory( false ); // $ExpectError
-	logcdf.factory( '5' ); // $ExpectError
-	logcdf.factory( [] ); // $ExpectError
-	logcdf.factory( {} ); // $ExpectError
-	logcdf.factory( ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
-{
-	logcdf.factory( 0, 2 ); // $ExpectError
-	logcdf.factory( 0, 4, 8 ); // $ExpectError
-}