@stdlib/stats-base-dists-weibull-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 +1 -1
- package/README.md +18 -4
- package/SECURITY.md +5 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +7 -0
- package/dist/index.js.map +7 -0
- package/docs/types/index.d.ts +1 -1
- package/lib/index.js +3 -3
- package/package.json +20 -19
- package/docs/repl.txt +0 -73
- package/docs/types/test.ts +0 -119
- /package/lib/{logcdf.js → main.js} +0 -0
package/NOTICE
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
Copyright (c) 2016-
|
|
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] -->
|
|
@@ -203,7 +214,7 @@ See [LICENSE][stdlib-license].
|
|
|
203
214
|
|
|
204
215
|
## Copyright
|
|
205
216
|
|
|
206
|
-
Copyright © 2016-
|
|
217
|
+
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
|
|
207
218
|
|
|
208
219
|
</section>
|
|
209
220
|
|
|
@@ -216,8 +227,8 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
216
227
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-weibull-logcdf.svg
|
|
217
228
|
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-weibull-logcdf
|
|
218
229
|
|
|
219
|
-
[test-image]: https://github.com/stdlib-js/stats-base-dists-weibull-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.0
|
|
220
|
-
[test-url]: https://github.com/stdlib-js/stats-base-dists-weibull-logcdf/actions/workflows/test.yml?query=branch:v0.0
|
|
230
|
+
[test-image]: https://github.com/stdlib-js/stats-base-dists-weibull-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.2.0
|
|
231
|
+
[test-url]: https://github.com/stdlib-js/stats-base-dists-weibull-logcdf/actions/workflows/test.yml?query=branch:v0.2.0
|
|
221
232
|
|
|
222
233
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-weibull-logcdf/main.svg
|
|
223
234
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-weibull-logcdf?branch=main
|
|
@@ -230,7 +241,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
230
241
|
-->
|
|
231
242
|
|
|
232
243
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
233
|
-
[chat-url]: https://gitter.im
|
|
244
|
+
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
|
|
234
245
|
|
|
235
246
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
236
247
|
|
|
@@ -240,8 +251,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
240
251
|
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
|
|
241
252
|
|
|
242
253
|
[deno-url]: https://github.com/stdlib-js/stats-base-dists-weibull-logcdf/tree/deno
|
|
254
|
+
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-weibull-logcdf/blob/deno/README.md
|
|
243
255
|
[umd-url]: https://github.com/stdlib-js/stats-base-dists-weibull-logcdf/tree/umd
|
|
256
|
+
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-weibull-logcdf/blob/umd/README.md
|
|
244
257
|
[esm-url]: https://github.com/stdlib-js/stats-base-dists-weibull-logcdf/tree/esm
|
|
258
|
+
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-weibull-logcdf/blob/esm/README.md
|
|
245
259
|
[branches-url]: https://github.com/stdlib-js/stats-base-dists-weibull-logcdf/blob/main/branches.md
|
|
246
260
|
|
|
247
261
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-weibull-logcdf/main/LICENSE
|
package/SECURITY.md
ADDED
package/dist/index.d.ts
ADDED
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 o=a(function(E,q){
|
|
2
|
+
var v=require('@stdlib/math-base-assert-is-nan/dist'),s=require('@stdlib/math-base-special-expm1/dist'),N=require('@stdlib/math-base-special-log1p/dist'),F=require('@stdlib/math-base-special-exp/dist'),g=require('@stdlib/math-base-special-pow/dist'),x=require('@stdlib/math-base-special-ln/dist'),y=require('@stdlib/constants-float64-ln-half/dist'),L=require('@stdlib/constants-float64-ninf/dist');function l(e,r,u){var i;return v(r)||v(u)||r<=0||u<=0?NaN:e<0?L:(i=-g(e/u,r),i<y?N(-F(i)):x(-s(i)))}q.exports=l
|
|
3
|
+
});var f=a(function(G,c){
|
|
4
|
+
var w=require('@stdlib/utils-constant-function/dist'),n=require('@stdlib/math-base-assert-is-nan/dist'),A=require('@stdlib/math-base-special-expm1/dist'),H=require('@stdlib/math-base-special-log1p/dist'),I=require('@stdlib/math-base-special-exp/dist'),O=require('@stdlib/math-base-special-pow/dist'),R=require('@stdlib/math-base-special-ln/dist'),h=require('@stdlib/constants-float64-ln-half/dist'),j=require('@stdlib/constants-float64-ninf/dist');function z(e,r){if(n(e)||n(r)||e<=0||r<=0)return w(NaN);return u;function u(i){var t;return n(i)?NaN:i<0?j:(t=-O(i/r,e),t<h?H(-I(t)):R(-A(t)))}}c.exports=z
|
|
5
|
+
});var B=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),p=o(),C=f();B(p,"factory",C);module.exports=p;
|
|
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 expm1 = require( '@stdlib/math-base-special-expm1' );\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 natural logarithm of the cumulative distribution function (CDF) for a Weibull distribution with scale parameter `k` and shape parameter `lambda` at a value `x`.\n*\n* @param {number} x - input value\n* @param {PositiveNumber} k - scale parameter\n* @param {PositiveNumber} lambda - shape parameter\n* @returns {number} natural logarithm of CDF\n*\n* @example\n* var y = logcdf( 2.0, 1.0, 1.0 );\n* // returns ~-0.145\n*\n* @example\n* var y = logcdf( -1.0, 2.0, 2.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logcdf( +Infinity, 4.0, 2.0 );\n* // returns 0.0\n*\n* @example\n* var y = logcdf( -Infinity, 4.0, 2.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logcdf( NaN, 0.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, 0.0, NaN );\n* // returns NaN\n*\n* @example\n* var y = logcdf( 2.0, 0.0, -1.0 );\n* // returns NaN\n*/\nfunction logcdf( x, k, lambda ) {\n\tvar p;\n\tif (\n\t\tisnan( k ) ||\n\t\tisnan( lambda ) ||\n\t\tk <= 0.0 ||\n\t\tlambda <= 0.0\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( x < 0.0 ) {\n\t\treturn NINF;\n\t}\n\tp = -pow( x / lambda, k );\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 isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar expm1 = require( '@stdlib/math-base-special-expm1' );\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 natural logarithm of the cumulative distribution function (CDF) for a Weibull distribution.\n*\n* @param {PositiveNumber} k - scale parameter\n* @param {PositiveNumber} lambda - shape parameter\n* @returns {Function} logCDF\n*\n* @example\n* var logcdf = factory( 2.0, 10.0 );\n* var y = logcdf( 12.0 );\n* // returns ~-0.27\n*\n* y = logcdf( 8.0 );\n* // returns ~-0.749\n*/\nfunction factory( k, lambda ) {\n\tif (\n\t\tisnan( k ) ||\n\t\tisnan( lambda ) ||\n\t\tk <= 0.0 ||\n\t\tlambda <= 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 Weibull 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\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 / lambda, k );\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* Weibull distribution logarithm of cumulative distribution function (CDF).\n*\n* @module @stdlib/stats-base-dists-weibull-logcdf\n*\n* @example\n* var logcdf = require( '@stdlib/stats-base-dists-weibull-logcdf' );\n*\n* var y = logcdf( 2.0, 1.0, 1.0 );\n* // returns ~-0.145\n*\n* var mylogcdf = logcdf.factory( 2.0, 10.0 );\n* y = mylogcdf( 12.0 );\n* // returns ~-0.27\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,EA6CrD,SAASC,EAAQC,EAAGC,EAAGC,EAAS,CAC/B,IAAIC,EACJ,OACCZ,EAAOU,CAAE,GACTV,EAAOW,CAAO,GACdD,GAAK,GACLC,GAAU,EAEH,IAEHF,EAAI,EACDF,GAERK,EAAI,CAACR,EAAKK,EAAIE,EAAQD,CAAE,EACfE,EAAIN,EAAWJ,EAAO,CAACC,EAAKS,CAAE,CAAE,EAAIP,EAAI,CAACJ,EAAOW,CAAE,CAAE,EAC9D,CAKAb,EAAO,QAAUS,IC9FjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,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,EAoBrD,SAASC,EAASC,EAAGC,EAAS,CAC7B,GACCV,EAAOS,CAAE,GACTT,EAAOU,CAAO,GACdD,GAAK,GACLC,GAAU,EAEV,OAAOX,EAAkB,GAAI,EAE9B,OAAOY,EAaP,SAASA,EAAQC,EAAI,CACpB,IAAIC,EACJ,OAAKb,EAAOY,CAAE,EACN,IAEHA,EAAI,EACDL,GAERM,EAAI,CAACT,EAAKQ,EAAIF,EAAQD,CAAE,EACfI,EAAIP,EAAWJ,EAAO,CAACC,EAAKU,CAAE,CAAE,EAAIR,EAAI,CAACJ,EAAOY,CAAE,CAAE,EAC9D,CACD,CAKAf,EAAO,QAAUU,IClDjB,IAAIM,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
|
|
6
|
+
"names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "expm1", "log1p", "exp", "pow", "ln", "LNHALF", "NINF", "logcdf", "x", "k", "lambda", "p", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "isnan", "expm1", "log1p", "exp", "pow", "ln", "LNHALF", "NINF", "factory", "k", "lambda", "logcdf", "x", "p", "setReadOnly", "main", "factory"]
|
|
7
|
+
}
|
package/docs/types/index.d.ts
CHANGED
package/lib/index.js
CHANGED
|
@@ -37,15 +37,15 @@
|
|
|
37
37
|
// MODULES //
|
|
38
38
|
|
|
39
39
|
var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
|
|
40
|
-
var
|
|
40
|
+
var main = require( './main.js' );
|
|
41
41
|
var factory = require( './factory.js' );
|
|
42
42
|
|
|
43
43
|
|
|
44
44
|
// MAIN //
|
|
45
45
|
|
|
46
|
-
setReadOnly(
|
|
46
|
+
setReadOnly( main, 'factory', factory );
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
// EXPORTS //
|
|
50
50
|
|
|
51
|
-
module.exports =
|
|
51
|
+
module.exports = main;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stdlib/stats-base-dists-weibull-logcdf",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Weibull distribution logarithm of cumulative distribution function (CDF).",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -37,26 +37,27 @@
|
|
|
37
37
|
"url": "https://github.com/stdlib-js/stdlib/issues"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@stdlib/constants-float64-ln-half": "^0.0
|
|
41
|
-
"@stdlib/constants-float64-ninf": "^0.0
|
|
42
|
-
"@stdlib/math-base-assert-is-nan": "^0.0
|
|
43
|
-
"@stdlib/math-base-special-exp": "^0.0
|
|
44
|
-
"@stdlib/math-base-special-expm1": "^0.0
|
|
45
|
-
"@stdlib/math-base-special-ln": "^0.0
|
|
46
|
-
"@stdlib/math-base-special-log1p": "^0.0
|
|
47
|
-
"@stdlib/math-base-special-pow": "^0.0
|
|
48
|
-
"@stdlib/utils-constant-function": "^0.0
|
|
49
|
-
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.0
|
|
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/utils-constant-function": "^0.2.0",
|
|
49
|
+
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
|
-
"@stdlib/
|
|
53
|
-
"@stdlib/constants-float64-
|
|
54
|
-
"@stdlib/
|
|
55
|
-
"@stdlib/
|
|
56
|
-
"@stdlib/random-base-randu": "^0.0.x",
|
|
52
|
+
"@stdlib/constants-float64-eps": "^0.1.1",
|
|
53
|
+
"@stdlib/constants-float64-pinf": "^0.1.1",
|
|
54
|
+
"@stdlib/math-base-special-abs": "^0.1.1",
|
|
55
|
+
"@stdlib/random-base-randu": "^0.1.0",
|
|
57
56
|
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
|
|
58
57
|
"istanbul": "^0.4.1",
|
|
59
|
-
"tap-
|
|
58
|
+
"tap-min": "git+https://github.com/Planeshifter/tap-min.git",
|
|
59
|
+
"@stdlib/bench-harness": "^0.2.0",
|
|
60
|
+
"@stdlib/bench": "^0.3.1"
|
|
60
61
|
},
|
|
61
62
|
"engines": {
|
|
62
63
|
"node": ">=0.10.0",
|
|
@@ -96,7 +97,7 @@
|
|
|
96
97
|
"univariate"
|
|
97
98
|
],
|
|
98
99
|
"funding": {
|
|
99
|
-
"type": "
|
|
100
|
-
"url": "https://
|
|
100
|
+
"type": "opencollective",
|
|
101
|
+
"url": "https://opencollective.com/stdlib"
|
|
101
102
|
}
|
|
102
103
|
}
|
package/docs/repl.txt
DELETED
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( x, k, λ )
|
|
3
|
-
Evaluates the logarithm of the cumulative distribution function (CDF) for a
|
|
4
|
-
Weibull distribution with shape parameter `k` and scale parameter `λ` at a
|
|
5
|
-
value `x`.
|
|
6
|
-
|
|
7
|
-
If provided `NaN` as any argument, the function returns `NaN`.
|
|
8
|
-
|
|
9
|
-
If provided a nonpositive value for `λ` or `k`, the function returns `NaN`.
|
|
10
|
-
|
|
11
|
-
Parameters
|
|
12
|
-
----------
|
|
13
|
-
x: number
|
|
14
|
-
Input value.
|
|
15
|
-
|
|
16
|
-
k: number
|
|
17
|
-
Shape parameter.
|
|
18
|
-
|
|
19
|
-
λ: number
|
|
20
|
-
Scale parameter.
|
|
21
|
-
|
|
22
|
-
Returns
|
|
23
|
-
-------
|
|
24
|
-
out: number
|
|
25
|
-
Evaluated logCDF.
|
|
26
|
-
|
|
27
|
-
Examples
|
|
28
|
-
--------
|
|
29
|
-
> var y = {{alias}}( 2.0, 1.0, 1.0 )
|
|
30
|
-
~-0.145
|
|
31
|
-
> y = {{alias}}( -1.0, 2.0, 2.0 )
|
|
32
|
-
-Infinity
|
|
33
|
-
> y = {{alias}}( {{alias:@stdlib/constants/float64/pinf}}, 4.0, 2.0 )
|
|
34
|
-
0.0
|
|
35
|
-
> y = {{alias}}( {{alias:@stdlib/constants/float64/ninf}}, 4.0, 2.0 )
|
|
36
|
-
-Infinity
|
|
37
|
-
> y = {{alias}}( NaN, 0.0, 1.0 )
|
|
38
|
-
NaN
|
|
39
|
-
> y = {{alias}}( 0.0, NaN, 1.0 )
|
|
40
|
-
NaN
|
|
41
|
-
> y = {{alias}}( 0.0, 0.0, NaN )
|
|
42
|
-
NaN
|
|
43
|
-
> y = {{alias}}( 2.0, 0.0, -1.0 )
|
|
44
|
-
NaN
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
{{alias}}.factory( k, λ)
|
|
48
|
-
Returns a function for evaluating the logarithm of the cumulative
|
|
49
|
-
distribution function (CDF) of a Weibull distribution with scale parameter
|
|
50
|
-
`λ` and shape parameter `k`.
|
|
51
|
-
|
|
52
|
-
Parameters
|
|
53
|
-
----------
|
|
54
|
-
k: number
|
|
55
|
-
Shape parameter.
|
|
56
|
-
|
|
57
|
-
λ: number
|
|
58
|
-
Scale parameter.
|
|
59
|
-
|
|
60
|
-
Returns
|
|
61
|
-
-------
|
|
62
|
-
logcdf: Function
|
|
63
|
-
Logarithm of cumulative distribution function (CDF).
|
|
64
|
-
|
|
65
|
-
Examples
|
|
66
|
-
--------
|
|
67
|
-
> var mylogcdf = {{alias}}.factory( 2.0, 10.0 );
|
|
68
|
-
> var y = mylogcdf( 12.0 )
|
|
69
|
-
~-0.27
|
|
70
|
-
|
|
71
|
-
See Also
|
|
72
|
-
--------
|
|
73
|
-
|
package/docs/types/test.ts
DELETED
|
@@ -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
|