@stdlib/stats-base-dists-rayleigh-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] -->
@@ -194,7 +205,7 @@ See [LICENSE][stdlib-license].
194
205
 
195
206
  ## Copyright
196
207
 
197
- Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
208
+ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
198
209
 
199
210
  </section>
200
211
 
@@ -207,8 +218,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
207
218
  [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-rayleigh-logcdf.svg
208
219
  [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-rayleigh-logcdf
209
220
 
210
- [test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.0.7
211
- [test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/actions/workflows/test.yml?query=branch:v0.0.7
221
+ [test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.2.0
222
+ [test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/actions/workflows/test.yml?query=branch:v0.2.0
212
223
 
213
224
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-rayleigh-logcdf/main.svg
214
225
  [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-rayleigh-logcdf?branch=main
@@ -221,7 +232,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
221
232
  -->
222
233
 
223
234
  [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
224
- [chat-url]: https://gitter.im/stdlib-js/stdlib/
235
+ [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
225
236
 
226
237
  [stdlib]: https://github.com/stdlib-js/stdlib
227
238
 
@@ -231,8 +242,11 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
231
242
  [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
232
243
 
233
244
  [deno-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/tree/deno
245
+ [deno-readme]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/blob/deno/README.md
234
246
  [umd-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/tree/umd
247
+ [umd-readme]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/blob/umd/README.md
235
248
  [esm-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/tree/esm
249
+ [esm-readme]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/blob/esm/README.md
236
250
  [branches-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-logcdf/blob/main/branches.md
237
251
 
238
252
  [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-rayleigh-logcdf/main/LICENSE
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 t=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var f=t(function(D,o){
2
+ var y=require('@stdlib/math-base-special-expm1/dist'),n=require('@stdlib/math-base-assert-is-nan/dist'),F=require('@stdlib/math-base-special-log1p/dist'),d=require('@stdlib/math-base-special-exp/dist'),v=require('@stdlib/math-base-special-pow/dist'),L=require('@stdlib/math-base-special-ln/dist'),w=require('@stdlib/constants-float64-ln-half/dist'),q=require('@stdlib/constants-float64-ninf/dist');function x(e,r){var a,u;return n(e)||n(r)||r<0?NaN:r===0?e<0?q:0:e<0?q:(a=v(r,2),u=-v(e,2)/(2*a),u<w?F(-d(u)):L(-y(u)))}o.exports=x
3
+ });var s=t(function(E,N){
4
+ var A=require('@stdlib/utils-constant-function/dist'),H=require('@stdlib/stats-base-dists-degenerate-logcdf/dist').factory,I=require('@stdlib/math-base-special-expm1/dist'),c=require('@stdlib/math-base-assert-is-nan/dist'),O=require('@stdlib/math-base-special-log1p/dist'),R=require('@stdlib/math-base-special-exp/dist'),p=require('@stdlib/math-base-special-pow/dist'),b=require('@stdlib/math-base-special-ln/dist'),h=require('@stdlib/constants-float64-ln-half/dist'),j=require('@stdlib/constants-float64-ninf/dist');function k(e){var r;if(c(e)||e<0)return A(NaN);if(e===0)return H(0);return r=p(e,2),a;function a(u){var i;return c(u)?NaN:u<0?j:(i=-p(u,2)/(2*r),i<h?O(-R(i)):b(-I(i)))}}N.exports=k
5
+ });var z=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),l=f(),B=s();z(l,"factory",B);module.exports=l;
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 expm1 = require( '@stdlib/math-base-special-expm1' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar log1p = require( '@stdlib/math-base-special-log1p' );\nvar exp = require( '@stdlib/math-base-special-exp' );\nvar pow = require( '@stdlib/math-base-special-pow' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar LNHALF = require( '@stdlib/constants-float64-ln-half' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`.\n*\n* @param {number} x - input value\n* @param {NonNegativeNumber} sigma - scale parameter\n* @returns {number} evaluated logCDF\n*\n* @example\n* var y = logcdf( 2.0, 3.0 );\n* // returns ~-1.613\n*\n* @example\n* var y = logcdf( 1.0, 2.0 );\n* // returns ~-2.141\n*\n* @example\n* var y = logcdf( -1.0, 4.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logcdf( NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logcdf( 0.0, NaN );\n* // returns NaN\n*\n* @example\n* // Negative scale parameter:\n* var y = logcdf( 2.0, -1.0 );\n* // returns NaN\n*/\nfunction logcdf( x, sigma ) {\n\tvar s2;\n\tvar p;\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( sigma ) ||\n\t\tsigma < 0.0\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( sigma === 0.0 ) {\n\t\treturn ( x < 0.0 ) ? NINF : 0.0;\n\t}\n\tif ( x < 0.0 ) {\n\t\treturn NINF;\n\t}\n\ts2 = pow( sigma, 2.0 );\n\tp = -pow( x, 2.0 ) / ( 2.0 * s2 );\n\treturn ( p < LNHALF ) ? log1p( -exp( p ) ) : ln( -expm1( p ) );\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 degenerate = require( '@stdlib/stats-base-dists-degenerate-logcdf' ).factory;\nvar expm1 = require( '@stdlib/math-base-special-expm1' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar log1p = require( '@stdlib/math-base-special-log1p' );\nvar exp = require( '@stdlib/math-base-special-exp' );\nvar pow = require( '@stdlib/math-base-special-pow' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar LNHALF = require( '@stdlib/constants-float64-ln-half' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma`.\n*\n* @param {NonNegativeNumber} sigma - scale parameter\n* @returns {Function} logCDF\n*\n* @example\n* var logcdf = factory( 2.0 );\n* var y = logcdf( 3.0 );\n* // returns ~-0.393\n*\n* y = logcdf( 1.0 );\n* // returns ~-2.141\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 = pow( sigma, 2.0 );\n\treturn logcdf;\n\n\t/**\n\t* Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh 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 );\n\t* // returns <number>\n\t*/\n\tfunction logcdf( x ) {\n\t\tvar p;\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\tp = -pow( x, 2.0 ) / ( 2.0 * s2 );\n\t\treturn ( p < LNHALF ) ? log1p( -exp( p ) ) : ln( -expm1( 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 logarithm of cumulative distribution function (CDF).\n*\n* @module @stdlib/stats-base-dists-rayleigh-logcdf\n*\n* @example\n* var logcdf = require( '@stdlib/stats-base-dists-rayleigh-logcdf' );\n*\n* var y = logcdf( 2.0, 5.0 );\n* // returns ~-2.564\n*\n* var mylogcdf = logcdf.factory( 0.5 );\n* y = mylogcdf( 1.0 );\n* // returns ~-0.145\n*\n* y = mylogcdf( 0.5 );\n* // returns ~-0.934\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,EAAQ,QAAS,iCAAkC,EACnDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAM,QAAS,+BAAgC,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAS,QAAS,mCAAoC,EACtDC,EAAO,QAAS,gCAAiC,EAqCrD,SAASC,EAAQC,EAAGC,EAAQ,CAC3B,IAAIC,EACAC,EACJ,OACCX,EAAOQ,CAAE,GACTR,EAAOS,CAAM,GACbA,EAAQ,EAED,IAEHA,IAAU,EACLD,EAAI,EAAQF,EAAO,EAExBE,EAAI,EACDF,GAERI,EAAKP,EAAKM,EAAO,CAAI,EACrBE,EAAI,CAACR,EAAKK,EAAG,CAAI,GAAM,EAAME,GACpBC,EAAIN,EAAWJ,EAAO,CAACC,EAAKS,CAAE,CAAE,EAAIP,EAAI,CAACL,EAAOY,CAAE,CAAE,EAC9D,CAKAb,EAAO,QAAUS,IC1FjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAa,QAAS,4CAA6C,EAAE,QACrEC,EAAQ,QAAS,iCAAkC,EACnDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAM,QAAS,+BAAgC,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAS,QAAS,mCAAoC,EACtDC,EAAO,QAAS,gCAAiC,EAmBrD,SAASC,EAASC,EAAQ,CACzB,IAAIC,EACJ,GAAKT,EAAOQ,CAAM,GAAKA,EAAQ,EAC9B,OAAOX,EAAkB,GAAI,EAE9B,GAAKW,IAAU,EACd,OAAOV,EAAY,CAAI,EAExB,OAAAW,EAAKN,EAAKK,EAAO,CAAI,EACdE,EAaP,SAASA,EAAQC,EAAI,CACpB,IAAIC,EACJ,OAAKZ,EAAOW,CAAE,EACN,IAEHA,EAAI,EACDL,GAERM,EAAI,CAACT,EAAKQ,EAAG,CAAI,GAAM,EAAMF,GACpBG,EAAIP,EAAWJ,EAAO,CAACC,EAAKU,CAAE,CAAE,EAAIR,EAAI,CAACL,EAAOa,CAAE,CAAE,EAC9D,CACD,CAKAhB,EAAO,QAAUW,IC/CjB,IAAIM,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
6
+ "names": ["require_main", "__commonJSMin", "exports", "module", "expm1", "isnan", "log1p", "exp", "pow", "ln", "LNHALF", "NINF", "logcdf", "x", "sigma", "s2", "p", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "degenerate", "expm1", "isnan", "log1p", "exp", "pow", "ln", "LNHALF", "NINF", "factory", "sigma", "s2", "logcdf", "x", "p", "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 Rayleigh 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-rayleigh-logcdf",
3
- "version": "0.0.7",
3
+ "version": "0.2.0",
4
4
  "description": "Rayleigh distribution logarithm of cumulative distribution function (CDF).",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -37,27 +37,28 @@
37
37
  "url": "https://github.com/stdlib-js/stdlib/issues"
38
38
  },
39
39
  "dependencies": {
40
- "@stdlib/constants-float64-ln-half": "^0.0.x",
41
- "@stdlib/constants-float64-ninf": "^0.0.x",
42
- "@stdlib/math-base-assert-is-nan": "^0.0.x",
43
- "@stdlib/math-base-special-exp": "^0.0.x",
44
- "@stdlib/math-base-special-expm1": "^0.0.x",
45
- "@stdlib/math-base-special-ln": "^0.0.x",
46
- "@stdlib/math-base-special-log1p": "^0.0.x",
47
- "@stdlib/math-base-special-pow": "^0.0.x",
48
- "@stdlib/stats-base-dists-degenerate-logcdf": "^0.0.x",
49
- "@stdlib/utils-constant-function": "^0.0.x",
50
- "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
40
+ "@stdlib/constants-float64-ln-half": "^0.2.0",
41
+ "@stdlib/constants-float64-ninf": "^0.2.0",
42
+ "@stdlib/math-base-assert-is-nan": "^0.2.0",
43
+ "@stdlib/math-base-special-exp": "^0.2.0",
44
+ "@stdlib/math-base-special-expm1": "^0.2.0",
45
+ "@stdlib/math-base-special-ln": "^0.2.0",
46
+ "@stdlib/math-base-special-log1p": "^0.2.0",
47
+ "@stdlib/math-base-special-pow": "^0.2.0",
48
+ "@stdlib/stats-base-dists-degenerate-logcdf": "^0.2.0",
49
+ "@stdlib/utils-constant-function": "^0.2.0",
50
+ "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0"
51
51
  },
52
52
  "devDependencies": {
53
- "@stdlib/bench": "^0.0.x",
54
- "@stdlib/constants-float64-eps": "^0.0.x",
55
- "@stdlib/constants-float64-pinf": "^0.0.x",
56
- "@stdlib/math-base-special-abs": "^0.0.x",
57
- "@stdlib/random-base-randu": "^0.0.x",
53
+ "@stdlib/constants-float64-eps": "^0.1.1",
54
+ "@stdlib/constants-float64-pinf": "^0.1.1",
55
+ "@stdlib/math-base-special-abs": "^0.1.1",
56
+ "@stdlib/random-base-randu": "^0.1.0",
58
57
  "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
59
58
  "istanbul": "^0.4.1",
60
- "tap-spec": "5.x.x"
59
+ "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
60
+ "@stdlib/bench-harness": "^0.2.0",
61
+ "@stdlib/bench": "^0.3.1"
61
62
  },
62
63
  "engines": {
63
64
  "node": ">=0.10.0",
@@ -95,7 +96,7 @@
95
96
  "continuous"
96
97
  ],
97
98
  "funding": {
98
- "type": "patreon",
99
- "url": "https://www.patreon.com/athan"
99
+ "type": "opencollective",
100
+ "url": "https://opencollective.com/stdlib"
100
101
  }
101
102
  }
package/docs/repl.txt DELETED
@@ -1,65 +0,0 @@
1
-
2
- {{alias}}( x, sigma )
3
- Evaluates the logarithm of the cumulative distribution function (CDF) for a
4
- Rayleigh distribution with scale parameter `sigma` at a value `x`.
5
-
6
- If provided `NaN` as any argument, the function returns `NaN`.
7
-
8
- If provided a negative value for `sigma`, the function returns `NaN`.
9
-
10
- Parameters
11
- ----------
12
- x: number
13
- Input value.
14
-
15
- sigma: number
16
- Scale parameter.
17
-
18
- Returns
19
- -------
20
- out: number
21
- Evaluated logCDF.
22
-
23
- Examples
24
- --------
25
- > var y = {{alias}}( 2.0, 3.0 )
26
- ~-1.613
27
- > y = {{alias}}( 1.0, 2.0 )
28
- ~-2.141
29
- > y = {{alias}}( -1.0, 4.0 )
30
- -Infinity
31
- > y = {{alias}}( NaN, 1.0 )
32
- NaN
33
- > y = {{alias}}( 0.0, NaN )
34
- NaN
35
- // Negative scale parameter:
36
- > y = {{alias}}( 2.0, -1.0 )
37
- NaN
38
-
39
-
40
- {{alias}}.factory( sigma )
41
- Returns a function for evaluating the logarithm of the cumulative
42
- distribution function (CDF) of a Rayleigh distribution with scale parameter
43
- `sigma`.
44
-
45
- Parameters
46
- ----------
47
- sigma: number
48
- Scale parameter.
49
-
50
- Returns
51
- -------
52
- logcdf: Function
53
- Logarithm of cumulative distribution function (CDF).
54
-
55
- Examples
56
- --------
57
- > var mylogcdf = {{alias}}.factory( 0.5 );
58
- > var y = mylogcdf( 1.0 )
59
- ~-0.145
60
- > y = mylogcdf( 0.5 )
61
- ~-0.933
62
-
63
- See Also
64
- --------
65
-
@@ -1,98 +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, 4 ); // $ExpectType number
27
- logcdf( 1, 2 ); // $ExpectType number
28
- }
29
-
30
- // The compiler throws an error if the function is provided values other than two numbers...
31
- {
32
- logcdf( true, 3 ); // $ExpectError
33
- logcdf( false, 2 ); // $ExpectError
34
- logcdf( '5', 1 ); // $ExpectError
35
- logcdf( [], 1 ); // $ExpectError
36
- logcdf( {}, 4 ); // $ExpectError
37
- logcdf( ( x: number ): number => x, 2 ); // $ExpectError
38
-
39
- logcdf( 9, true ); // $ExpectError
40
- logcdf( 9, false ); // $ExpectError
41
- logcdf( 5, '5' ); // $ExpectError
42
- logcdf( 8, [] ); // $ExpectError
43
- logcdf( 9, {} ); // $ExpectError
44
- logcdf( 8, ( x: number ): number => x ); // $ExpectError
45
- }
46
-
47
- // The compiler throws an error if the function is provided an unsupported number of arguments...
48
- {
49
- logcdf(); // $ExpectError
50
- logcdf( 2 ); // $ExpectError
51
- logcdf( 2, 0, 4 ); // $ExpectError
52
- }
53
-
54
- // Attached to main export is a `factory` method which returns a function...
55
- {
56
- logcdf.factory( 4 ); // $ExpectType Unary
57
- }
58
-
59
- // The `factory` method returns a function which returns a number...
60
- {
61
- const fcn = logcdf.factory( 4 );
62
- fcn( 2 ); // $ExpectType number
63
- }
64
-
65
- // The compiler throws an error if the function returned by the `factory` method is provided an invalid argument...
66
- {
67
- const fcn = logcdf.factory( 4 );
68
- fcn( true ); // $ExpectError
69
- fcn( false ); // $ExpectError
70
- fcn( '5' ); // $ExpectError
71
- fcn( [] ); // $ExpectError
72
- fcn( {} ); // $ExpectError
73
- fcn( ( x: number ): number => x ); // $ExpectError
74
- }
75
-
76
- // The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments...
77
- {
78
- const fcn = logcdf.factory( 4 );
79
- fcn(); // $ExpectError
80
- fcn( 2, 0 ); // $ExpectError
81
- fcn( 2, 0, 1 ); // $ExpectError
82
- }
83
-
84
- // The compiler throws an error if the `factory` method is provided a value other than a number...
85
- {
86
- logcdf.factory( true ); // $ExpectError
87
- logcdf.factory( false ); // $ExpectError
88
- logcdf.factory( '5' ); // $ExpectError
89
- logcdf.factory( [] ); // $ExpectError
90
- logcdf.factory( {} ); // $ExpectError
91
- logcdf.factory( ( x: number ): number => x ); // $ExpectError
92
- }
93
-
94
- // The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
95
- {
96
- logcdf.factory( 0, 2 ); // $ExpectError
97
- logcdf.factory( 0, 4, 8 ); // $ExpectError
98
- }
File without changes