@stdlib/stats-base-dists-logistic-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 +30 -0
- package/NOTICE +1 -1
- package/README.md +15 -4
- package/dist/index.d.ts +3 -0
- package/dist/index.js +10 -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 +16 -16
- package/docs/repl.txt +0 -67
- package/docs/types/test.ts +0 -119
- /package/lib/{logcdf.js → main.js} +0 -0
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-
|
|
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] -->
|
|
@@ -195,7 +206,7 @@ For more information on the project, filing bug reports and feature requests, an
|
|
|
195
206
|
|
|
196
207
|
## Copyright
|
|
197
208
|
|
|
198
|
-
Copyright © 2016-
|
|
209
|
+
Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors].
|
|
199
210
|
|
|
200
211
|
</section>
|
|
201
212
|
|
|
@@ -208,8 +219,8 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
208
219
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-logistic-logcdf.svg
|
|
209
220
|
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-logistic-logcdf
|
|
210
221
|
|
|
211
|
-
[test-image]: https://github.com/stdlib-js/stats-base-dists-logistic-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.0
|
|
212
|
-
[test-url]: https://github.com/stdlib-js/stats-base-dists-logistic-logcdf/actions/workflows/test.yml?query=branch:v0.0
|
|
222
|
+
[test-image]: https://github.com/stdlib-js/stats-base-dists-logistic-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.1.0
|
|
223
|
+
[test-url]: https://github.com/stdlib-js/stats-base-dists-logistic-logcdf/actions/workflows/test.yml?query=branch:v0.1.0
|
|
213
224
|
|
|
214
225
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-logistic-logcdf/main.svg
|
|
215
226
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-logistic-logcdf?branch=main
|
|
@@ -222,7 +233,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
222
233
|
-->
|
|
223
234
|
|
|
224
235
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
225
|
-
[chat-url]: https://gitter.im
|
|
236
|
+
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
|
|
226
237
|
|
|
227
238
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
228
239
|
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";var n=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var u=n(function(w,v){
|
|
2
|
+
var l=require('@stdlib/math-base-special-log1p/dist'),c=require('@stdlib/math-base-special-exp/dist');function y(r){return r<=18?l(c(r)):r>33.3?r:r+c(-r)}v.exports=y
|
|
3
|
+
});var q=n(function(x,p){
|
|
4
|
+
var a=require('@stdlib/math-base-assert-is-nan/dist'),d=require('@stdlib/constants-float64-ninf/dist'),z=u();function F(r,e,t){var i;return a(r)||a(e)||a(t)||t<0?NaN:t===0?r<e?d:0:(i=(r-e)/t,-z(-i))}p.exports=F
|
|
5
|
+
});var N=n(function(A,s){
|
|
6
|
+
var I=require('@stdlib/utils-constant-function/dist'),O=require('@stdlib/stats-base-dists-degenerate-logcdf/dist').factory,o=require('@stdlib/math-base-assert-is-nan/dist'),R=u();function b(r,e){if(o(r)||o(e)||e<0)return I(NaN);if(e===0)return O(r);return t;function t(i){var f;return o(i)?NaN:(f=(i-r)/e,-R(-f))}}s.exports=b
|
|
7
|
+
});var h=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),g=q(),j=N();h(g,"factory",j);module.exports=g;
|
|
8
|
+
/** @license Apache-2.0 */
|
|
9
|
+
/** @license Apache-2.0 */
|
|
10
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../lib/log1pexp.js", "../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* ## Notice\n*\n* The following copyright and license were part of the original implementation available as part of the [StatsFuns.jl]{@link https://github.com/JuliaStats/StatsFuns.jl/blob/master/src/basicfuns.jl} Julia package. The implementation follows the original, but has been modified for JavaScript.\n*\n* ```text\n* Copyright (c) 2015: Dahua Lin.\n*\n* Permission is hereby granted, free of charge, to any person obtaining\n* a copy of this software and associated documentation files (the\n* \"Software\"), to deal in the Software without restriction, including\n* without limitation the rights to use, copy, modify, merge, publish,\n* distribute, sublicense, and/or sell copies of the Software, and to\n* permit persons to whom the Software is furnished to do so, subject to\n* the following conditions:\n*\n* The above copyright notice and this permission notice shall be\n* included in all copies or substantial portions of the Software.\n*\n* THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\n* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\n* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\n* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\n* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n* ```\n*/\n\n'use strict';\n\n// MODULES //\n\nvar log1p = require( '@stdlib/math-base-special-log1p' );\nvar exp = require( '@stdlib/math-base-special-exp' );\n\n\n// MAIN //\n\n/**\n* Compute ln( 1 + exp(x) ) without overflow.\n*\n* @private\n* @param {number} x - input value\n* @returns {number} function value\n*/\nfunction log1pexp( x ) {\n\tif ( x <= 18.0 ) {\n\t\treturn log1p( exp(x) );\n\t}\n\tif ( x > 33.3 ) {\n\t\treturn x;\n\t}\n\t// Case: 18.0 < x <= 33.3\n\treturn x + exp( -x );\n}\n\n\n// EXPORTS //\n\nmodule.exports = log1pexp;\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 isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\nvar log1pexp = require( './log1pexp.js' );\n\n\n// MAIN //\n\n/**\n* Evaluates the logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`.\n*\n* @param {number} x - input value\n* @param {number} mu - location parameter\n* @param {NonNegativeNumber} s - scale parameter\n* @returns {number} evaluated logCDF\n*\n* @example\n* var y = logcdf( 2.0, 0.0, 1.0 );\n* // returns ~-0.127\n*\n* @example\n* var y = logcdf( 5.0, 10.0, 3.0 );\n* // returns ~-1.84\n*\n* @example\n* var y = logcdf( 2.0, 0.0, NaN );\n* // returns NaN\n*\n* @example\n* var y = logcdf( 2, NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logcdf( NaN, 0.0, 1.0 );\n* // returns NaN\n*/\nfunction logcdf( x, mu, s ) {\n\tvar z;\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( mu ) ||\n\t\tisnan( s ) ||\n\t\ts < 0.0\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( s === 0.0 ) {\n\t\treturn ( x < mu ) ? NINF : 0.0;\n\t}\n\tz = ( x - mu ) / s;\n\treturn -log1pexp( -z );\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 isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar log1pexp = require( './log1pexp.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s`.\n*\n* @param {number} mu - location parameter\n* @param {NonNegativeNumber} s - scale parameter\n* @returns {Function} logCDF\n*\n* @example\n* var logcdf = factory( 3.0, 1.5 );\n*\n* var y = logcdf( 1.0 );\n* // returns ~-1.567\n*\n* y = logcdf( 4.0 );\n* // returns ~-0.414\n*/\nfunction factory( mu, s ) {\n\tif ( isnan( mu ) || isnan( s ) || s < 0.0 ) {\n\t\treturn constantFunction( NaN );\n\t}\n\tif ( s === 0.0 ) {\n\t\treturn degenerate( mu );\n\t}\n\treturn logcdf;\n\n\t/**\n\t* Evaluates the logarithm of the cumulative distribution function (CDF) for a logistic 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 z;\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tz = ( x - mu ) / s;\n\t\treturn -log1pexp( -z );\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* Logistic distribution logarithm of cumulative distribution function (CDF).\n*\n* @module @stdlib/stats-base-dists-logistic-logcdf\n*\n* @example\n* var logcdf = require( '@stdlib/stats-base-dists-logistic-logcdf' );\n*\n* var y = logcdf( 2.0, 0.0, 1.0 );\n* // returns ~-0.127\n*\n* var mylogcdf = logcdf.factory( 3.0, 1.5 );\n*\n* var y = mylogcdf( 1.0 );\n* // returns ~-1.565\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,cAkDA,IAAIC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAYnD,SAASC,EAAUC,EAAI,CACtB,OAAKA,GAAK,GACFH,EAAOC,EAAIE,CAAC,CAAE,EAEjBA,EAAI,KACDA,EAGDA,EAAIF,EAAK,CAACE,CAAE,CACpB,CAKAJ,EAAO,QAAUG,IC7EjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,iCAAkC,EACnDC,EAAO,QAAS,gCAAiC,EACjDC,EAAW,IAiCf,SAASC,EAAQC,EAAGC,EAAIC,EAAI,CAC3B,IAAIC,EACJ,OACCP,EAAOI,CAAE,GACTJ,EAAOK,CAAG,GACVL,EAAOM,CAAE,GACTA,EAAI,EAEG,IAEHA,IAAM,EACDF,EAAIC,EAAOJ,EAAO,GAE5BM,GAAMH,EAAIC,GAAOC,EACV,CAACJ,EAAU,CAACK,CAAE,EACtB,CAKAR,EAAO,QAAUI,IC7EjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAa,QAAS,4CAA6C,EAAE,QACrEC,EAAQ,QAAS,iCAAkC,EACnDC,EAAW,IAqBf,SAASC,EAASC,EAAIC,EAAI,CACzB,GAAKJ,EAAOG,CAAG,GAAKH,EAAOI,CAAE,GAAKA,EAAI,EACrC,OAAON,EAAkB,GAAI,EAE9B,GAAKM,IAAM,EACV,OAAOL,EAAYI,CAAG,EAEvB,OAAOE,EAaP,SAASA,EAAQC,EAAI,CACpB,IAAIC,EACJ,OAAKP,EAAOM,CAAE,EACN,KAERC,GAAMD,EAAIH,GAAOC,EACV,CAACH,EAAU,CAACM,CAAE,EACtB,CACD,CAKAV,EAAO,QAAUK,ICxCjB,IAAIM,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
|
|
6
|
+
"names": ["require_log1pexp", "__commonJSMin", "exports", "module", "log1p", "exp", "log1pexp", "x", "require_main", "__commonJSMin", "exports", "module", "isnan", "NINF", "log1pexp", "logcdf", "x", "mu", "s", "z", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "degenerate", "isnan", "log1pexp", "factory", "mu", "s", "logcdf", "x", "z", "setReadOnly", "main", "factory"]
|
|
7
|
+
}
|
package/docs/types/index.d.ts
CHANGED
package/lib/index.js
CHANGED
|
@@ -38,15 +38,15 @@
|
|
|
38
38
|
// MODULES //
|
|
39
39
|
|
|
40
40
|
var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
|
|
41
|
-
var
|
|
41
|
+
var main = require( './main.js' );
|
|
42
42
|
var factory = require( './factory.js' );
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
// MAIN //
|
|
46
46
|
|
|
47
|
-
setReadOnly(
|
|
47
|
+
setReadOnly( main, 'factory', factory );
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
// EXPORTS //
|
|
51
51
|
|
|
52
|
-
module.exports =
|
|
52
|
+
module.exports = main;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stdlib/stats-base-dists-logistic-logcdf",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"description": "Logistic distribution logarithm of cumulative distribution function (CDF).",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -37,23 +37,23 @@
|
|
|
37
37
|
"url": "https://github.com/stdlib-js/stdlib/issues"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@stdlib/constants-float64-ninf": "^0.0
|
|
41
|
-
"@stdlib/math-base-assert-is-nan": "^0.0
|
|
42
|
-
"@stdlib/math-base-special-exp": "^0.0
|
|
43
|
-
"@stdlib/math-base-special-log1p": "^0.0
|
|
44
|
-
"@stdlib/stats-base-dists-degenerate-logcdf": "^0.0
|
|
45
|
-
"@stdlib/utils-constant-function": "^0.0
|
|
46
|
-
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.0
|
|
40
|
+
"@stdlib/constants-float64-ninf": "^0.1.0",
|
|
41
|
+
"@stdlib/math-base-assert-is-nan": "^0.1.0",
|
|
42
|
+
"@stdlib/math-base-special-exp": "^0.1.0",
|
|
43
|
+
"@stdlib/math-base-special-log1p": "^0.1.0",
|
|
44
|
+
"@stdlib/stats-base-dists-degenerate-logcdf": "^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
|
|
50
|
-
"@stdlib/constants-float64-eps": "^0.0
|
|
51
|
-
"@stdlib/constants-float64-pinf": "^0.0
|
|
52
|
-
"@stdlib/math-base-special-abs": "^0.0
|
|
53
|
-
"@stdlib/random-base-randu": "^0.0.
|
|
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.1.0",
|
|
53
|
+
"@stdlib/random-base-randu": "^0.0.8",
|
|
54
54
|
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
|
|
55
55
|
"istanbul": "^0.4.1",
|
|
56
|
-
"tap-
|
|
56
|
+
"tap-min": "git+https://github.com/Planeshifter/tap-min.git"
|
|
57
57
|
},
|
|
58
58
|
"engines": {
|
|
59
59
|
"node": ">=0.10.0",
|
|
@@ -88,7 +88,7 @@
|
|
|
88
88
|
"continuous"
|
|
89
89
|
],
|
|
90
90
|
"funding": {
|
|
91
|
-
"type": "
|
|
92
|
-
"url": "https://
|
|
91
|
+
"type": "opencollective",
|
|
92
|
+
"url": "https://opencollective.com/stdlib"
|
|
93
93
|
}
|
|
94
94
|
}
|
package/docs/repl.txt
DELETED
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( x, μ, s )
|
|
3
|
-
Evaluates the logarithm of the cumulative distribution function (CDF) for a
|
|
4
|
-
logistic distribution with location parameter `μ` and scale parameter `s` at
|
|
5
|
-
a value `x`.
|
|
6
|
-
|
|
7
|
-
If provided `NaN` as any argument, the function returns `NaN`.
|
|
8
|
-
|
|
9
|
-
If provided `s < 0`, the function returns `NaN`.
|
|
10
|
-
|
|
11
|
-
Parameters
|
|
12
|
-
----------
|
|
13
|
-
x: number
|
|
14
|
-
Input value.
|
|
15
|
-
|
|
16
|
-
μ: number
|
|
17
|
-
Location parameter.
|
|
18
|
-
|
|
19
|
-
s: number
|
|
20
|
-
Scale parameter.
|
|
21
|
-
|
|
22
|
-
Returns
|
|
23
|
-
-------
|
|
24
|
-
out: number
|
|
25
|
-
Evaluated logCDF.
|
|
26
|
-
|
|
27
|
-
Examples
|
|
28
|
-
--------
|
|
29
|
-
> var y = {{alias}}( 2.0, 0.0, 1.0 )
|
|
30
|
-
~-0.127
|
|
31
|
-
> y = {{alias}}( 5.0, 10.0, 3.0 )
|
|
32
|
-
~-1.84
|
|
33
|
-
> y = {{alias}}( 2.0, 0.0, NaN )
|
|
34
|
-
NaN
|
|
35
|
-
> y = {{alias}}( 2, NaN, 1.0 )
|
|
36
|
-
NaN
|
|
37
|
-
> y = {{alias}}( NaN, 0.0, 1.0 )
|
|
38
|
-
NaN
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
{{alias}}.factory( μ, s )
|
|
42
|
-
Returns a function for evaluating the logarithm of the cumulative
|
|
43
|
-
distribution function (CDF) of a Logistic distribution with location
|
|
44
|
-
parameter `μ` and scale parameter `s`.
|
|
45
|
-
|
|
46
|
-
Parameters
|
|
47
|
-
----------
|
|
48
|
-
μ: number
|
|
49
|
-
Location parameter.
|
|
50
|
-
|
|
51
|
-
s: number
|
|
52
|
-
Scale parameter.
|
|
53
|
-
|
|
54
|
-
Returns
|
|
55
|
-
-------
|
|
56
|
-
logcdf: Function
|
|
57
|
-
Logarithm of cumulative distribution function (CDF).
|
|
58
|
-
|
|
59
|
-
Examples
|
|
60
|
-
--------
|
|
61
|
-
> var mylogcdf = {{alias}}.factory( 3.0, 1.5 );
|
|
62
|
-
> var y = mylogcdf( 1.0 )
|
|
63
|
-
~-1.567
|
|
64
|
-
|
|
65
|
-
See Also
|
|
66
|
-
--------
|
|
67
|
-
|
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
|