Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/stats-base-dsempn

Calculate the standard error of the mean for a double-precision floating-point strided array using a two-pass algorithm.

https://github.com/stdlib-js/stats-base-dsempn

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 6 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.2%) to scientific vocabulary

Keywords

array estimate estimation float64 javascript math mathematics mean node node-js nodejs standard-deviation standard-error standard-error-of-the-mean statistics stats stdlib strided strided-array typed
Last synced: 4 months ago · JSON representation ·

Repository

Calculate the standard error of the mean for a double-precision floating-point strided array using a two-pass algorithm.

Basic Info
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
array estimate estimation float64 javascript math mathematics mean node node-js nodejs standard-deviation standard-error standard-error-of-the-mean statistics stats stdlib strided strided-array typed
Created over 4 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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!

dsempn

NPM version Build Status Coverage Status <!-- dependencies -->

Calculate the standard error of the mean of a double-precision floating-point strided array using a two-pass algorithm.

The [standard error of the mean][standard-error] of a finite size sample of size `n` is given by ```math \sigma_{\bar{x}} = \frac{\sigma}{\sqrt{n}} ``` where `σ` is the population [standard deviation][standard-deviation]. Often in the analysis of data, the true population [standard deviation][standard-deviation] is not known _a priori_ and must be estimated from a sample drawn from the population distribution. In this scenario, one must use a sample [standard deviation][standard-deviation] to compute an estimate for the [standard error of the mean][standard-error] ```math \sigma_{\bar{x}} \approx \frac{s}{\sqrt{n}} ``` where `s` is the sample [standard deviation][standard-deviation].
## Installation ```bash npm install @stdlib/stats-base-dsempn ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage ```javascript var dsempn = require( '@stdlib/stats-base-dsempn' ); ``` #### dsempn( N, correction, x, strideX ) Computes the [standard error of the mean][standard-error] of a double-precision floating-point strided array using a two-pass algorithm. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); var v = dsempn( x.length, 1, x, 1 ); // returns ~1.20185 ``` The function has the following parameters: - **N**: number of indexed elements. - **correction**: degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [standard deviation][standard-deviation] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the [standard deviation][standard-deviation] of a population, setting this parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the corrected sample [standard deviation][standard-deviation], setting this parameter to `1` is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction). - **x**: input [`Float64Array`][@stdlib/array/float64]. - **strideX**: stride length for `x`. The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the [standard error of the mean][standard-error] of every other element in `x`, ```javascript var Float64Array = require( '@stdlib/array-float64' ); var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); var v = dsempn( 4, 1, x, 2 ); // returns 1.25 ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element var v = dsempn( 4, 1, x1, 2 ); // returns 1.25 ``` #### dsempn.ndarray( N, correction, x, strideX, offsetX ) Computes the [standard error of the mean][standard-error] of a double-precision floating-point strided array using a two-pass algorithm and alternative indexing semantics. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); var v = dsempn.ndarray( x.length, 1, x, 1, 0 ); // returns ~1.20185 ``` The function has the following additional parameters: - **offsetX**: starting index for `x`. While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the [standard error of the mean][standard-error] for every other element in `x` starting from the second element ```javascript var Float64Array = require( '@stdlib/array-float64' ); var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); var v = dsempn.ndarray( 4, 1, x, 2, 1 ); // returns 1.25 ```
## Notes - If `N <= 0`, both functions return `NaN`. - If `N - c` is less than or equal to `0` (where `c` corresponds to the provided degrees of freedom adjustment), both functions return `NaN`.
## Examples ```javascript var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var dsempn = require( '@stdlib/stats-base-dsempn' ); var x = discreteUniform( 10, -50, 50, { 'dtype': 'float64' }); console.log( x ); var v = dsempn( x.length, 1, x, 1 ); console.log( v ); ```
## C APIs
### Usage ```c #include "stdlib/stats/base/dsempn.h" ``` #### stdlib_strided_dsempn( N, correction, \*X, strideX ) Computes the [standard error of the mean][standard-error] of a double-precision floating-point strided array using a two-pass algorithm. ```c const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; double v = stdlib_strided_dsempn( 4, 1.0, x, 2 ); // returns ~1.29099 ``` The function accepts the following arguments: - **N**: `[in] CBLAS_INT` number of indexed elements. - **correction**: `[in] double` degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [standard deviation][standard-deviation] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the [standard deviation][standard-deviation] of a population, setting this parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the corrected sample [standard deviation][standard-deviation], setting this parameter to `1` is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction). - **X**: `[in] double*` input array. - **strideX**: `[in] CBLAS_INT` stride length for `X`. ```c double stdlib_strided_dsempn( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX ); ``` #### stdlib_strided_dsempn_ndarray( N, correction, \*X, strideX, offsetX ) Computes the [standard error of the mean][standard-error] of a double-precision floating-point strided array using a two-pass algorithm and alternative indexing semantics. ```c const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; double v = stdlib_strided_dsempn_ndarray( 4, 1.0, x, 2, 0 ); // returns ~1.29099 ``` The function accepts the following arguments: - **N**: `[in] CBLAS_INT` number of indexed elements. - **correction**: `[in] double` degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [standard deviation][standard-deviation] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the [standard deviation][standard-deviation] of a population, setting this parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the corrected sample [standard deviation][standard-deviation], setting this parameter to `1` is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction). - **X**: `[in] double*` input array. - **strideX**: `[in] CBLAS_INT` stride length for `X`. - **offsetX**: `[in] CBLAS_INT` starting index for `X`. ```c double stdlib_strided_dsempn_ndarray( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); ```
### Examples ```c #include "stdlib/stats/base/dsempn.h" #include int main( void ) { // Create a strided array: const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; // Specify the number of elements: const int N = 4; // Specify the stride length: const int strideX = 2; // Compute the arithmetic mean: double v = stdlib_strided_dsempn( N, 1.0, x, strideX ); // Print the result: printf( "dsempn: %lf\n", v ); } ```

## References - Neely, Peter M. 1966. "Comparison of Several Algorithms for Computation of Means, Standard Deviations and Correlation Coefficients." _Communications of the ACM_ 9 (7). Association for Computing Machinery: 496–99. doi:[10.1145/365719.365958][@neely:1966a]. - Schubert, Erich, and Michael Gertz. 2018. "Numerically Stable Parallel Computation of (Co-)Variance." In _Proceedings of the 30th International Conference on Scientific and Statistical Database Management_. New York, NY, USA: Association for Computing Machinery. doi:[10.1145/3221269.3223036][@schubert:2018a].
* * * ## See Also - [`@stdlib/stats-strided/dsem`][@stdlib/stats/strided/dsem]: calculate the standard error of the mean for a double-precision floating-point strided array. - [`@stdlib/stats-strided/dstdevpn`][@stdlib/stats/strided/dstdevpn]: calculate the standard deviation of a double-precision floating-point strided array using a two-pass algorithm.
* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

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

GitHub Events

Total
  • Push event: 48
Last Year
  • Push event: 48

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 56
  • Total Committers: 1
  • Avg Commits per committer: 56.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 16
  • Committers: 1
  • Avg Commits per committer: 16.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 56
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 9 last-month
  • Total dependent packages: 4
  • Total dependent repositories: 2
  • Total versions: 13
  • Total maintainers: 4
npmjs.org: @stdlib/stats-base-dsempn

Calculate the standard error of the mean for a double-precision floating-point strided array using a two-pass algorithm.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 13
  • Dependent Packages: 4
  • Dependent Repositories: 2
  • Downloads: 9 Last month
Rankings
Dependent packages count: 4.5%
Dependent repos count: 7.6%
Average: 11.5%
Stargazers count: 14.5%
Downloads: 15.3%
Forks count: 15.4%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 4 months ago