@stdlib/stats-base-dists-logistic-logpdf 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 +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 +17 -17
- package/docs/repl.txt +0 -77
- package/docs/types/test.ts +0 -119
- /package/lib/{logpdf.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 Probability Density 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 © 2016-
|
|
208
|
+
Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors].
|
|
198
209
|
|
|
199
210
|
</section>
|
|
200
211
|
|
|
@@ -207,8 +218,8 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
207
218
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-logistic-logpdf.svg
|
|
208
219
|
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-logistic-logpdf
|
|
209
220
|
|
|
210
|
-
[test-image]: https://github.com/stdlib-js/stats-base-dists-logistic-logpdf/actions/workflows/test.yml/badge.svg?branch=v0.0
|
|
211
|
-
[test-url]: https://github.com/stdlib-js/stats-base-dists-logistic-logpdf/actions/workflows/test.yml?query=branch:v0.0
|
|
221
|
+
[test-image]: https://github.com/stdlib-js/stats-base-dists-logistic-logpdf/actions/workflows/test.yml/badge.svg?branch=v0.1.0
|
|
222
|
+
[test-url]: https://github.com/stdlib-js/stats-base-dists-logistic-logpdf/actions/workflows/test.yml?query=branch:v0.1.0
|
|
212
223
|
|
|
213
224
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-logistic-logpdf/main.svg
|
|
214
225
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-logistic-logpdf?branch=main
|
|
@@ -221,7 +232,7 @@ Copyright © 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
|
|
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
|
|
package/dist/index.d.ts
ADDED
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 N=o(function(C,c){
|
|
2
|
+
var n=require('@stdlib/math-base-assert-is-nan/dist'),y=require('@stdlib/math-base-special-log1p/dist'),d=require('@stdlib/math-base-special-abs/dist'),z=require('@stdlib/math-base-special-exp/dist'),F=require('@stdlib/math-base-special-ln/dist'),v=require('@stdlib/constants-float64-ninf/dist'),I=require('@stdlib/constants-float64-pinf/dist');function b(e,r,a){var t,i;return n(e)||n(r)||n(a)||a<0?NaN:e===v?v:a===0?e===r?I:v:(i=(e-r)/a,t=-d(i),t-2*y(z(t))-F(a))}c.exports=b
|
|
3
|
+
});var s=o(function(D,l){
|
|
4
|
+
var O=require('@stdlib/utils-constant-function/dist'),P=require('@stdlib/stats-base-dists-degenerate-logpdf/dist').factory,q=require('@stdlib/math-base-assert-is-nan/dist'),R=require('@stdlib/math-base-special-log1p/dist'),h=require('@stdlib/math-base-special-abs/dist'),j=require('@stdlib/math-base-special-exp/dist'),k=require('@stdlib/math-base-special-ln/dist'),p=require('@stdlib/constants-float64-ninf/dist');function w(e,r){var a;if(q(e)||q(r)||r<0)return O(NaN);if(r===0)return P(e);return a=k(r),t;function t(i){var u,f;return q(i)?NaN:i===p?p:(f=(i-e)/r,u=-h(f),u-2*R(j(u))-a)}}l.exports=w
|
|
5
|
+
});var x=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),g=N(),A=s();x(g,"factory",A);module.exports=g;
|
|
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 log1p = require( '@stdlib/math-base-special-log1p' );\nvar abs = require( '@stdlib/math-base-special-abs' );\nvar exp = require( '@stdlib/math-base-special-exp' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\nvar PINF = require( '@stdlib/constants-float64-pinf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the logarithm of the probability density function (PDF) 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 logPDF\n*\n* @example\n* var y = logpdf( 2.0, 0.0, 1.0 );\n* // returns ~-2.254\n*\n* @example\n* var y = logpdf( -1.0, 4.0, 2.0 );\n* // returns ~-3.351\n*\n* @example\n* var y = logpdf( NaN, 0.0, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 0.0, NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 0.0, 0.0, NaN );\n* // returns NaN\n*\n* @example\n* // Negative scale parameter:\n* var y = logpdf( 2.0, 0.0, -1.0 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 2.0, 8.0, 0.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logpdf( 8.0, 8.0, 0.0 );\n* // returns Infinity\n*/\nfunction logpdf( x, mu, s ) {\n\tvar az;\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 ( x === NINF ) {\n\t\treturn NINF;\n\t}\n\tif ( s === 0.0 ) {\n\t\treturn ( x === mu ) ? PINF : NINF;\n\t}\n\tz = ( x - mu ) / s;\n\taz = -abs( z );\n\treturn az - (2.0 * log1p( exp( az ) )) - ln( s );\n}\n\n\n// EXPORTS //\n\nmodule.exports = logpdf;\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-logpdf' ).factory;\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar log1p = require( '@stdlib/math-base-special-log1p' );\nvar abs = require( '@stdlib/math-base-special-abs' );\nvar exp = require( '@stdlib/math-base-special-exp' );\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 logarithm of the probability density function (PDF) for a logistic distribution.\n*\n* @param {number} mu - location parameter\n* @param {NonNegativeNumber} s - scale parameter\n* @returns {Function} logPDF\n*\n* @example\n* var logpdf = factory( 10.0, 2.0 );\n* var y = logpdf( 10.0 );\n* // returns ~-2.079\n*\n* y = logpdf( 5.0 );\n* // returns ~-3.351\n*/\nfunction factory( mu, s ) {\n\tvar ls;\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\tls = ln( s );\n\treturn logpdf;\n\n\t/**\n\t* Evaluates the logarithm of the probability density function (PDF) for a logistic distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {number} evaluated logPDF\n\t*\n\t* @example\n\t* var y = logpdf( -1.2 );\n\t* // returns <number>\n\t*/\n\tfunction logpdf( x ) {\n\t\tvar az;\n\t\tvar z;\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tif ( x === NINF ) {\n\t\t\treturn NINF;\n\t\t}\n\t\tz = ( x - mu ) / s;\n\t\taz = -abs( z );\n\t\treturn az - (2.0 * log1p( exp( az ) )) - ls;\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 probability density function (PDF).\n*\n* @module @stdlib/stats-base-dists-logistic-logpdf\n*\n* @example\n* var logpdf = require( '@stdlib/stats-base-dists-logistic-logpdf' );\n*\n* var y = logpdf( 2.0, 0.0, 1.0 );\n* // returns ~-2.254\n*\n* var mylogpdf = logpdf.factory( 10.0, 2.0 );\n* y = mylogpdf( 10.0 );\n* // returns -2.079\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,EAAM,QAAS,+BAAgC,EAC/CC,EAAM,QAAS,+BAAgC,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EACjDC,EAAO,QAAS,gCAAiC,EA8CrD,SAASC,EAAQC,EAAGC,EAAIC,EAAI,CAC3B,IAAIC,EACAC,EACJ,OACCZ,EAAOQ,CAAE,GACTR,EAAOS,CAAG,GACVT,EAAOU,CAAE,GACTA,EAAI,EAEG,IAEHF,IAAMH,EACHA,EAEHK,IAAM,EACDF,IAAMC,EAAOH,EAAOD,GAE9BO,GAAMJ,EAAIC,GAAOC,EACjBC,EAAK,CAACT,EAAKU,CAAE,EACND,EAAM,EAAMV,EAAOE,EAAKQ,CAAG,CAAE,EAAKP,EAAIM,CAAE,EAChD,CAKAX,EAAO,QAAUQ,ICnGjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAa,QAAS,4CAA6C,EAAE,QACrEC,EAAQ,QAAS,iCAAkC,EACnDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAM,QAAS,+BAAgC,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EAoBrD,SAASC,EAASC,EAAIC,EAAI,CACzB,IAAIC,EACJ,GAAKT,EAAOO,CAAG,GAAKP,EAAOQ,CAAE,GAAKA,EAAI,EACrC,OAAOV,EAAkB,GAAI,EAE9B,GAAKU,IAAM,EACV,OAAOT,EAAYQ,CAAG,EAEvB,OAAAE,EAAKL,EAAII,CAAE,EACJE,EAaP,SAASA,EAAQC,EAAI,CACpB,IAAIC,EACAC,EACJ,OAAKb,EAAOW,CAAE,EACN,IAEHA,IAAMN,EACHA,GAERQ,GAAMF,EAAIJ,GAAOC,EACjBI,EAAK,CAACV,EAAKW,CAAE,EACND,EAAM,EAAMX,EAAOE,EAAKS,CAAG,CAAE,EAAKH,EAC1C,CACD,CAKAZ,EAAO,QAAUS,ICnDjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
|
|
6
|
+
"names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "log1p", "abs", "exp", "ln", "NINF", "PINF", "logpdf", "x", "mu", "s", "az", "z", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "degenerate", "isnan", "log1p", "abs", "exp", "ln", "NINF", "factory", "mu", "s", "ls", "logpdf", "x", "az", "z", "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-logistic-logpdf",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"description": "Logistic distribution logarithm of probability density function (PDF).",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -37,24 +37,24 @@
|
|
|
37
37
|
"url": "https://github.com/stdlib-js/stdlib/issues"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@stdlib/constants-float64-ninf": "^0.0
|
|
41
|
-
"@stdlib/constants-float64-pinf": "^0.0
|
|
42
|
-
"@stdlib/math-base-assert-is-nan": "^0.0
|
|
43
|
-
"@stdlib/math-base-special-abs": "^0.0
|
|
44
|
-
"@stdlib/math-base-special-exp": "^0.0
|
|
45
|
-
"@stdlib/math-base-special-ln": "^0.0
|
|
46
|
-
"@stdlib/math-base-special-log1p": "^0.0
|
|
47
|
-
"@stdlib/stats-base-dists-degenerate-logpdf": "^0.0
|
|
48
|
-
"@stdlib/utils-constant-function": "^0.0
|
|
49
|
-
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.0
|
|
40
|
+
"@stdlib/constants-float64-ninf": "^0.1.0",
|
|
41
|
+
"@stdlib/constants-float64-pinf": "^0.1.0",
|
|
42
|
+
"@stdlib/math-base-assert-is-nan": "^0.1.0",
|
|
43
|
+
"@stdlib/math-base-special-abs": "^0.1.0",
|
|
44
|
+
"@stdlib/math-base-special-exp": "^0.1.0",
|
|
45
|
+
"@stdlib/math-base-special-ln": "^0.1.0",
|
|
46
|
+
"@stdlib/math-base-special-log1p": "^0.1.0",
|
|
47
|
+
"@stdlib/stats-base-dists-degenerate-logpdf": "^0.1.0",
|
|
48
|
+
"@stdlib/utils-constant-function": "^0.1.0",
|
|
49
|
+
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
|
-
"@stdlib/bench": "^0.0
|
|
53
|
-
"@stdlib/constants-float64-eps": "^0.0
|
|
54
|
-
"@stdlib/random-base-randu": "^0.0.
|
|
52
|
+
"@stdlib/bench": "^0.1.0",
|
|
53
|
+
"@stdlib/constants-float64-eps": "^0.1.0",
|
|
54
|
+
"@stdlib/random-base-randu": "^0.0.8",
|
|
55
55
|
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
|
|
56
56
|
"istanbul": "^0.4.1",
|
|
57
|
-
"tap-
|
|
57
|
+
"tap-min": "git+https://github.com/Planeshifter/tap-min.git"
|
|
58
58
|
},
|
|
59
59
|
"engines": {
|
|
60
60
|
"node": ">=0.10.0",
|
|
@@ -87,7 +87,7 @@
|
|
|
87
87
|
"continuous"
|
|
88
88
|
],
|
|
89
89
|
"funding": {
|
|
90
|
-
"type": "
|
|
91
|
-
"url": "https://
|
|
90
|
+
"type": "opencollective",
|
|
91
|
+
"url": "https://opencollective.com/stdlib"
|
|
92
92
|
}
|
|
93
93
|
}
|
package/docs/repl.txt
DELETED
|
@@ -1,77 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( x, μ, s )
|
|
3
|
-
Evaluates the logarithm of the probability density function (PDF) 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 logPDF.
|
|
26
|
-
|
|
27
|
-
Examples
|
|
28
|
-
--------
|
|
29
|
-
> var y = {{alias}}( 2.0, 0.0, 1.0 )
|
|
30
|
-
~-2.254
|
|
31
|
-
> y = {{alias}}( -1.0, 4.0, 2.0 )
|
|
32
|
-
~-3.351
|
|
33
|
-
> y = {{alias}}( NaN, 0.0, 1.0 )
|
|
34
|
-
NaN
|
|
35
|
-
> y = {{alias}}( 0.0, NaN, 1.0 )
|
|
36
|
-
NaN
|
|
37
|
-
> y = {{alias}}( 0.0, 0.0, NaN )
|
|
38
|
-
NaN
|
|
39
|
-
|
|
40
|
-
// Negative scale parameter:
|
|
41
|
-
> y = {{alias}}( 2.0, 0.0, -1.0 )
|
|
42
|
-
NaN
|
|
43
|
-
|
|
44
|
-
// Degenerate distribution at `s = 0.0`:
|
|
45
|
-
> y = {{alias}}( 2.0, 8.0, 0.0 )
|
|
46
|
-
-Infinity
|
|
47
|
-
> y = {{alias}}( 8.0, 8.0, 0.0 )
|
|
48
|
-
Infinity
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
{{alias}}.factory( μ, s )
|
|
52
|
-
Returns a function for evaluating the logarithm of the probability density
|
|
53
|
-
function (PDF) of a Logistic distribution with location parameter `μ` and
|
|
54
|
-
scale parameter `s`.
|
|
55
|
-
|
|
56
|
-
Parameters
|
|
57
|
-
----------
|
|
58
|
-
μ: number
|
|
59
|
-
Location parameter.
|
|
60
|
-
|
|
61
|
-
s: number
|
|
62
|
-
Scale parameter.
|
|
63
|
-
|
|
64
|
-
Returns
|
|
65
|
-
-------
|
|
66
|
-
logpdf: Function
|
|
67
|
-
Logarithm of probability density function (PDF).
|
|
68
|
-
|
|
69
|
-
Examples
|
|
70
|
-
--------
|
|
71
|
-
> var mylogpdf = {{alias}}.factory( 10.0, 2.0 );
|
|
72
|
-
> var y = mylogpdf( 10.0 )
|
|
73
|
-
~-2.079
|
|
74
|
-
|
|
75
|
-
See Also
|
|
76
|
-
--------
|
|
77
|
-
|
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 logpdf = require( './index' );
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
// TESTS //
|
|
23
|
-
|
|
24
|
-
// The function returns a number...
|
|
25
|
-
{
|
|
26
|
-
logpdf( 2, 2, 4 ); // $ExpectType number
|
|
27
|
-
logpdf( 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
|
-
logpdf( true, 3, 6 ); // $ExpectError
|
|
33
|
-
logpdf( false, 2, 4 ); // $ExpectError
|
|
34
|
-
logpdf( '5', 1, 2 ); // $ExpectError
|
|
35
|
-
logpdf( [], 1, 2 ); // $ExpectError
|
|
36
|
-
logpdf( {}, 2, 4 ); // $ExpectError
|
|
37
|
-
logpdf( ( x: number ): number => x, 2, 4 ); // $ExpectError
|
|
38
|
-
|
|
39
|
-
logpdf( 9, true, 12 ); // $ExpectError
|
|
40
|
-
logpdf( 9, false, 12 ); // $ExpectError
|
|
41
|
-
logpdf( 5, '5', 10 ); // $ExpectError
|
|
42
|
-
logpdf( 8, [], 16 ); // $ExpectError
|
|
43
|
-
logpdf( 9, {}, 18 ); // $ExpectError
|
|
44
|
-
logpdf( 8, ( x: number ): number => x, 16 ); // $ExpectError
|
|
45
|
-
|
|
46
|
-
logpdf( 9, 5, true ); // $ExpectError
|
|
47
|
-
logpdf( 9, 5, false ); // $ExpectError
|
|
48
|
-
logpdf( 5, 2, '5' ); // $ExpectError
|
|
49
|
-
logpdf( 8, 4, [] ); // $ExpectError
|
|
50
|
-
logpdf( 9, 4, {} ); // $ExpectError
|
|
51
|
-
logpdf( 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
|
-
logpdf(); // $ExpectError
|
|
57
|
-
logpdf( 2 ); // $ExpectError
|
|
58
|
-
logpdf( 2, 0 ); // $ExpectError
|
|
59
|
-
logpdf( 2, 0, 4, 1 ); // $ExpectError
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
// Attached to main export is a `factory` method which returns a function...
|
|
63
|
-
{
|
|
64
|
-
logpdf.factory( 3, 4 ); // $ExpectType Unary
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
// The `factory` method returns a function which returns a number...
|
|
68
|
-
{
|
|
69
|
-
const fcn = logpdf.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 = logpdf.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 = logpdf.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
|
-
logpdf.factory( true, 3 ); // $ExpectError
|
|
95
|
-
logpdf.factory( false, 2 ); // $ExpectError
|
|
96
|
-
logpdf.factory( '5', 1 ); // $ExpectError
|
|
97
|
-
logpdf.factory( [], 1 ); // $ExpectError
|
|
98
|
-
logpdf.factory( {}, 2 ); // $ExpectError
|
|
99
|
-
logpdf.factory( ( x: number ): number => x, 2 ); // $ExpectError
|
|
100
|
-
|
|
101
|
-
logpdf.factory( 9, true ); // $ExpectError
|
|
102
|
-
logpdf.factory( 9, false ); // $ExpectError
|
|
103
|
-
logpdf.factory( 5, '5' ); // $ExpectError
|
|
104
|
-
logpdf.factory( 8, [] ); // $ExpectError
|
|
105
|
-
logpdf.factory( 9, {} ); // $ExpectError
|
|
106
|
-
logpdf.factory( 8, ( x: number ): number => x ); // $ExpectError
|
|
107
|
-
|
|
108
|
-
logpdf.factory( [], true ); // $ExpectError
|
|
109
|
-
logpdf.factory( {}, false ); // $ExpectError
|
|
110
|
-
logpdf.factory( false, '5' ); // $ExpectError
|
|
111
|
-
logpdf.factory( {}, [] ); // $ExpectError
|
|
112
|
-
logpdf.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
|
-
logpdf.factory( 0 ); // $ExpectError
|
|
118
|
-
logpdf.factory( 0, 4, 8 ); // $ExpectError
|
|
119
|
-
}
|
|
File without changes
|