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 8a874c6..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-08-01T01:57:32.247Z 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 43969b1..5393992 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!

+
+ # Variance [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] @@ -191,8 +202,8 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-rayleigh-variance.svg [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-rayleigh-variance -[test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-variance/actions/workflows/test.yml/badge.svg?branch=main -[test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-variance/actions/workflows/test.yml?query=branch:main +[test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-variance/actions/workflows/test.yml/badge.svg?branch=v0.1.0 +[test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-variance/actions/workflows/test.yml?query=branch:v0.1.0 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-rayleigh-variance/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-rayleigh-variance?branch=main diff --git a/dist/index.d.ts b/dist/index.d.ts new file mode 100644 index 0000000..607d677 --- /dev/null +++ b/dist/index.d.ts @@ -0,0 +1,3 @@ +/// +import variance from '../docs/types/index'; +export = variance; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js new file mode 100644 index 0000000..671ee78 --- /dev/null +++ b/dist/index.js @@ -0,0 +1,5 @@ +"use strict";var u=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var n=u(function(o,t){ +var i=require('@stdlib/math-base-assert-is-nan/dist'),a=require('@stdlib/constants-float64-pi/dist');function c(r){return i(r)||r<0?NaN:(4-a)*r*r/2}t.exports=c +});var s=n();module.exports=s; +/** @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..92044e7 --- /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 PI = require( '@stdlib/constants-float64-pi' );\n\n\n// MAIN //\n\n/**\n* Returns the variance of a Rayleigh distribution.\n*\n* @param {NonNegativeNumber} sigma - scale parameter\n* @returns {NonNegativeNumber} variance\n*\n* @example\n* var v = variance( 9.0 );\n* // returns ~34.765\n*\n* @example\n* var v = variance( 2.0 );\n* // returns ~1.717\n*\n* @example\n* var v = variance( -0.2 );\n* // returns NaN\n*\n* @example\n* var v = variance( NaN );\n* // returns NaN\n*/\nfunction variance( sigma ) {\n\tif ( isnan( sigma ) || sigma < 0 ) {\n\t\treturn NaN;\n\t}\n\treturn ( 4.0-PI ) * sigma*sigma / 2.0;\n}\n\n\n// EXPORTS //\n\nmodule.exports = variance;\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* Rayleigh distribution variance.\n*\n* @module @stdlib/stats-base-dists-rayleigh-variance\n*\n* @example\n* var variance = require( '@stdlib/stats-base-dists-rayleigh-variance' );\n*\n* var v = variance( 11.0 );\n* // returns ~51.934\n*\n* v = variance( 4.5 );\n* // returns ~8.691\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,EAAK,QAAS,8BAA+B,EA2BjD,SAASC,EAAUC,EAAQ,CAC1B,OAAKH,EAAOG,CAAM,GAAKA,EAAQ,EACvB,KAEC,EAAIF,GAAOE,EAAMA,EAAQ,CACnC,CAKAJ,EAAO,QAAUG,ICvBjB,IAAIE,EAAO,IAKX,OAAO,QAAUA", + "names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "PI", "variance", "sigma", "main"] +} diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index 75688b7..b7b1e4c 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 variance of a Rayleigh distribution. diff --git a/package.json b/package.json index 62a6534..b1597fb 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@stdlib/stats-base-dists-rayleigh-variance", - "version": "0.0.8", + "version": "0.1.0", "description": "Rayleigh distribution variance.", "license": "Apache-2.0", "author": { @@ -37,11 +37,11 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/constants-float64-pi": "^0.0.8", - "@stdlib/math-base-assert-is-nan": "^0.0.8" + "@stdlib/constants-float64-pi": "^0.1.0", + "@stdlib/math-base-assert-is-nan": "^0.1.0" }, "devDependencies": { - "@stdlib/bench": "^0.0.12", + "@stdlib/bench": "^0.1.0", "@stdlib/constants-float64-eps": "^0.0.8", "@stdlib/constants-float64-ninf": "^0.0.8", "@stdlib/math-base-special-abs": "^0.0.6",