{"id":26119137,"url":"https://github.com/stdlib-js/stats-incr-rss","last_synced_at":"2025-04-13T10:20:54.378Z","repository":{"id":57162751,"uuid":"377223578","full_name":"stdlib-js/stats-incr-rss","owner":"stdlib-js","description":"Compute the residual sum of squares (RSS) incrementally.","archived":false,"fork":false,"pushed_at":"2025-04-07T02:15:23.000Z","size":433,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-12T17:54:13.834Z","etag":null,"topics":["delta","deviation","diff","difference","err","error","incremental","javascript","math","mathematics","node","node-js","nodejs","residuals","rss","sse","ssr","statistics","stats","stdlib"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-06-15T16:14:53.000Z","updated_at":"2025-04-07T01:43:17.000Z","dependencies_parsed_at":"2023-10-05T07:15:29.694Z","dependency_job_id":"27c49159-91e8-43bf-934d-c72259b415f8","html_url":"https://github.com/stdlib-js/stats-incr-rss","commit_stats":{"total_commits":48,"total_committers":1,"mean_commits":48.0,"dds":0.0,"last_synced_commit":"54f6126b16932408df4040f649b1d6206bb631f1"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstats-incr-rss","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstats-incr-rss/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstats-incr-rss/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstats-incr-rss/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/stats-incr-rss/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248696197,"owners_count":21147086,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["delta","deviation","diff","difference","err","error","incremental","javascript","math","mathematics","node","node-js","nodejs","residuals","rss","sse","ssr","statistics","stats","stdlib"],"created_at":"2025-03-10T12:15:42.637Z","updated_at":"2025-04-13T10:20:54.360Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2018 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# incrrss\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Compute the [residual sum of squares][residual-sum-of-squares] (RSS) incrementally.\n\n\u003csection class=\"intro\"\u003e\n\nThe [**residual sum of squares**][residual-sum-of-squares] (also referred to as the **sum of squared residuals** (SSR) and the **sum of squared errors** (SSE)) is defined as\n\n\u003c!-- \u003cequation class=\"equation\" label=\"eq:residual_sum_of_squares\" align=\"center\" raw=\"\\operatorname{RSS} = \\sum_{i=0}^{n-1} (y_i - x_i)^2\" alt=\"Equation for the residual sum of squares.\"\u003e --\u003e\n\n```math\n\\mathop{\\mathrm{RSS}} = \\sum_{i=0}^{n-1} (y_i - x_i)^2\n```\n\n\u003c!-- \u003cdiv class=\"equation\" align=\"center\" data-raw-text=\"\\operatorname{RSS} = \\sum_{i=0}^{n-1} (y_i - x_i)^2\" data-equation=\"eq:residual_sum_of_squares\"\u003e\n    \u003cimg src=\"https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@78799028a150a44d463029bdb62ac870b1c1f9d4/lib/node_modules/@stdlib/stats/incr/rss/docs/img/equation_residual_sum_of_squares.svg\" alt=\"Equation for the residual sum of squares.\"\u003e\n    \u003cbr\u003e\n\u003c/div\u003e --\u003e\n\n\u003c!-- \u003c/equation\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/stats-incr-rss\n```\n\nAlternatively,\n\n-   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]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   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]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo 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.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar incrrss = require( '@stdlib/stats-incr-rss' );\n```\n\n#### incrrss()\n\nReturns an accumulator `function` which incrementally computes the [residual sum of squares][residual-sum-of-squares].\n\n```javascript\nvar accumulator = incrrss();\n```\n\n#### accumulator( \\[x, y] )\n\nIf provided input values `x` and `y`, the accumulator function returns an updated [residual sum of squares][residual-sum-of-squares]. If not provided input values `x` and `y`, the accumulator function returns the current [residual sum of squares][residual-sum-of-squares].\n\n```javascript\nvar accumulator = incrrss();\n\nvar r = accumulator( 2.0, 3.0 );\n// returns 1.0\n\nr = accumulator( -1.0, -4.0 );\n// returns 10.0\n\nr = accumulator( -3.0, 5.0 );\n// returns 74.0\n\nr = accumulator();\n// returns 74.0\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   Input values are **not** type checked. If provided `NaN` or a value which, when used in computations, results in `NaN`, the accumulated value is `NaN` for **all** future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function.\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar randu = require( '@stdlib/random-base-randu' );\nvar incrrss = require( '@stdlib/stats-incr-rss' );\n\nvar accumulator;\nvar v1;\nvar v2;\nvar i;\n\n// Initialize an accumulator:\naccumulator = incrrss();\n\n// For each simulated datum, update the residual sum of squares...\nfor ( i = 0; i \u003c 100; i++ ) {\n    v1 = ( randu()*100.0 ) - 50.0;\n    v2 = ( randu()*100.0 ) - 50.0;\n    accumulator( v1, v2 );\n}\nconsole.log( accumulator() );\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/stats-incr/mrss`][@stdlib/stats/incr/mrss]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecompute a moving residual sum of squares (RSS) incrementally.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/stats-incr/mse`][@stdlib/stats/incr/mse]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecompute the mean squared error (MSE) incrementally.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/stats-incr/rmse`][@stdlib/stats/incr/rmse]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecompute the root mean squared error (RMSE) incrementally.\u003c/span\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2025. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-incr-rss.svg\n[npm-url]: https://npmjs.org/package/@stdlib/stats-incr-rss\n\n[test-image]: https://github.com/stdlib-js/stats-incr-rss/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/stats-incr-rss/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-incr-rss/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/stats-incr-rss?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/stats-incr-rss.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/stats-incr-rss/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/stats-incr-rss/tree/deno\n[deno-readme]: https://github.com/stdlib-js/stats-incr-rss/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/stats-incr-rss/tree/umd\n[umd-readme]: https://github.com/stdlib-js/stats-incr-rss/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/stats-incr-rss/tree/esm\n[esm-readme]: https://github.com/stdlib-js/stats-incr-rss/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/stats-incr-rss/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-incr-rss/main/LICENSE\n\n[residual-sum-of-squares]: https://en.wikipedia.org/wiki/Residual_sum_of_squares\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/stats/incr/mrss]: https://github.com/stdlib-js/stats-incr-mrss\n\n[@stdlib/stats/incr/mse]: https://github.com/stdlib-js/stats-incr-mse\n\n[@stdlib/stats/incr/rmse]: https://github.com/stdlib-js/stats-incr-rmse\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fstats-incr-rss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fstats-incr-rss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fstats-incr-rss/lists"}