@stdlib/stats-base-dists-t-ctor 0.0.8 → 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 +5 -0
- package/dist/index.js.map +7 -0
- package/docs/types/index.d.ts +1 -1
- package/lib/index.js +2 -2
- package/package.json +29 -28
- package/docs/repl.txt +0 -93
- package/docs/types/test.ts +0 -45
- /package/lib/{ctor.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
|
# Student's T
|
|
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] -->
|
|
@@ -336,7 +347,7 @@ See [LICENSE][stdlib-license].
|
|
|
336
347
|
|
|
337
348
|
## Copyright
|
|
338
349
|
|
|
339
|
-
Copyright © 2016-
|
|
350
|
+
Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors].
|
|
340
351
|
|
|
341
352
|
</section>
|
|
342
353
|
|
|
@@ -349,8 +360,8 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
349
360
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-t-ctor.svg
|
|
350
361
|
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-t-ctor
|
|
351
362
|
|
|
352
|
-
[test-image]: https://github.com/stdlib-js/stats-base-dists-t-ctor/actions/workflows/test.yml/badge.svg?branch=v0.0
|
|
353
|
-
[test-url]: https://github.com/stdlib-js/stats-base-dists-t-ctor/actions/workflows/test.yml?query=branch:v0.0
|
|
363
|
+
[test-image]: https://github.com/stdlib-js/stats-base-dists-t-ctor/actions/workflows/test.yml/badge.svg?branch=v0.1.0
|
|
364
|
+
[test-url]: https://github.com/stdlib-js/stats-base-dists-t-ctor/actions/workflows/test.yml?query=branch:v0.1.0
|
|
354
365
|
|
|
355
366
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-t-ctor/main.svg
|
|
356
367
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-t-ctor?branch=main
|
|
@@ -363,7 +374,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
363
374
|
-->
|
|
364
375
|
|
|
365
376
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
366
|
-
[chat-url]: https://gitter.im
|
|
377
|
+
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
|
|
367
378
|
|
|
368
379
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
369
380
|
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
"use strict";var p=function(e,i){return function(){return i||e((i={exports:{}}).exports,i),i.exports}};var v=p(function(O,a){
|
|
2
|
+
var f=require('@stdlib/utils-define-property/dist'),n=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),t=require('@stdlib/utils-define-nonenumerable-read-only-accessor/dist'),o=require('@stdlib/assert-is-positive-number/dist').isPrimitive,c=require('@stdlib/stats-base-dists-t-entropy/dist'),g=require('@stdlib/stats-base-dists-t-kurtosis/dist'),q=require('@stdlib/stats-base-dists-t-mean/dist'),h=require('@stdlib/stats-base-dists-t-median/dist'),m=require('@stdlib/stats-base-dists-t-mode/dist'),y=require('@stdlib/stats-base-dists-t-skewness/dist'),d=require('@stdlib/stats-base-dists-t-stdev/dist'),l=require('@stdlib/stats-base-dists-t-variance/dist'),w=require('@stdlib/stats-base-dists-t-cdf/dist'),b=require('@stdlib/stats-base-dists-t-logcdf/dist'),P=require('@stdlib/stats-base-dists-t-logpdf/dist'),k=require('@stdlib/stats-base-dists-t-pdf/dist'),D=require('@stdlib/stats-base-dists-t-quantile/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist');function F(e){return w(e,this.v)}function R(e){return b(e,this.v)}function T(e){return P(e,this.v)}function x(e){return k(e,this.v)}function C(e){return D(e,this.v)}function r(){var e;if(!(this instanceof r))return arguments.length===0?new r:new r(arguments[0]);if(arguments.length){if(e=arguments[0],!o(e))throw new TypeError(s('1898q',e))}else e=1;return f(this,"v",{configurable:!1,enumerable:!0,get:function(){return e},set:function(u){if(!o(u))throw new TypeError(s('1898k',u));e=u}}),this;}t(r.prototype,"entropy",function(){return c(this.v)});t(r.prototype,"kurtosis",function(){return g(this.v)});t(r.prototype,"mean",function(){return q(this.v)});t(r.prototype,"median",function(){return h(this.v)});t(r.prototype,"mode",function(){return m(this.v)});t(r.prototype,"skewness",function(){return y(this.v)});t(r.prototype,"stdev",function(){return d(this.v)});t(r.prototype,"variance",function(){return l(this.v)});n(r.prototype,"cdf",F);n(r.prototype,"logcdf",R);n(r.prototype,"logpdf",T);n(r.prototype,"pdf",x);n(r.prototype,"quantile",C);a.exports=r
|
|
3
|
+
});var E=v();module.exports=E;
|
|
4
|
+
/** @license Apache-2.0 */
|
|
5
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../lib/main.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar defineProperty = require( '@stdlib/utils-define-property' );\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' );\nvar isPositive = require( '@stdlib/assert-is-positive-number' ).isPrimitive;\nvar entropy = require( '@stdlib/stats-base-dists-t-entropy' );\nvar kurtosis = require( '@stdlib/stats-base-dists-t-kurtosis' );\nvar mean = require( '@stdlib/stats-base-dists-t-mean' );\nvar median = require( '@stdlib/stats-base-dists-t-median' );\nvar mode = require( '@stdlib/stats-base-dists-t-mode' );\nvar skewness = require( '@stdlib/stats-base-dists-t-skewness' );\nvar stdev = require( '@stdlib/stats-base-dists-t-stdev' );\nvar variance = require( '@stdlib/stats-base-dists-t-variance' );\nvar cdf = require( '@stdlib/stats-base-dists-t-cdf' );\nvar logcdf = require( '@stdlib/stats-base-dists-t-logcdf' );\nvar logpdf = require( '@stdlib/stats-base-dists-t-logpdf' );\nvar pdf = require( '@stdlib/stats-base-dists-t-pdf' );\nvar quantile = require( '@stdlib/stats-base-dists-t-quantile' );\nvar format = require( '@stdlib/string-format' );\n\n\n// FUNCTIONS //\n\n/**\n* Evaluates the cumulative distribution function (CDF).\n*\n* @private\n* @param {number} x - input value\n* @returns {Probability} evaluated CDF\n*/\nfunction tCDF( x ) {\n\treturn cdf( x, this.v );\n}\n\n/**\n* Evaluates the natural logarithm of the cumulative distribution function (CDF).\n*\n* @private\n* @param {number} x - input value\n* @returns {number} evaluated logCDF\n*/\nfunction tLogCDF( x ) {\n\treturn logcdf( x, this.v );\n}\n\n/**\n* Evaluates the natural logarithm of the probability density function (PDF).\n*\n* @private\n* @param {number} x - input value\n* @returns {number} evaluated logPDF\n*/\nfunction tLogPDF( x ) {\n\treturn logpdf( x, this.v );\n}\n\n/**\n* Evaluates the probability density function (PDF).\n*\n* @private\n* @param {number} x - input value\n* @returns {number} evaluated PDF\n*/\nfunction tPDF( x ) {\n\treturn pdf( x, this.v );\n}\n\n/**\n* Evaluates the quantile function.\n*\n* @private\n* @param {Probability} p - input probability\n* @returns {number} evaluated quantile function\n*/\nfunction tQuantile( p ) {\n\treturn quantile( p, this.v );\n}\n\n\n// MAIN //\n\n/**\n* Student's t distribution constructor.\n*\n* @constructor\n* @param {PositiveNumber} [v=1.0] - degrees of freedom\n* @throws {TypeError} `v` must be a positive number\n* @returns {T} distribution instance\n*\n* @example\n* var t = new T( 1.0 );\n*\n* var y = t.cdf( 0.8 );\n* // returns ~0.715\n*\n* var v = t.mode;\n* // returns 0.0\n*/\nfunction T() {\n\tvar v;\n\tif ( !(this instanceof T) ) {\n\t\tif ( arguments.length === 0 ) {\n\t\t\treturn new T();\n\t\t}\n\t\treturn new T( arguments[ 0 ] );\n\t}\n\tif ( arguments.length ) {\n\t\tv = arguments[ 0 ];\n\t\tif ( !isPositive( v ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Rate parameter must be a positive number. Value: `%s`.', v ) );\n\t\t}\n\t} else {\n\t\tv = 1.0;\n\t}\n\tdefineProperty( this, 'v', {\n\t\t'configurable': false,\n\t\t'enumerable': true,\n\t\t'get': function get() {\n\t\t\treturn v;\n\t\t},\n\t\t'set': function set( value ) {\n\t\t\tif ( !isPositive( value ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid assignment. Must be a positive number. Value: `%s`.', value ) );\n\t\t\t}\n\t\t\tv = value;\n\t\t}\n\t});\n\treturn this;\n}\n\n/**\n* Student's t distribution differential entropy.\n*\n* @name entropy\n* @memberof T.prototype\n* @type {number}\n* @see [differential entropy]{@link https://en.wikipedia.org/wiki/Entropy_%28information_theory%29}\n*\n* @example\n* var t = new T( 4.0 );\n*\n* var v = t.entropy;\n* // returns ~1.682\n*/\nsetReadOnlyAccessor( T.prototype, 'entropy', function get() {\n\treturn entropy( this.v );\n});\n\n/**\n* Student's t distribution excess kurtosis.\n*\n* @name kurtosis\n* @memberof T.prototype\n* @type {number}\n* @see [kurtosis]{@link https://en.wikipedia.org/wiki/Kurtosis}\n*\n* @example\n* var t = new T( 4.0 );\n*\n* var v = t.kurtosis;\n* // returns Infinity\n*/\nsetReadOnlyAccessor( T.prototype, 'kurtosis', function get() {\n\treturn kurtosis( this.v );\n});\n\n/**\n* Student's t distribution expected value.\n*\n* @name mean\n* @memberof T.prototype\n* @type {number}\n* @see [expected value]{@link https://en.wikipedia.org/wiki/Expected_value}\n*\n* @example\n* var t = new T( 4.0 );\n*\n* var v = t.mean;\n* // returns 0.0\n*/\nsetReadOnlyAccessor( T.prototype, 'mean', function get() {\n\treturn mean( this.v );\n});\n\n/**\n* Student's t distribution median.\n*\n* @name median\n* @memberof T.prototype\n* @type {number}\n* @see [median]{@link https://en.wikipedia.org/wiki/Median}\n*\n* @example\n* var t = new T( 4.0 );\n*\n* var v = t.median;\n* // returns 0.0\n*/\nsetReadOnlyAccessor( T.prototype, 'median', function get() {\n\treturn median( this.v );\n});\n\n/**\n* Student's t distribution mode.\n*\n* @name mode\n* @memberof T.prototype\n* @type {number}\n* @see [mode]{@link https://en.wikipedia.org/wiki/Mode_%28statistics%29}\n*\n* @example\n* var t = new T( 4.0 );\n*\n* var v = t.mode;\n* // returns 0.0\n*/\nsetReadOnlyAccessor( T.prototype, 'mode', function get() {\n\treturn mode( this.v );\n});\n\n/**\n* Student's t distribution skewness.\n*\n* @name skewness\n* @memberof T.prototype\n* @type {number}\n* @see [skewness]{@link https://en.wikipedia.org/wiki/Skewness}\n*\n* @example\n* var t = new T( 4.0 );\n*\n* var v = t.skewness;\n* // returns 0.0\n*/\nsetReadOnlyAccessor( T.prototype, 'skewness', function get() {\n\treturn skewness( this.v );\n});\n\n/**\n* Student's t distribution standard deviation.\n*\n* @name stdev\n* @memberof T.prototype\n* @type {PositiveNumber}\n* @see [standard deviation]{@link https://en.wikipedia.org/wiki/Standard_deviation}\n*\n* @example\n* var t = new T( 4.0 );\n*\n* var v = t.stdev;\n* // returns ~1.414\n*/\nsetReadOnlyAccessor( T.prototype, 'stdev', function get() {\n\treturn stdev( this.v );\n});\n\n/**\n* Student's t distribution variance.\n*\n* @name variance\n* @memberof T.prototype\n* @type {PositiveNumber}\n* @see [variance]{@link https://en.wikipedia.org/wiki/Variance}\n*\n* @example\n* var t = new T( 4.0 );\n*\n* var v = t.variance;\n* // returns 2.0\n*/\nsetReadOnlyAccessor( T.prototype, 'variance', function get() {\n\treturn variance( this.v );\n});\n\n/**\n* Evaluates the cumulative distribution function (CDF).\n*\n* @name cdf\n* @memberof T.prototype\n* @type {Function}\n* @param {number} x - input value\n* @returns {number} evaluated CDF\n* @see [cdf]{@link https://en.wikipedia.org/wiki/Cumulative_distribution_function}\n*\n* @example\n* var t = new T( 2.0 );\n*\n* var v = t.cdf( 0.5 );\n* // returns ~0.667\n*/\nsetReadOnly( T.prototype, 'cdf', tCDF );\n\n/**\n* Evaluates the natural logarithm of the cumulative distribution function (CDF).\n*\n* @name logcdf\n* @memberof T.prototype\n* @type {Function}\n* @param {number} x - input value\n* @returns {number} evaluated logCDF\n* @see [cdf]{@link https://en.wikipedia.org/wiki/Cumulative_distribution_function}\n*\n* @example\n* var t = new T( 2.0 );\n*\n* var v = t.logcdf( 0.5 );\n* // returns ~-0.405\n*/\nsetReadOnly( T.prototype, 'logcdf', tLogCDF );\n\n/**\n* Evaluates the natural logarithm of the probability density function (PDF).\n*\n* @name logpdf\n* @memberof T.prototype\n* @type {Function}\n* @param {number} x - input value\n* @returns {number} evaluated logPDF\n* @see [pdf]{@link https://en.wikipedia.org/wiki/Probability_density_function}\n*\n* @example\n* var t = new T( 2.0 );\n*\n* var v = t.logpdf( 0.8 );\n* // returns ~-1.456\n*/\nsetReadOnly( T.prototype, 'logpdf', tLogPDF );\n\n/**\n* Evaluates the probability density function (PDF).\n*\n* @name pdf\n* @memberof T.prototype\n* @type {Function}\n* @param {number} x - input value\n* @returns {number} evaluated PDF\n* @see [pdf]{@link https://en.wikipedia.org/wiki/Probability_density_function}\n*\n* @example\n* var t = new T( 2.0 );\n*\n* var v = t.pdf( 0.8 );\n* // returns ~0.233\n*/\nsetReadOnly( T.prototype, 'pdf', tPDF );\n\n/**\n* Evaluates the quantile function.\n*\n* @name quantile\n* @memberof T.prototype\n* @type {Function}\n* @param {Probability} p - input probability\n* @returns {number} evaluated quantile function\n* @see [quantile function]{@link https://en.wikipedia.org/wiki/Quantile_function}\n*\n* @example\n* var t = new T( 2.0 );\n*\n* var v = t.quantile( 0.5 );\n* // returns 0.0\n*/\nsetReadOnly( T.prototype, 'quantile', tQuantile );\n\n\n// EXPORTS //\n\nmodule.exports = T;\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* Student's t distribution constructor.\n*\n* @module @stdlib/stats-base-dists-t-ctor\n*\n* @example\n* var T = require( '@stdlib/stats-base-dists-t-ctor' );\n*\n* var t = new T( 1.0 );\n*\n* var y = t.cdf( 0.8 );\n* // returns ~0.715\n*\n* var mode = t.mode;\n* // returns 0.0\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
|
|
5
|
+
"mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAiB,QAAS,+BAAgC,EAC1DC,EAAc,QAAS,uDAAwD,EAC/EC,EAAsB,QAAS,uDAAwD,EACvFC,EAAa,QAAS,mCAAoC,EAAE,YAC5DC,EAAU,QAAS,oCAAqC,EACxDC,EAAW,QAAS,qCAAsC,EAC1DC,EAAO,QAAS,iCAAkC,EAClDC,EAAS,QAAS,mCAAoC,EACtDC,EAAO,QAAS,iCAAkC,EAClDC,EAAW,QAAS,qCAAsC,EAC1DC,EAAQ,QAAS,kCAAmC,EACpDC,EAAW,QAAS,qCAAsC,EAC1DC,EAAM,QAAS,gCAAiC,EAChDC,EAAS,QAAS,mCAAoC,EACtDC,EAAS,QAAS,mCAAoC,EACtDC,EAAM,QAAS,gCAAiC,EAChDC,EAAW,QAAS,qCAAsC,EAC1DC,EAAS,QAAS,uBAAwB,EAY9C,SAASC,EAAMC,EAAI,CAClB,OAAOP,EAAKO,EAAG,KAAK,CAAE,CACvB,CASA,SAASC,EAASD,EAAI,CACrB,OAAON,EAAQM,EAAG,KAAK,CAAE,CAC1B,CASA,SAASE,EAASF,EAAI,CACrB,OAAOL,EAAQK,EAAG,KAAK,CAAE,CAC1B,CASA,SAASG,EAAMH,EAAI,CAClB,OAAOJ,EAAKI,EAAG,KAAK,CAAE,CACvB,CASA,SAASI,EAAWC,EAAI,CACvB,OAAOR,EAAUQ,EAAG,KAAK,CAAE,CAC5B,CAsBA,SAASC,GAAI,CACZ,IAAIC,EACJ,GAAK,EAAE,gBAAgBD,GACtB,OAAK,UAAU,SAAW,EAClB,IAAIA,EAEL,IAAIA,EAAG,UAAW,CAAE,CAAE,EAE9B,GAAK,UAAU,QAEd,GADAC,EAAI,UAAW,CAAE,EACZ,CAACvB,EAAYuB,CAAE,EACnB,MAAM,IAAI,UAAWT,EAAQ,2EAA4ES,CAAE,CAAE,OAG9GA,EAAI,EAEL,OAAA1B,EAAgB,KAAM,IAAK,CAC1B,aAAgB,GAChB,WAAc,GACd,IAAO,UAAe,CACrB,OAAO0B,CACR,EACA,IAAO,SAAcC,EAAQ,CAC5B,GAAK,CAACxB,EAAYwB,CAAM,EACvB,MAAM,IAAI,UAAWV,EAAQ,8DAA+DU,CAAM,CAAE,EAErGD,EAAIC,CACL,CACD,CAAC,EACM,IACR,CAgBAzB,EAAqBuB,EAAE,UAAW,UAAW,UAAe,CAC3D,OAAOrB,EAAS,KAAK,CAAE,CACxB,CAAC,EAgBDF,EAAqBuB,EAAE,UAAW,WAAY,UAAe,CAC5D,OAAOpB,EAAU,KAAK,CAAE,CACzB,CAAC,EAgBDH,EAAqBuB,EAAE,UAAW,OAAQ,UAAe,CACxD,OAAOnB,EAAM,KAAK,CAAE,CACrB,CAAC,EAgBDJ,EAAqBuB,EAAE,UAAW,SAAU,UAAe,CAC1D,OAAOlB,EAAQ,KAAK,CAAE,CACvB,CAAC,EAgBDL,EAAqBuB,EAAE,UAAW,OAAQ,UAAe,CACxD,OAAOjB,EAAM,KAAK,CAAE,CACrB,CAAC,EAgBDN,EAAqBuB,EAAE,UAAW,WAAY,UAAe,CAC5D,OAAOhB,EAAU,KAAK,CAAE,CACzB,CAAC,EAgBDP,EAAqBuB,EAAE,UAAW,QAAS,UAAe,CACzD,OAAOf,EAAO,KAAK,CAAE,CACtB,CAAC,EAgBDR,EAAqBuB,EAAE,UAAW,WAAY,UAAe,CAC5D,OAAOd,EAAU,KAAK,CAAE,CACzB,CAAC,EAkBDV,EAAawB,EAAE,UAAW,MAAOP,CAAK,EAkBtCjB,EAAawB,EAAE,UAAW,SAAUL,CAAQ,EAkB5CnB,EAAawB,EAAE,UAAW,SAAUJ,CAAQ,EAkB5CpB,EAAawB,EAAE,UAAW,MAAOH,CAAK,EAkBtCrB,EAAawB,EAAE,UAAW,WAAYF,CAAU,EAKhDxB,EAAO,QAAU0B,IC/VjB,IAAIG,EAAO,IAKX,OAAO,QAAUA",
|
|
6
|
+
"names": ["require_main", "__commonJSMin", "exports", "module", "defineProperty", "setReadOnly", "setReadOnlyAccessor", "isPositive", "entropy", "kurtosis", "mean", "median", "mode", "skewness", "stdev", "variance", "cdf", "logcdf", "logpdf", "pdf", "quantile", "format", "tCDF", "x", "tLogCDF", "tLogPDF", "tPDF", "tQuantile", "p", "T", "v", "value", "main"]
|
|
7
|
+
}
|
package/docs/types/index.d.ts
CHANGED
package/lib/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stdlib/stats-base-dists-t-ctor",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"description": "Student's t distribution constructor.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -37,35 +37,36 @@
|
|
|
37
37
|
"url": "https://github.com/stdlib-js/stdlib/issues"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@stdlib/assert-is-positive-number": "^0.0
|
|
41
|
-
"@stdlib/stats-base-dists-t-cdf": "^0.0
|
|
42
|
-
"@stdlib/stats-base-dists-t-entropy": "^0.0
|
|
43
|
-
"@stdlib/stats-base-dists-t-kurtosis": "^0.0
|
|
44
|
-
"@stdlib/stats-base-dists-t-logcdf": "^0.0
|
|
45
|
-
"@stdlib/stats-base-dists-t-logpdf": "^0.0
|
|
46
|
-
"@stdlib/stats-base-dists-t-mean": "^0.0
|
|
47
|
-
"@stdlib/stats-base-dists-t-median": "^0.0
|
|
48
|
-
"@stdlib/stats-base-dists-t-mode": "^0.0
|
|
49
|
-
"@stdlib/stats-base-dists-t-pdf": "^0.0
|
|
50
|
-
"@stdlib/stats-base-dists-t-quantile": "^0.0
|
|
51
|
-
"@stdlib/stats-base-dists-t-skewness": "^0.0
|
|
52
|
-
"@stdlib/stats-base-dists-t-stdev": "^0.0
|
|
53
|
-
"@stdlib/stats-base-dists-t-variance": "^0.0
|
|
54
|
-
"@stdlib/string-format": "^0.0
|
|
55
|
-
"@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0
|
|
56
|
-
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.0
|
|
57
|
-
"@stdlib/utils-define-property": "^0.0
|
|
40
|
+
"@stdlib/assert-is-positive-number": "^0.1.0",
|
|
41
|
+
"@stdlib/stats-base-dists-t-cdf": "^0.1.0",
|
|
42
|
+
"@stdlib/stats-base-dists-t-entropy": "^0.1.0",
|
|
43
|
+
"@stdlib/stats-base-dists-t-kurtosis": "^0.1.0",
|
|
44
|
+
"@stdlib/stats-base-dists-t-logcdf": "^0.1.0",
|
|
45
|
+
"@stdlib/stats-base-dists-t-logpdf": "^0.1.0",
|
|
46
|
+
"@stdlib/stats-base-dists-t-mean": "^0.1.0",
|
|
47
|
+
"@stdlib/stats-base-dists-t-median": "^0.1.0",
|
|
48
|
+
"@stdlib/stats-base-dists-t-mode": "^0.1.0",
|
|
49
|
+
"@stdlib/stats-base-dists-t-pdf": "^0.1.0",
|
|
50
|
+
"@stdlib/stats-base-dists-t-quantile": "^0.1.0",
|
|
51
|
+
"@stdlib/stats-base-dists-t-skewness": "^0.1.0",
|
|
52
|
+
"@stdlib/stats-base-dists-t-stdev": "^0.1.0",
|
|
53
|
+
"@stdlib/stats-base-dists-t-variance": "^0.1.0",
|
|
54
|
+
"@stdlib/string-format": "^0.1.0",
|
|
55
|
+
"@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.0",
|
|
56
|
+
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
|
|
57
|
+
"@stdlib/utils-define-property": "^0.1.0",
|
|
58
|
+
"@stdlib/error-tools-fmtprodmsg": "^0.1.0"
|
|
58
59
|
},
|
|
59
60
|
"devDependencies": {
|
|
60
|
-
"@stdlib/assert-has-own-property": "^0.0
|
|
61
|
-
"@stdlib/assert-is-function": "^0.0
|
|
62
|
-
"@stdlib/bench": "^0.0
|
|
63
|
-
"@stdlib/constants-float64-eps": "^0.0
|
|
64
|
-
"@stdlib/math-base-assert-is-nan": "^0.0
|
|
65
|
-
"@stdlib/random-base-randu": "^0.0.
|
|
61
|
+
"@stdlib/assert-has-own-property": "^0.1.0",
|
|
62
|
+
"@stdlib/assert-is-function": "^0.1.0",
|
|
63
|
+
"@stdlib/bench": "^0.1.0",
|
|
64
|
+
"@stdlib/constants-float64-eps": "^0.1.0",
|
|
65
|
+
"@stdlib/math-base-assert-is-nan": "^0.1.0",
|
|
66
|
+
"@stdlib/random-base-randu": "^0.0.8",
|
|
66
67
|
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
|
|
67
68
|
"istanbul": "^0.4.1",
|
|
68
|
-
"tap-
|
|
69
|
+
"tap-min": "git+https://github.com/Planeshifter/tap-min.git"
|
|
69
70
|
},
|
|
70
71
|
"engines": {
|
|
71
72
|
"node": ">=0.10.0"
|
|
@@ -106,7 +107,7 @@
|
|
|
106
107
|
"continuous"
|
|
107
108
|
],
|
|
108
109
|
"funding": {
|
|
109
|
-
"type": "
|
|
110
|
-
"url": "https://
|
|
110
|
+
"type": "opencollective",
|
|
111
|
+
"url": "https://opencollective.com/stdlib"
|
|
111
112
|
}
|
|
112
113
|
}
|
package/docs/repl.txt
DELETED
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( [v] )
|
|
3
|
-
Returns a Student's t distribution object.
|
|
4
|
-
|
|
5
|
-
Parameters
|
|
6
|
-
----------
|
|
7
|
-
v: number (optional)
|
|
8
|
-
Degrees of freedom. Must be greater than `0`. Default: `1.0`.
|
|
9
|
-
|
|
10
|
-
Returns
|
|
11
|
-
-------
|
|
12
|
-
t: Object
|
|
13
|
-
Distribution instance.
|
|
14
|
-
|
|
15
|
-
t.v: number
|
|
16
|
-
Degrees of freedom. If set, the value must be greater than `0`.
|
|
17
|
-
|
|
18
|
-
t.entropy: number
|
|
19
|
-
Read-only property which returns the differential entropy.
|
|
20
|
-
|
|
21
|
-
t.kurtosis: number
|
|
22
|
-
Read-only property which returns the excess kurtosis.
|
|
23
|
-
|
|
24
|
-
t.mean: number
|
|
25
|
-
Read-only property which returns the expected value.
|
|
26
|
-
|
|
27
|
-
t.median: number
|
|
28
|
-
Read-only property which returns the median.
|
|
29
|
-
|
|
30
|
-
t.mode: number
|
|
31
|
-
Read-only property which returns the mode.
|
|
32
|
-
|
|
33
|
-
t.skewness: number
|
|
34
|
-
Read-only property which returns the skewness.
|
|
35
|
-
|
|
36
|
-
t.stdev: number
|
|
37
|
-
Read-only property which returns the standard deviation.
|
|
38
|
-
|
|
39
|
-
t.variance: number
|
|
40
|
-
Read-only property which returns the variance.
|
|
41
|
-
|
|
42
|
-
t.cdf: Function
|
|
43
|
-
Evaluates the cumulative distribution function (CDF).
|
|
44
|
-
|
|
45
|
-
t.logcdf: Function
|
|
46
|
-
Evaluates the natural logarithm of the cumulative distribution function
|
|
47
|
-
(CDF).
|
|
48
|
-
|
|
49
|
-
t.logpdf: Function
|
|
50
|
-
Evaluates the natural logarithm of the probability density function
|
|
51
|
-
(PDF).
|
|
52
|
-
|
|
53
|
-
t.pdf: Function
|
|
54
|
-
Evaluates the probability density function (PDF).
|
|
55
|
-
|
|
56
|
-
t.quantile: Function
|
|
57
|
-
Evaluates the quantile function at probability `p`.
|
|
58
|
-
|
|
59
|
-
Examples
|
|
60
|
-
--------
|
|
61
|
-
> var t = {{alias}}( 6.0 );
|
|
62
|
-
> t.v
|
|
63
|
-
6.0
|
|
64
|
-
> t.entropy
|
|
65
|
-
~1.592
|
|
66
|
-
> t.kurtosis
|
|
67
|
-
3.0
|
|
68
|
-
> t.mean
|
|
69
|
-
0.0
|
|
70
|
-
> t.median
|
|
71
|
-
0.0
|
|
72
|
-
> t.mode
|
|
73
|
-
0.0
|
|
74
|
-
> t.skewness
|
|
75
|
-
0.0
|
|
76
|
-
> t.stdev
|
|
77
|
-
~1.225
|
|
78
|
-
> t.variance
|
|
79
|
-
1.5
|
|
80
|
-
> t.cdf( 1.0 )
|
|
81
|
-
~0.822
|
|
82
|
-
> t.logcdf( 1.0 )
|
|
83
|
-
~-0.196
|
|
84
|
-
> t.logpdf( 1.5 )
|
|
85
|
-
~-2.075
|
|
86
|
-
> t.pdf( 1.5 )
|
|
87
|
-
~0.126
|
|
88
|
-
> t.quantile( 0.8 )
|
|
89
|
-
~0.906
|
|
90
|
-
|
|
91
|
-
See Also
|
|
92
|
-
--------
|
|
93
|
-
|
package/docs/types/test.ts
DELETED
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* @license Apache-2.0
|
|
3
|
-
*
|
|
4
|
-
* Copyright (c) 2021 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
|
-
/* tslint:disable:no-unused-expression */
|
|
20
|
-
|
|
21
|
-
import T = require( './index' );
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
// TESTS //
|
|
25
|
-
|
|
26
|
-
// The function returns a distribution instance...
|
|
27
|
-
{
|
|
28
|
-
new T(); // $ExpectType T
|
|
29
|
-
new T( 1.5 ); // $ExpectType T
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
// The compiler throws an error if the function is provided a value other than a number...
|
|
33
|
-
{
|
|
34
|
-
new T( true ); // $ExpectError
|
|
35
|
-
new T( false ); // $ExpectError
|
|
36
|
-
new T( '5' ); // $ExpectError
|
|
37
|
-
new T( [] ); // $ExpectError
|
|
38
|
-
new T( {} ); // $ExpectError
|
|
39
|
-
new T( ( x: number ): number => x ); // $ExpectError
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
// The compiler throws an error if the function is provided an unsupported number of argumemts...
|
|
43
|
-
{
|
|
44
|
-
new T( 1.0, 2.0 ); // $ExpectError
|
|
45
|
-
}
|
/package/lib/{ctor.js → main.js}
RENAMED
|
File without changes
|