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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2022 The Stdlib Authors.
1
+ Copyright (c) 2016-2024 The Stdlib Authors.
package/README.md CHANGED
@@ -18,6 +18,17 @@ limitations under the License.
18
18
 
19
19
  -->
20
20
 
21
+
22
+ <details>
23
+ <summary>
24
+ About stdlib...
25
+ </summary>
26
+ <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>
27
+ <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>
28
+ <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>
29
+ <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>
30
+ </details>
31
+
21
32
  # Logarithm of Cumulative Distribution Function
22
33
 
23
34
  [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -209,9 +220,14 @@ For more information on the project, filing bug reports and feature requests, an
209
220
 
210
221
  ---
211
222
 
223
+ ## License
224
+
225
+ See [LICENSE][stdlib-license].
226
+
227
+
212
228
  ## Copyright
213
229
 
214
- Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
230
+ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
215
231
 
216
232
  </section>
217
233
 
@@ -224,8 +240,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
224
240
  [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-kumaraswamy-logcdf.svg
225
241
  [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-kumaraswamy-logcdf
226
242
 
227
- [test-image]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.0.7
228
- [test-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logcdf/actions/workflows/test.yml?query=branch:v0.0.7
243
+ [test-image]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.2.0
244
+ [test-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logcdf/actions/workflows/test.yml?query=branch:v0.2.0
229
245
 
230
246
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-kumaraswamy-logcdf/main.svg
231
247
  [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-kumaraswamy-logcdf?branch=main
@@ -238,7 +254,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
238
254
  -->
239
255
 
240
256
  [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
241
- [chat-url]: https://gitter.im/stdlib-js/stdlib/
257
+ [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
242
258
 
243
259
  [stdlib]: https://github.com/stdlib-js/stdlib
244
260
 
@@ -248,10 +264,15 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
248
264
  [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
249
265
 
250
266
  [deno-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logcdf/tree/deno
267
+ [deno-readme]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logcdf/blob/deno/README.md
251
268
  [umd-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logcdf/tree/umd
269
+ [umd-readme]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logcdf/blob/umd/README.md
252
270
  [esm-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logcdf/tree/esm
271
+ [esm-readme]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logcdf/blob/esm/README.md
253
272
  [branches-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logcdf/blob/main/branches.md
254
273
 
274
+ [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-kumaraswamy-logcdf/main/LICENSE
275
+
255
276
  [kumaraswamy-distribution]: https://en.wikipedia.org/wiki/Kumaraswamy_distribution
256
277
 
257
278
  [cdf]: https://en.wikipedia.org/wiki/Cumulative_distribution_function
package/SECURITY.md ADDED
@@ -0,0 +1,5 @@
1
+ # Security
2
+
3
+ > Policy for reporting security vulnerabilities.
4
+
5
+ See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).
@@ -0,0 +1,3 @@
1
+ /// <reference path="../docs/types/index.d.ts" />
2
+ import logCDF from '../docs/types/index';
3
+ export = logCDF;
package/dist/index.js ADDED
@@ -0,0 +1,7 @@
1
+ "use strict";var a=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var c=a(function(R,o){
2
+ var u=require('@stdlib/math-base-assert-is-nan/dist'),f=require('@stdlib/math-base-special-pow/dist'),l=require('@stdlib/math-base-special-ln/dist'),p=require('@stdlib/constants-float64-ninf/dist');function y(e,r,i){return u(e)||u(r)||u(i)||r<=0||i<=0?NaN:e<=0?p:e>=1?0:l(1-f(1-f(e,r),i))}o.exports=y
3
+ });var v=a(function(h,q){
4
+ var d=require('@stdlib/utils-constant-function/dist'),n=require('@stdlib/math-base-assert-is-nan/dist'),s=require('@stdlib/math-base-special-pow/dist'),F=require('@stdlib/math-base-special-ln/dist'),g=require('@stdlib/constants-float64-ninf/dist');function w(e,r){if(n(e)||n(r)||e<=0||r<=0)return d(NaN);return i;function i(t){return n(t)?NaN:t<=0?g:t>=1?0:F(1-s(1-s(t,e),r))}}q.exports=w
5
+ });var I=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),N=c(),m=v();I(N,"factory",m);module.exports=N;
6
+ /** @license Apache-2.0 */
7
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../lib/main.js", "../lib/factory.js", "../lib/index.js"],
4
+ "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' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Kumaraswamy's double bounded distribution with first shape parameter `a` and second shape parameter `b` at a value `x`.\n*\n* @param {number} x - input value\n* @param {PositiveNumber} a - first shape parameter\n* @param {PositiveNumber} b - second shape parameter\n* @returns {number} evaluated logCDF\n*\n* @example\n* var y = logcdf( 0.5, 1.0, 1.0 );\n* // returns ~-0.693\n*\n* @example\n* var y = logcdf( 0.5, 2.0, 4.0 );\n* // returns ~-0.38\n*\n* @example\n* var y = logcdf( 0.2, 2.0, 2.0 );\n* // returns ~-2.546\n*\n* @example\n* var y = logcdf( 0.8, 4.0, 4.0 );\n* // returns ~-0.13\n*\n* @example\n* var y = logcdf( -0.5, 4.0, 2.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logcdf( 1.5, 4.0, 2.0 );\n* // returns 0.0\n*\n* @example\n* var y = logcdf( 2.0, -1.0, 0.5 );\n* // returns NaN\n*\n* @example\n* var y = logcdf( 2.0, 0.5, -1.0 );\n* // returns NaN\n*\n* @example\n* var y = logcdf( NaN, 1.0, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logcdf( 0.0, NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logcdf( 0.0, 1.0, NaN );\n* // returns NaN\n*/\nfunction logcdf( x, a, b ) {\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( a ) ||\n\t\tisnan( b ) ||\n\t\ta <= 0.0 ||\n\t\tb <= 0.0\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( x <= 0.0 ) {\n\t\treturn NINF;\n\t}\n\tif ( x >= 1.0 ) {\n\t\treturn 0.0;\n\t}\n\treturn ln( 1.0 - pow( 1.0 - pow( x, a ), b ) );\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 pow = require( '@stdlib/math-base-special-pow' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the cumulative distribution function (CDF) for a Kumaraswamy's double bounded distribution with first shape parameter `a` and second shape parameter `b`.\n*\n* @param {PositiveNumber} a - first shape parameter\n* @param {PositiveNumber} b - second shape parameter\n* @returns {Function} CDF\n*\n* @example\n* var logcdf = factory( 0.5, 0.5 );\n*\n* var y = logcdf( 0.8 );\n* // returns ~-0.393\n*\n* y = logcdf( 0.3 );\n* // returns ~-1.116\n*/\nfunction factory( a, b ) {\n\tif (\n\t\tisnan( a ) ||\n\t\tisnan( b ) ||\n\t\ta <= 0.0 ||\n\t\tb <= 0.0\n\t) {\n\t\treturn constantFunction( NaN );\n\t}\n\treturn logcdf;\n\n\t/**\n\t* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Kumaraswamy's double bounded distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {number} evaluated logCDF\n\t*\n\t* @example\n\t* var y = logcdf( 2.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\tif ( x <= 0.0 ) {\n\t\t\treturn NINF;\n\t\t}\n\t\tif ( x >= 1.0 ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\treturn ln( 1.0 - pow( 1.0 - pow( x, a ), b ) );\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* Evaluate the natural logarithm of the cumulative distribution function (CDF) for a Kumaraswamy's double bounded distribution.\n*\n* @module @stdlib/stats-base-dists-kumaraswamy-logcdf\n*\n* @example\n* var logcdf = require( '@stdlib/stats-base-dists-kumaraswamy-logcdf' );\n*\n* var y = logcdf( 0.5, 1.0, 1.0 );\n* // returns ~-0.693\n*\n* y = logcdf( 0.5, 2.0, 4.0 );\n* // returns ~-0.38\n*\n* @example\n* var factory = require( '@stdlib/stats-base-dists-kumaraswamy-logcdf' ).factory;\n*\n* var logcdf = factory( 0.5, 0.5 );\n*\n* var y = logcdf( 0.8 );\n* // returns ~-0.393\n*\n* y = logcdf( 0.3 );\n* // returns ~-1.118\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"],
5
+ "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EAyDrD,SAASC,EAAQC,EAAGC,EAAGC,EAAI,CAC1B,OACCP,EAAOK,CAAE,GACTL,EAAOM,CAAE,GACTN,EAAOO,CAAE,GACTD,GAAK,GACLC,GAAK,EAEE,IAEHF,GAAK,EACFF,EAEHE,GAAK,EACF,EAEDH,EAAI,EAAMD,EAAK,EAAMA,EAAKI,EAAGC,CAAE,EAAGC,CAAE,CAAE,CAC9C,CAKAR,EAAO,QAAUK,ICxGjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EAqBrD,SAASC,EAASC,EAAGC,EAAI,CACxB,GACCN,EAAOK,CAAE,GACTL,EAAOM,CAAE,GACTD,GAAK,GACLC,GAAK,EAEL,OAAOP,EAAkB,GAAI,EAE9B,OAAOQ,EAaP,SAASA,EAAQC,EAAI,CACpB,OAAKR,EAAOQ,CAAE,EACN,IAEHA,GAAK,EACFL,EAEHK,GAAK,EACF,EAEDN,EAAI,EAAMD,EAAK,EAAMA,EAAKO,EAAGH,CAAE,EAAGC,CAAE,CAAE,CAC9C,CACD,CAKAR,EAAO,QAAUM,ICtCjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
6
+ "names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "pow", "ln", "NINF", "logcdf", "x", "a", "b", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "isnan", "pow", "ln", "NINF", "factory", "a", "b", "logcdf", "x", "setReadOnly", "main", "factory"]
7
+ }
@@ -16,7 +16,7 @@
16
16
  * limitations under the License.
17
17
  */
18
18
 
19
- // TypeScript Version: 2.0
19
+ // TypeScript Version: 4.1
20
20
 
21
21
  /**
22
22
  * Evaluates the logarithm of the cumulative distribution function (CDF) for a Kumaraswamy's double bounded distribution.
package/lib/index.js CHANGED
@@ -47,15 +47,15 @@
47
47
  // MODULES //
48
48
 
49
49
  var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
50
- var logcdf = require( './logcdf.js' );
50
+ var main = require( './main.js' );
51
51
  var factory = require( './factory.js' );
52
52
 
53
53
 
54
54
  // MAIN //
55
55
 
56
- setReadOnly( logcdf, 'factory', factory );
56
+ setReadOnly( main, 'factory', factory );
57
57
 
58
58
 
59
59
  // EXPORTS //
60
60
 
61
- module.exports = logcdf;
61
+ module.exports = main;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/stats-base-dists-kumaraswamy-logcdf",
3
- "version": "0.0.7",
3
+ "version": "0.2.0",
4
4
  "description": "Natural logarithm of the cumulative distribution function (CDF)for a Kumaraswamy's double bounded distribution.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -37,22 +37,23 @@
37
37
  "url": "https://github.com/stdlib-js/stdlib/issues"
38
38
  },
39
39
  "dependencies": {
40
- "@stdlib/constants-float64-ninf": "^0.0.x",
41
- "@stdlib/math-base-assert-is-nan": "^0.0.x",
42
- "@stdlib/math-base-special-ln": "^0.0.x",
43
- "@stdlib/math-base-special-pow": "^0.0.x",
44
- "@stdlib/utils-constant-function": "^0.0.x",
45
- "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
40
+ "@stdlib/constants-float64-ninf": "^0.2.0",
41
+ "@stdlib/math-base-assert-is-nan": "^0.2.0",
42
+ "@stdlib/math-base-special-ln": "^0.2.0",
43
+ "@stdlib/math-base-special-pow": "^0.2.0",
44
+ "@stdlib/utils-constant-function": "^0.2.0",
45
+ "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0"
46
46
  },
47
47
  "devDependencies": {
48
- "@stdlib/assert-is-number": "^0.0.x",
49
- "@stdlib/bench": "^0.0.x",
50
- "@stdlib/constants-float64-eps": "^0.0.x",
51
- "@stdlib/constants-float64-pinf": "^0.0.x",
52
- "@stdlib/random-base-randu": "^0.0.x",
48
+ "@stdlib/assert-is-number": "^0.1.1",
49
+ "@stdlib/constants-float64-eps": "^0.1.1",
50
+ "@stdlib/constants-float64-pinf": "^0.1.1",
51
+ "@stdlib/random-base-randu": "^0.1.0",
53
52
  "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
54
53
  "istanbul": "^0.4.1",
55
- "tap-spec": "5.x.x"
54
+ "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
55
+ "@stdlib/bench-harness": "^0.2.0",
56
+ "@stdlib/bench": "^0.3.1"
56
57
  },
57
58
  "engines": {
58
59
  "node": ">=0.10.0",
@@ -91,7 +92,7 @@
91
92
  "continuous"
92
93
  ],
93
94
  "funding": {
94
- "type": "patreon",
95
- "url": "https://www.patreon.com/athan"
95
+ "type": "opencollective",
96
+ "url": "https://opencollective.com/stdlib"
96
97
  }
97
98
  }
package/docs/repl.txt DELETED
@@ -1,83 +0,0 @@
1
-
2
- {{alias}}( x, a, b )
3
- Evaluates the natural logarithm of the cumulative distribution function
4
- (CDF) for Kumaraswamy's double bounded distribution with first shape
5
- parameter `a` and second shape parameter `b` at a value `x`.
6
-
7
- If provided `NaN` as any argument, the function returns `NaN`.
8
-
9
- If `a <= 0` or `b <= 0`, the function returns `NaN`.
10
-
11
- Parameters
12
- ----------
13
- x: number
14
- Input value.
15
-
16
- a: number
17
- First shape parameter.
18
-
19
- b: number
20
- Second shape parameter.
21
-
22
- Returns
23
- -------
24
- out: number
25
- Evaluated logCDF.
26
-
27
- Examples
28
- --------
29
- > var y = {{alias}}( 0.5, 1.0, 1.0 )
30
- ~-0.693
31
- > y = {{alias}}( 0.5, 2.0, 4.0 )
32
- ~-0.38
33
- > y = {{alias}}( 0.2, 2.0, 2.0 )
34
- ~-2.546
35
- > y = {{alias}}( 0.8, 4.0, 4.0 )
36
- ~-0.13
37
- > y = {{alias}}( -0.5, 4.0, 2.0 )
38
- -Infinity
39
- > y = {{alias}}( 1.5, 4.0, 2.0 )
40
- 0.0
41
-
42
- > y = {{alias}}( 2.0, -1.0, 0.5 )
43
- NaN
44
- > y = {{alias}}( 2.0, 0.5, -1.0 )
45
- NaN
46
-
47
- > y = {{alias}}( NaN, 1.0, 1.0 )
48
- NaN
49
- > y = {{alias}}( 0.0, NaN, 1.0 )
50
- NaN
51
- > y = {{alias}}( 0.0, 1.0, NaN )
52
- NaN
53
-
54
-
55
- {{alias}}.factory( a, b )
56
- Returns a function for evaluating the natural logarithm of the cumulative
57
- distribution function (CDF) of a Kumaraswamy's double bounded distribution
58
- with first shape parameter `a` and second shape parameter `b`.
59
-
60
- Parameters
61
- ----------
62
- a: number
63
- First shape parameter.
64
-
65
- b: number
66
- Second shape parameter.
67
-
68
- Returns
69
- -------
70
- logcdf: Function
71
- Logarithm of cumulative distribution function (CDF).
72
-
73
- Examples
74
- --------
75
- > var mylogcdf = {{alias}}.factory( 0.5, 1.0 );
76
- > var y = mylogcdf( 0.8 )
77
- ~-0.112
78
- > y = mylogcdf( 0.3 )
79
- ~-0.602
80
-
81
- See Also
82
- --------
83
-
@@ -1,119 +0,0 @@
1
- /*
2
- * @license Apache-2.0
3
- *
4
- * Copyright (c) 2019 The Stdlib Authors.
5
- *
6
- * Licensed under the Apache License, Version 2.0 (the "License");
7
- * you may not use this file except in compliance with the License.
8
- * You may obtain a copy of the License at
9
- *
10
- * http://www.apache.org/licenses/LICENSE-2.0
11
- *
12
- * Unless required by applicable law or agreed to in writing, software
13
- * distributed under the License is distributed on an "AS IS" BASIS,
14
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
- * See the License for the specific language governing permissions and
16
- * limitations under the License.
17
- */
18
-
19
- import logcdf = require( './index' );
20
-
21
-
22
- // TESTS //
23
-
24
- // The function returns a number...
25
- {
26
- logcdf( 2, 0, 4 ); // $ExpectType number
27
- logcdf( 1, 2, 8 ); // $ExpectType number
28
- }
29
-
30
- // The compiler throws an error if the function is provided values other than three numbers...
31
- {
32
- logcdf( true, 3, 6 ); // $ExpectError
33
- logcdf( false, 2, 4 ); // $ExpectError
34
- logcdf( '5', 1, 2 ); // $ExpectError
35
- logcdf( [], 1, 2 ); // $ExpectError
36
- logcdf( {}, 2, 4 ); // $ExpectError
37
- logcdf( ( x: number ): number => x, 2, 4 ); // $ExpectError
38
-
39
- logcdf( 9, true, 12 ); // $ExpectError
40
- logcdf( 9, false, 12 ); // $ExpectError
41
- logcdf( 5, '5', 10 ); // $ExpectError
42
- logcdf( 8, [], 16 ); // $ExpectError
43
- logcdf( 9, {}, 18 ); // $ExpectError
44
- logcdf( 8, ( x: number ): number => x, 16 ); // $ExpectError
45
-
46
- logcdf( 9, 5, true ); // $ExpectError
47
- logcdf( 9, 5, false ); // $ExpectError
48
- logcdf( 5, 2, '5' ); // $ExpectError
49
- logcdf( 8, 4, [] ); // $ExpectError
50
- logcdf( 9, 4, {} ); // $ExpectError
51
- logcdf( 8, 5, ( x: number ): number => x ); // $ExpectError
52
- }
53
-
54
- // The compiler throws an error if the function is provided an unsupported number of arguments...
55
- {
56
- logcdf(); // $ExpectError
57
- logcdf( 2 ); // $ExpectError
58
- logcdf( 2, 0 ); // $ExpectError
59
- logcdf( 2, 0, 4, 1 ); // $ExpectError
60
- }
61
-
62
- // Attached to main export is a `factory` method which returns a function...
63
- {
64
- logcdf.factory( 0, 4 ); // $ExpectType Unary
65
- }
66
-
67
- // The `factory` method returns a function which returns a number...
68
- {
69
- const fcn = logcdf.factory( 0, 4 );
70
- fcn( 2 ); // $ExpectType number
71
- }
72
-
73
- // The compiler throws an error if the function returned by the `factory` method is provided invalid arguments...
74
- {
75
- const fcn = logcdf.factory( 0, 4 );
76
- fcn( true ); // $ExpectError
77
- fcn( false ); // $ExpectError
78
- fcn( '5' ); // $ExpectError
79
- fcn( [] ); // $ExpectError
80
- fcn( {} ); // $ExpectError
81
- fcn( ( x: number ): number => x ); // $ExpectError
82
- }
83
-
84
- // The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments...
85
- {
86
- const fcn = logcdf.factory( 0, 4 );
87
- fcn(); // $ExpectError
88
- fcn( 2, 0 ); // $ExpectError
89
- fcn( 2, 0, 1 ); // $ExpectError
90
- }
91
-
92
- // The compiler throws an error if the `factory` method is provided values other than two numbers...
93
- {
94
- logcdf.factory( true, 3 ); // $ExpectError
95
- logcdf.factory( false, 2 ); // $ExpectError
96
- logcdf.factory( '5', 1 ); // $ExpectError
97
- logcdf.factory( [], 1 ); // $ExpectError
98
- logcdf.factory( {}, 2 ); // $ExpectError
99
- logcdf.factory( ( x: number ): number => x, 2 ); // $ExpectError
100
-
101
- logcdf.factory( 9, true ); // $ExpectError
102
- logcdf.factory( 9, false ); // $ExpectError
103
- logcdf.factory( 5, '5' ); // $ExpectError
104
- logcdf.factory( 8, [] ); // $ExpectError
105
- logcdf.factory( 9, {} ); // $ExpectError
106
- logcdf.factory( 8, ( x: number ): number => x ); // $ExpectError
107
-
108
- logcdf.factory( [], true ); // $ExpectError
109
- logcdf.factory( {}, false ); // $ExpectError
110
- logcdf.factory( false, '5' ); // $ExpectError
111
- logcdf.factory( {}, [] ); // $ExpectError
112
- logcdf.factory( '5', ( x: number ): number => x ); // $ExpectError
113
- }
114
-
115
- // The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
116
- {
117
- logcdf.factory( 0 ); // $ExpectError
118
- logcdf.factory( 0, 4, 8 ); // $ExpectError
119
- }
File without changes