From 816434d2d2283eefe4941be052dc94a405d04984 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 03:19:02 +0000 Subject: [PATCH] Release v0.1.0 --- .editorconfig | 5 +++++ .github/.keepalive | 1 - .github/workflows/productionize.yml | 15 --------------- CITATION.cff | 30 +++++++++++++++++++++++++++++ README.md | 15 +++++++++++++-- dist/index.d.ts | 3 +++ dist/index.js | 5 +++++ dist/index.js.map | 7 +++++++ docs/types/index.d.ts | 2 +- package.json | 16 +++++++-------- 10 files changed, 72 insertions(+), 27 deletions(-) delete mode 100644 .github/.keepalive create mode 100644 CITATION.cff create mode 100644 dist/index.d.ts create mode 100644 dist/index.js create mode 100644 dist/index.js.map diff --git a/.editorconfig b/.editorconfig index 0fd4d6c..13e9c39 100644 --- a/.editorconfig +++ b/.editorconfig @@ -179,3 +179,8 @@ indent_size = 2 [*.gypi] indent_style = space indent_size = 2 + +# Set properties for citation files: +[*.{cff,cff.txt}] +indent_style = space +indent_size = 2 diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 6b69457..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-08-01T06:10:53.593Z diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml index 334eb59..91f2b93 100644 --- a/.github/workflows/productionize.yml +++ b/.github/workflows/productionize.yml @@ -82,21 +82,6 @@ jobs: id: transform-error-messages uses: stdlib-js/transform-errors-action@main - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - name: 'Update dependencies in package.json' run: | diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..2ec6fff --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,30 @@ +cff-version: 1.2.0 +title: stdlib +message: >- + If you use this software, please cite it using the + metadata from this file. + +type: software + +authors: + - name: The Stdlib Authors + url: https://github.com/stdlib-js/stdlib/graphs/contributors + +repository-code: https://github.com/stdlib-js/stdlib +url: https://stdlib.io + +abstract: | + Standard library for JavaScript and Node.js. + +keywords: + - JavaScript + - Node.js + - TypeScript + - standard library + - scientific computing + - numerical computing + - statistical computing + +license: Apache-2.0 AND BSL-1.0 + +date-released: 2016 diff --git a/README.md b/README.md index 9a815c0..d02cdba 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,17 @@ limitations under the License. --> + +
+ + About stdlib... + +

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.

+

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.

+

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.

+

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

+
+ # Kurtosis [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] @@ -222,8 +233,8 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-f-kurtosis.svg [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-f-kurtosis -[test-image]: https://github.com/stdlib-js/stats-base-dists-f-kurtosis/actions/workflows/test.yml/badge.svg?branch=main -[test-url]: https://github.com/stdlib-js/stats-base-dists-f-kurtosis/actions/workflows/test.yml?query=branch:main +[test-image]: https://github.com/stdlib-js/stats-base-dists-f-kurtosis/actions/workflows/test.yml/badge.svg?branch=v0.1.0 +[test-url]: https://github.com/stdlib-js/stats-base-dists-f-kurtosis/actions/workflows/test.yml?query=branch:v0.1.0 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-f-kurtosis/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-f-kurtosis?branch=main diff --git a/dist/index.d.ts b/dist/index.d.ts new file mode 100644 index 0000000..c7b80a1 --- /dev/null +++ b/dist/index.d.ts @@ -0,0 +1,3 @@ +/// +import kurtosis from '../docs/types/index'; +export = kurtosis; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js new file mode 100644 index 0000000..35e3b12 --- /dev/null +++ b/dist/index.js @@ -0,0 +1,5 @@ +"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=n(function(m,i){ +var a=require('@stdlib/math-base-special-pow/dist');function o(e,r){var t,u;return e<=0||r<=8?NaN:(u=e*(5*r-22)*(e+r-2)+(r-4)*a(r-2,2),t=e*(r-6)*(r-8)*(e+r-2),12*u/t)}i.exports=o +});var v=s();module.exports=v; +/** @license Apache-2.0 */ +//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map new file mode 100644 index 0000000..93a19d0 --- /dev/null +++ b/dist/index.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["../lib/main.js", "../lib/index.js"], + "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 pow = require( '@stdlib/math-base-special-pow' );\n\n\n// MAIN //\n\n/**\n* Returns the excess kurtosis of an F distribution.\n*\n* @param {PositiveNumber} d1 - numerator degrees of freedom\n* @param {PositiveNumber} d2 - denominator degrees of freedom\n* @returns {PositiveNumber} kurtosis\n*\n* @example\n* var v = kurtosis( 3.0, 9.0 );\n* // returns ~124.667\n*\n* @example\n* var v = kurtosis( 4.0, 12.0 );\n* // returns ~26.143\n*\n* @example\n* var v = kurtosis( 8.0, 9.0 );\n* // returns ~100.167\n*\n* @example\n* var v = kurtosis( 1.0, 8.0 );\n* // returns NaN\n*\n* @example\n* var v = kurtosis( 1.0, -0.1 );\n* // returns NaN\n*\n* @example\n* var v = kurtosis( -0.1, 1.0 );\n* // returns NaN\n*\n* @example\n* var v = kurtosis( 2.0, NaN );\n* // returns NaN\n*\n* @example\n* var v = kurtosis( NaN, 2.0 );\n* // returns NaN\n*/\nfunction kurtosis( d1, d2 ) {\n\tvar denom;\n\tvar num;\n\n\tif ( d1 <= 0.0 || d2 <= 8.0 ) {\n\t\treturn NaN;\n\t}\n\tnum = ( d1 * ( ( 5.0*d2 ) - 22.0 ) * ( d1+d2-2.0 ) ) +\n\t\t( ( d2-4.0 ) * pow( d2-2.0, 2.0 ) );\n\tdenom = d1 * ( d2-6.0 ) * ( d2-8.0 ) * ( d1+d2-2.0 );\n\treturn 12.0 * num / denom;\n}\n\n\n// EXPORTS //\n\nmodule.exports = kurtosis;\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* F distribution excess kurtosis.\n*\n* @module @stdlib/stats-base-dists-f-kurtosis\n*\n* @example\n* var kurtosis = require( '@stdlib/stats-base-dists-f-kurtosis' );\n*\n* var v = kurtosis( 3.0, 9.0 );\n* // returns ~124.667\n*\n* v = kurtosis( 4.0, 12.0 );\n* // returns ~26.143\n*\n* v = kurtosis( 8.0, 9.0 );\n* // returns ~100.167\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], + "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAM,QAAS,+BAAgC,EA4CnD,SAASC,EAAUC,EAAIC,EAAK,CAC3B,IAAIC,EACAC,EAEJ,OAAKH,GAAM,GAAOC,GAAM,EAChB,KAERE,EAAQH,GAAS,EAAIC,EAAO,KAAWD,EAAGC,EAAG,IACxCA,EAAG,GAAQH,EAAKG,EAAG,EAAK,CAAI,EACjCC,EAAQF,GAAOC,EAAG,IAAUA,EAAG,IAAUD,EAAGC,EAAG,GACxC,GAAOE,EAAMD,EACrB,CAKAL,EAAO,QAAUE,IC1CjB,IAAIK,EAAO,IAKX,OAAO,QAAUA", + "names": ["require_main", "__commonJSMin", "exports", "module", "pow", "kurtosis", "d1", "d2", "denom", "num", "main"] +} diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index 3b4186d..dd289bc 100644 --- a/docs/types/index.d.ts +++ b/docs/types/index.d.ts @@ -16,7 +16,7 @@ * limitations under the License. */ -// TypeScript Version: 2.0 +// TypeScript Version: 4.1 /** * Returns the excess kurtosis of an F distribution. diff --git a/package.json b/package.json index f36666d..1fba6ab 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@stdlib/stats-base-dists-f-kurtosis", - "version": "0.0.7", + "version": "0.1.0", "description": "F distribution excess kurtosis.", "license": "Apache-2.0", "author": { @@ -37,15 +37,15 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/math-base-special-pow": "^0.0.7" + "@stdlib/math-base-special-pow": "^0.1.0" }, "devDependencies": { - "@stdlib/bench": "^0.0.12", - "@stdlib/constants-float64-eps": "^0.0.8", - "@stdlib/constants-float64-ninf": "^0.0.8", - "@stdlib/constants-float64-pinf": "^0.0.8", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/math-base-special-abs": "^0.0.6", + "@stdlib/bench": "^0.1.0", + "@stdlib/constants-float64-eps": "^0.1.0", + "@stdlib/constants-float64-ninf": "^0.1.0", + "@stdlib/constants-float64-pinf": "^0.1.0", + "@stdlib/math-base-assert-is-nan": "^0.1.0", + "@stdlib/math-base-special-abs": "^0.1.0", "@stdlib/random-base-randu": "^0.0.8", "tape": "git+https://github.com/kgryte/tape.git#fix/globby", "istanbul": "^0.4.1",