From 11630c55e06313da23107d7a8180892fadf7ddb5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 23 Sep 2023 03:21:40 +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 | 10 +++++----- 10 files changed, 69 insertions(+), 24 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 6e4549c..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-08-01T03:10:28.498Z 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 c028b30..f8bde6d 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!

+
+ # Standard Deviation [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] @@ -216,8 +227,8 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-triangular-stdev.svg [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-triangular-stdev -[test-image]: https://github.com/stdlib-js/stats-base-dists-triangular-stdev/actions/workflows/test.yml/badge.svg?branch=main -[test-url]: https://github.com/stdlib-js/stats-base-dists-triangular-stdev/actions/workflows/test.yml?query=branch:main +[test-image]: https://github.com/stdlib-js/stats-base-dists-triangular-stdev/actions/workflows/test.yml/badge.svg?branch=v0.1.0 +[test-url]: https://github.com/stdlib-js/stats-base-dists-triangular-stdev/actions/workflows/test.yml?query=branch:v0.1.0 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-triangular-stdev/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-triangular-stdev?branch=main diff --git a/dist/index.d.ts b/dist/index.d.ts new file mode 100644 index 0000000..3b0036a --- /dev/null +++ b/dist/index.d.ts @@ -0,0 +1,3 @@ +/// +import stdev from '../docs/types/index'; +export = stdev; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js new file mode 100644 index 0000000..3386439 --- /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 u=n(function(p,s){ +var i=require('@stdlib/math-base-assert-is-nan/dist'),q=require('@stdlib/math-base-special-sqrt/dist');function v(e,r,t){return i(e)||i(r)||i(t)||!(e<=t&&t<=r)?NaN:q((e*e+r*r+t*t-e*r-e*t-r*t)/18)}s.exports=v +});var o=u();module.exports=o; +/** @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..d5b58f6 --- /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 isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar sqrt = require( '@stdlib/math-base-special-sqrt' );\n\n\n// MAIN //\n\n/**\n* Returns the standard deviation of a triangular distribution.\n*\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @returns {PositiveNumber} standard deviation\n*\n* @example\n* var v = stdev( 0.0, 1.0, 0.5 );\n* // returns ~0.204\n*\n* @example\n* var v = stdev( 4.0, 12.0, 9.0 );\n* // returns ~1.65\n*\n* @example\n* var v = stdev( -4.0, 4.0, -1.0 );\n* // returns ~1.65\n*\n* @example\n* var v = stdev( 1.0, -0.1, 0.5 );\n* // returns NaN\n*\n* @example\n* var v = stdev( 0.0, 1.0, 2.0 );\n* // returns NaN\n*\n* @example\n* var v = stdev( NaN, 4.0, 2.0 );\n* // returns NaN\n*\n* @example\n* var v = stdev( 0.0, NaN, 2.0 );\n* // returns NaN\n*\n* @example\n* var v = stdev( 0.0, 4.0, NaN );\n* // returns NaN\n*/\nfunction stdev( a, b, c ) {\n\tif (\n\t\tisnan( a ) ||\n\t\tisnan( b ) ||\n\t\tisnan( c ) ||\n\t\t!( a <= c && c <= b )\n\t) {\n\t\treturn NaN;\n\t}\n\treturn sqrt( ( (a*a) + (b*b) + (c*c) - (a*b) - (a*c) - (b*c) ) / 18.0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = stdev;\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* Triangular distribution standard deviation.\n*\n* @module @stdlib/stats-base-dists-triangular-stdev\n*\n* @example\n* var stdev = require( '@stdlib/stats-base-dists-triangular-stdev' );\n*\n* var v = stdev( 0.0, 1.0, 0.5 );\n* // returns ~0.205\n*\n* v = stdev( 4.0, 12.0, 5.0 );\n* // returns ~1.78\n*\n* v = stdev( 2.0, 8.0, 7.0 );\n* // returns ~1.312\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,EAAQ,QAAS,iCAAkC,EACnDC,EAAO,QAAS,gCAAiC,EA6CrD,SAASC,EAAOC,EAAGC,EAAGC,EAAI,CACzB,OACCL,EAAOG,CAAE,GACTH,EAAOI,CAAE,GACTJ,EAAOK,CAAE,GACT,EAAGF,GAAKE,GAAKA,GAAKD,GAEX,IAEDH,GAASE,EAAEA,EAAMC,EAAEA,EAAMC,EAAEA,EAAMF,EAAEC,EAAMD,EAAEE,EAAMD,EAAEC,GAAO,EAAK,CACvE,CAKAN,EAAO,QAAUG,IC3CjB,IAAII,EAAO,IAKX,OAAO,QAAUA", + "names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "sqrt", "stdev", "a", "b", "c", "main"] +} diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index 4488216..cfc279b 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 standard deviation of a triangular distribution. diff --git a/package.json b/package.json index 5312ce8..b0d1201 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@stdlib/stats-base-dists-triangular-stdev", - "version": "0.0.8", + "version": "0.1.0", "description": "Triangular distribution standard deviation.", "license": "Apache-2.0", "author": { @@ -37,12 +37,12 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/math-base-special-sqrt": "^0.0.8" + "@stdlib/math-base-assert-is-nan": "^0.1.0", + "@stdlib/math-base-special-sqrt": "^0.1.0" }, "devDependencies": { - "@stdlib/bench": "^0.0.12", - "@stdlib/constants-float64-eps": "^0.0.8", + "@stdlib/bench": "^0.1.0", + "@stdlib/constants-float64-eps": "^0.1.0", "@stdlib/math-base-special-abs": "^0.0.6", "@stdlib/random-base-randu": "^0.0.8", "tape": "git+https://github.com/kgryte/tape.git#fix/globby",