Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/stats-iter-sumabs2
Compute the sum of squared absolute values for all iterated values.
https://github.com/stdlib-js/stats-iter-sumabs2
abs absolute iterable iterate iterator javascript magnitude math mathematics node node-js nodejs squared statistics stats stdlib sum summation total value
Last synced: 3 days ago
JSON representation
Compute the sum of squared absolute values for all iterated values.
- Host: GitHub
- URL: https://github.com/stdlib-js/stats-iter-sumabs2
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-13T19:29:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T02:55:32.000Z (about 1 month ago)
- Last Synced: 2024-09-26T15:55:15.457Z (7 days ago)
- Topics: abs, absolute, iterable, iterate, iterator, javascript, magnitude, math, mathematics, node, node-js, nodejs, squared, statistics, stats, stdlib, sum, summation, total, value
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 974 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# itersumabs2
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute the sum of squared absolute values for all [iterated][mdn-iterator-protocol] values.
The sum of squared absolute values is defined as
```math
s = \sum_{i=0}^{n-1} x_i^2
```
## Installation
```bash
npm install @stdlib/stats-iter-sumabs2
```
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 itersumabs2 = require( '@stdlib/stats-iter-sumabs2' );
```
#### itersumabs2( iterator )
Computes the sum of squared absolute values for all [iterated][mdn-iterator-protocol] values.
```javascript
var array2iterator = require( '@stdlib/array-to-iterator' );
var arr = array2iterator( [ -1.0, 2.0, -3.0, 4.0 ] );
var s = itersumabs2( arr );
// returns 30.0
```
## Notes
- If an iterated value is non-numeric (including `NaN`), the returned [`iterator`][mdn-iterator-protocol] returns `NaN`. If non-numeric iterated values are possible, you are advised to provide an [`iterator`][mdn-iterator-protocol] which type checks and handles non-numeric values accordingly.
- For iterators which can generate many values or which may output large numbers, care should be taken to prevent overflow.
## Examples
```javascript
var runif = require( '@stdlib/random-iter-uniform' );
var itersumabs2 = require( '@stdlib/stats-iter-sumabs2' );
// Create an iterator for generating uniformly distributed pseudorandom numbers:
var rand = runif( -10.0, 10.0, {
'seed': 1234,
'iter': 100
});
// Compute the sum of squared absolute values:
var s = itersumabs2( rand );
// returns
console.log( 'sumabs2: %d.', s );
```
* * *
## See Also
- [`@stdlib/stats-iter/meanabs2`][@stdlib/stats/iter/meanabs2]: compute the arithmetic mean of squared absolute values for all iterated values.
- [`@stdlib/stats-iter/msumabs2`][@stdlib/stats/iter/msumabs2]: create an iterator which iteratively computes a moving sum of squared absolute values.
- [`@stdlib/stats-iter/sumabs`][@stdlib/stats/iter/sumabs]: compute the sum of absolute values for all iterated values.
* * *
## 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-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-iter-sumabs2.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-iter-sumabs2
[test-image]: https://github.com/stdlib-js/stats-iter-sumabs2/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/stats-iter-sumabs2/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-iter-sumabs2/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-iter-sumabs2?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/stats-iter-sumabs2/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-iter-sumabs2/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-iter-sumabs2/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-iter-sumabs2/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-iter-sumabs2/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-iter-sumabs2/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-iter-sumabs2/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-iter-sumabs2/main/LICENSE
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
[@stdlib/stats/iter/meanabs2]: https://github.com/stdlib-js/stats-iter-meanabs2
[@stdlib/stats/iter/msumabs2]: https://github.com/stdlib-js/stats-iter-msumabs2
[@stdlib/stats/iter/sumabs]: https://github.com/stdlib-js/stats-iter-sumabs