@stdlib/stats-base-dists-discrete-uniform-logcdf 0.0.7 → 0.1.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/CITATION.cff ADDED
@@ -0,0 +1,30 @@
1
+ cff-version: 1.2.0
2
+ title: stdlib
3
+ message: >-
4
+ If you use this software, please cite it using the
5
+ metadata from this file.
6
+
7
+ type: software
8
+
9
+ authors:
10
+ - name: The Stdlib Authors
11
+ url: https://github.com/stdlib-js/stdlib/graphs/contributors
12
+
13
+ repository-code: https://github.com/stdlib-js/stdlib
14
+ url: https://stdlib.io
15
+
16
+ abstract: |
17
+ Standard library for JavaScript and Node.js.
18
+
19
+ keywords:
20
+ - JavaScript
21
+ - Node.js
22
+ - TypeScript
23
+ - standard library
24
+ - scientific computing
25
+ - numerical computing
26
+ - statistical computing
27
+
28
+ license: Apache-2.0 AND BSL-1.0
29
+
30
+ date-released: 2016
package/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2022 The Stdlib Authors.
1
+ Copyright (c) 2016-2023 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] -->
@@ -182,9 +193,14 @@ For more information on the project, filing bug reports and feature requests, an
182
193
 
183
194
  ---
184
195
 
196
+ ## License
197
+
198
+ See [LICENSE][stdlib-license].
199
+
200
+
185
201
  ## Copyright
186
202
 
187
- Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
203
+ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
188
204
 
189
205
  </section>
190
206
 
@@ -197,8 +213,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
197
213
  [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-discrete-uniform-logcdf.svg
198
214
  [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-discrete-uniform-logcdf
199
215
 
200
- [test-image]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.0.7
201
- [test-url]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-logcdf/actions/workflows/test.yml?query=branch:v0.0.7
216
+ [test-image]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.1.0
217
+ [test-url]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-logcdf/actions/workflows/test.yml?query=branch:v0.1.0
202
218
 
203
219
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-discrete-uniform-logcdf/main.svg
204
220
  [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-discrete-uniform-logcdf?branch=main
@@ -211,7 +227,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
211
227
  -->
212
228
 
213
229
  [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
214
- [chat-url]: https://gitter.im/stdlib-js/stdlib/
230
+ [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
215
231
 
216
232
  [stdlib]: https://github.com/stdlib-js/stdlib
217
233
 
@@ -225,6 +241,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
225
241
  [esm-url]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-logcdf/tree/esm
226
242
  [branches-url]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-logcdf/blob/main/branches.md
227
243
 
244
+ [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-discrete-uniform-logcdf/main/LICENSE
245
+
228
246
  [cdf]: https://en.wikipedia.org/wiki/Cumulative_distribution_function
229
247
 
230
248
  [discrete-uniform-distribution]: https://en.wikipedia.org/wiki/Discrete_uniform_distribution
@@ -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 o=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var q=o(function(z,s){
2
+ var f=require('@stdlib/math-base-assert-is-integer/dist'),t=require('@stdlib/math-base-assert-is-nan/dist'),d=require('@stdlib/math-base-special-floor/dist'),v=require('@stdlib/math-base-special-ln/dist'),p=require('@stdlib/constants-float64-ninf/dist');function F(e,r,i){return t(e)||t(r)||t(i)||!f(r)||!f(i)||r>i?NaN:e<r?p:e>=i?0:v(d(e)-r+1)-v(i-r+1)}s.exports=F
3
+ });var g=o(function(A,l){
4
+ var m=require('@stdlib/utils-constant-function/dist'),c=require('@stdlib/math-base-assert-is-integer/dist'),u=require('@stdlib/math-base-assert-is-nan/dist'),O=require('@stdlib/math-base-special-floor/dist'),N=require('@stdlib/math-base-special-ln/dist'),R=require('@stdlib/constants-float64-ninf/dist');function h(e,r){var i,a;if(u(e)||u(r)||!c(e)||!c(r)||e>r)return m(NaN);return a=e-1,i=N(r-e+1),I;function I(n){return u(n)?NaN:n<e?R:n>=r?0:N(O(n)-a)-i}}l.exports=h
5
+ });var j=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),y=q(),k=g();j(y,"factory",k);module.exports=y;
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 isInteger = require( '@stdlib/math-base-assert-is-integer' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar floor = require( '@stdlib/math-base-special-floor' );\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 discrete uniform distribution with minimum support `a` and maximum support `b` at a value `x`.\n*\n* @param {number} x - input value\n* @param {integer} a - minimum support\n* @param {integer} b - maximum support\n* @returns {number} evaluated logCDF\n*\n* @example\n* var y = logcdf( 9.0, 0, 10 );\n* // returns ~-0.095\n*\n* @example\n* var y = logcdf( 0.5, 0, 2 );\n* // returns ~-1.099\n*\n* @example\n* var y = logcdf( +Infinity, 2, 4 );\n* // returns 0.0\n*\n* @example\n* var y = logcdf( -Infinity, 2, 4 );\n* // returns -Infinity\n*\n* @example\n* var y = logcdf( NaN, 0, 1 );\n* // returns NaN\n*\n* @example\n* var y = logcdf( 0.0, NaN, 1 );\n* // returns NaN\n*\n* @example\n* var y = logcdf( 0.0, 0, NaN );\n* // returns NaN\n*\n* @example\n* var y = logcdf( 2.0, 1, 0 );\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\t!isInteger( a ) ||\n\t\t!isInteger( b ) ||\n\t\ta > b\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( x < a ) {\n\t\treturn NINF;\n\t}\n\tif ( x >= b ) {\n\t\treturn 0.0;\n\t}\n\treturn ln( floor( x ) - a + 1.0 ) - ln( b - a + 1.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 isInteger = require( '@stdlib/math-base-assert-is-integer' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar floor = require( '@stdlib/math-base-special-floor' );\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 natural logarithm of the cumulative distribution function (CDF) for a discrete uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @param {integer} a - minimum support\n* @param {integer} b - maximum support\n* @returns {Function} logCDF\n*\n* @example\n* var logcdf = factory( 0, 10 );\n* var y = logcdf( 0.5 );\n* // returns ~-2.398\n*\n* y = logcdf( 8.0 );\n* // returns ~-0.201\n*/\nfunction factory( a, b ) {\n\tvar logn;\n\tvar am1;\n\tif (\n\t\tisnan( a ) ||\n\t\tisnan( b ) ||\n\t\t!isInteger( a ) ||\n\t\t!isInteger( b ) ||\n\t\ta > b\n\t) {\n\t\treturn constantFunction( NaN );\n\t}\n\tam1 = a - 1.0;\n\tlogn = ln( b - a + 1.0 );\n\treturn logcdf;\n\n\t/**\n\t* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a discrete uniform 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 < a ) {\n\t\t\treturn NINF;\n\t\t}\n\t\tif ( x >= b ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\treturn ln( floor( x ) - am1 ) - logn;\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* Natural logarithm of the cumulative distribution function (CDF) for a discrete uniform distribution.\n*\n* @module @stdlib/stats-base-dists-discrete-uniform-logcdf\n*\n* @example\n* var logcdf = require( '@stdlib/stats-base-dists-discrete-uniform-logcdf' );\n*\n* var y = logcdf( 3.0, 0, 4 );\n* // returns ~-0.223\n*\n* var mylogcdf = logcdf.factory( 0, 10 );\n* y = mylogcdf( 0.5 );\n* // returns ~-2.398\n*\n* y = mylogcdf( 8.0 );\n* // returns ~-0.201\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,EAAY,QAAS,qCAAsC,EAC3DC,EAAQ,QAAS,iCAAkC,EACnDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EA6CrD,SAASC,EAAQC,EAAGC,EAAGC,EAAI,CAC1B,OACCP,EAAOK,CAAE,GACTL,EAAOM,CAAE,GACTN,EAAOO,CAAE,GACT,CAACR,EAAWO,CAAE,GACd,CAACP,EAAWQ,CAAE,GACdD,EAAIC,EAEG,IAEHF,EAAIC,EACDH,EAEHE,GAAKE,EACF,EAEDL,EAAID,EAAOI,CAAE,EAAIC,EAAI,CAAI,EAAIJ,EAAIK,EAAID,EAAI,CAAI,CACrD,CAKAR,EAAO,QAAUM,IC9FjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAY,QAAS,qCAAsC,EAC3DC,EAAQ,QAAS,iCAAkC,EACnDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EAoBrD,SAASC,EAASC,EAAGC,EAAI,CACxB,IAAIC,EACAC,EACJ,GACCR,EAAOK,CAAE,GACTL,EAAOM,CAAE,GACT,CAACP,EAAWM,CAAE,GACd,CAACN,EAAWO,CAAE,GACdD,EAAIC,EAEJ,OAAOR,EAAkB,GAAI,EAE9B,OAAAU,EAAMH,EAAI,EACVE,EAAOL,EAAII,EAAID,EAAI,CAAI,EAChBI,EAaP,SAASA,EAAQC,EAAI,CACpB,OAAKV,EAAOU,CAAE,EACN,IAEHA,EAAIL,EACDF,EAEHO,GAAKJ,EACF,EAEDJ,EAAID,EAAOS,CAAE,EAAIF,CAAI,EAAID,CACjC,CACD,CAKAV,EAAO,QAAUO,IClDjB,IAAIO,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
6
+ "names": ["require_main", "__commonJSMin", "exports", "module", "isInteger", "isnan", "floor", "ln", "NINF", "logcdf", "x", "a", "b", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "isInteger", "isnan", "floor", "ln", "NINF", "factory", "a", "b", "logn", "am1", "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 natural logarithm of the cumulative distribution function (CDF) for a discrete uniform distribution.
package/lib/index.js CHANGED
@@ -40,15 +40,15 @@
40
40
  // MODULES //
41
41
 
42
42
  var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
43
- var logcdf = require( './logcdf.js' );
43
+ var main = require( './main.js' );
44
44
  var factory = require( './factory.js' );
45
45
 
46
46
 
47
47
  // MAIN //
48
48
 
49
- setReadOnly( logcdf, 'factory', factory );
49
+ setReadOnly( main, 'factory', factory );
50
50
 
51
51
 
52
52
  // EXPORTS //
53
53
 
54
- module.exports = logcdf;
54
+ module.exports = main;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/stats-base-dists-discrete-uniform-logcdf",
3
- "version": "0.0.7",
3
+ "version": "0.1.0",
4
4
  "description": "Natural logarithm of the cumulative distribution function (CDF)for a discrete uniform distribution.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -37,25 +37,25 @@
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-integer": "^0.0.x",
42
- "@stdlib/math-base-assert-is-nan": "^0.0.x",
43
- "@stdlib/math-base-special-floor": "^0.0.x",
44
- "@stdlib/math-base-special-ln": "^0.0.x",
45
- "@stdlib/utils-constant-function": "^0.0.x",
46
- "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
40
+ "@stdlib/constants-float64-ninf": "^0.1.0",
41
+ "@stdlib/math-base-assert-is-integer": "^0.1.0",
42
+ "@stdlib/math-base-assert-is-nan": "^0.1.0",
43
+ "@stdlib/math-base-special-floor": "^0.1.0",
44
+ "@stdlib/math-base-special-ln": "^0.1.0",
45
+ "@stdlib/utils-constant-function": "^0.1.0",
46
+ "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0"
47
47
  },
48
48
  "devDependencies": {
49
- "@stdlib/bench": "^0.0.x",
50
- "@stdlib/constants-float64-eps": "^0.0.x",
51
- "@stdlib/constants-float64-pinf": "^0.0.x",
52
- "@stdlib/math-base-special-abs": "^0.0.x",
53
- "@stdlib/math-base-special-round": "^0.0.x",
54
- "@stdlib/random-base-discrete-uniform": "^0.0.x",
55
- "@stdlib/random-base-randu": "^0.0.x",
49
+ "@stdlib/bench": "^0.1.0",
50
+ "@stdlib/constants-float64-eps": "^0.1.0",
51
+ "@stdlib/constants-float64-pinf": "^0.1.0",
52
+ "@stdlib/math-base-special-abs": "^0.0.6",
53
+ "@stdlib/math-base-special-round": "^0.1.0",
54
+ "@stdlib/random-base-discrete-uniform": "^0.0.6",
55
+ "@stdlib/random-base-randu": "^0.0.8",
56
56
  "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
57
57
  "istanbul": "^0.4.1",
58
- "tap-spec": "5.x.x"
58
+ "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
59
59
  },
60
60
  "engines": {
61
61
  "node": ">=0.10.0",
@@ -92,7 +92,7 @@
92
92
  "natural"
93
93
  ],
94
94
  "funding": {
95
- "type": "patreon",
96
- "url": "https://www.patreon.com/athan"
95
+ "type": "opencollective",
96
+ "url": "https://opencollective.com/stdlib"
97
97
  }
98
98
  }
package/docs/repl.txt DELETED
@@ -1,75 +0,0 @@
1
-
2
- {{alias}}( x, a, b )
3
- Evaluates the natural logarithm of the cumulative distribution function
4
- (CDF) for a discrete uniform distribution with minimum support `a` and
5
- maximum support `b` at a value `x`.
6
-
7
- If `a > b`, the function returns `NaN`.
8
-
9
- If `a` or `b` is not an integer value, the function returns `NaN`.
10
-
11
- Parameters
12
- ----------
13
- x: number
14
- Input value.
15
-
16
- a: integer
17
- Minimum support.
18
-
19
- b: integer
20
- Maximum support.
21
-
22
- Returns
23
- -------
24
- out: number
25
- Evaluated logCDF.
26
-
27
- Examples
28
- --------
29
- > var y = {{alias}}( 9.0, 0, 10 )
30
- ~-0.095
31
- > y = {{alias}}( 0.5, 0, 2 )
32
- ~-1.099
33
- > y = {{alias}}( {{alias:@stdlib/constants/float64/pinf}}, 2, 4 )
34
- 0.0
35
- > y = {{alias}}( {{alias:@stdlib/constants/float64/ninf}}, 2, 4 )
36
- -Infinity
37
- > y = {{alias}}( NaN, 0, 1 )
38
- NaN
39
- > y = {{alias}}( 0.0, NaN, 1 )
40
- NaN
41
- > y = {{alias}}( 0.0, 0, NaN )
42
- NaN
43
- > y = {{alias}}( 2.0, 1, 0 )
44
- NaN
45
-
46
-
47
- {{alias}}.factory( a, b )
48
- Returns a function for evaluating the natural logarithm of the cumulative
49
- distribution function (CDF) of a discrete uniform distribution with minimum
50
- support `a` and maximum support `b`.
51
-
52
- Parameters
53
- ----------
54
- a: integer
55
- Minimum support.
56
-
57
- b: integer
58
- Maximum support.
59
-
60
- Returns
61
- -------
62
- logcdf: Function
63
- Logarithm of cumulative distribution function (CDF).
64
-
65
- Examples
66
- --------
67
- > var myLogCDF = {{alias}}.factory( 0, 10 );
68
- > var y = myLogCDF( 0.5 )
69
- ~-2.398
70
- > y = myLogCDF( 8.0 )
71
- ~-0.201
72
-
73
- See Also
74
- --------
75
-
@@ -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, 2, 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( 3, 4 ); // $ExpectType Unary
65
- }
66
-
67
- // The `factory` method returns a function which returns a number...
68
- {
69
- const fcn = logcdf.factory( 3, 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( 3, 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( 3, 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