Data

Tools

Indexes

Applications

Experiments

Open Source Science

utils-group-in

Group an object's own and inherited property values according to an indicator function.

https://github.com/stdlib-js/utils-group-in

Science Score: 44.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
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.9%) to scientific vocabulary

Keywords

aggregate for-in group group-by groupby in javascript node node-js nodejs obj object partition split stdlib util utilities utility utils
Last synced: 4 months ago · JSON representation ·

Repository

Group an object's own and inherited property values according to an indicator function.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
aggregate for-in group group-by groupby in javascript node node-js nodejs obj object partition split stdlib util utilities utility utils
Created over 4 years ago · Last pushed 10 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!

groupIn

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

Group an object's own and inherited property values according to an indicator function.

## Installation ```bash npm install @stdlib/utils-group-in ``` 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 groupIn = require( '@stdlib/utils-group-in' ); ``` #### groupIn( obj, \[options,] indicator ) Groups an object's **own** and **inherited** property values according to an `indicator` function, which specifies which group a value in the input `object` belongs to. ```javascript function indicator( v ) { return v[ 0 ]; } function Foo() { this.a = 'beep'; this.b = 'boop'; return this; } Foo.prototype = Object.create( null ); Foo.prototype.c = 'foo'; Foo.prototype.d = 'bar'; var obj = new Foo(); var out = groupIn( obj, indicator ); // e.g., returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] } ``` An `indicator` function is provided two arguments: - **value**: object value. - **key**: object index. ```javascript function indicator( v, k ) { console.log( '%s: %s', k, v ); return v[ 0 ]; } function Foo() { this.a = 'beep'; this.b = 'boop'; return this; } Foo.prototype = Object.create( null ); Foo.prototype.c = 'foo'; Foo.prototype.d = 'bar'; var obj = new Foo(); var out = groupIn( obj, indicator ); // e.g., returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] } ``` The function accepts the following `options`: - **returns**: specifies the output format. If the option equals `'values'`, the function outputs values. If the option equals `'keys'`, the function outputs keys. If the option equals `'*'`, the function outputs both keys and values. Default: `'values'`. - **thisArg**: execution context. By default, the function returns object values. To return object keys, set the `returns` option to `'keys'`. ```javascript function indicator( v ) { return v[ 0 ]; } function Foo() { this.a = 'beep'; this.b = 'boop'; return this; } Foo.prototype = Object.create( null ); Foo.prototype.c = 'foo'; Foo.prototype.d = 'bar'; var obj = new Foo(); var opts = { 'returns': 'keys' }; var out = groupIn( obj, opts, indicator ); // e.g., returns { 'b': [ 'a', 'b', 'd' ], 'f': [ 'c' ] } ``` To return key-value pairs, set the `returns` option to `'*'`. ```javascript function indicator( v ) { return v[ 0 ]; } function Foo() { this.a = 'beep'; this.b = 'boop'; return this; } Foo.prototype = Object.create( null ); Foo.prototype.c = 'foo'; Foo.prototype.d = 'bar'; var obj = new Foo(); var opts = { 'returns': '*' }; var out = groupIn( obj, opts, indicator ); // e.g., returns { 'b': [ [ 'a', 'beep' ], [ 'b', 'boop ], [ 'd', 'bar' ] ], 'f': [ [ 'c', 'foo' ] ] } ``` To set the `indicator` execution context, provide a `thisArg`. ```javascript function indicator( v ) { this.count += 1; return v[ 0 ]; } function Foo() { this.a = 'beep'; this.b = 'boop'; return this; } Foo.prototype = Object.create( null ); Foo.prototype.c = 'foo'; Foo.prototype.d = 'bar'; var obj = new Foo(); var context = { 'count': 0 }; var opts = { 'thisArg': context }; var out = groupIn( obj, opts, indicator ); // e.g., returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] } console.log( context.count ); // => 4 ```
## Notes - Iteration order is **not** guaranteed, as `object` key enumeration is not specified according to the [ECMAScript specification][ecma-262-for-in]. In practice, however, most engines use insertion order to sort an `object`'s keys, thus allowing for deterministic iteration. - Because iteration order is **not** guaranteed, result order is **not** guaranteed. - The function determines the list of own **and** inherited enumerable properties **before** invoking the provided function. Hence, any modifications made to the input `object` **after** calling this function (such as adding and removing properties) will **not** affect the list of visited properties. - The value returned by an `indicator` function should be a value which can be serialized as an `object` key. As a counterexample, ```javascript function indicator( v ) { return {}; } function Foo() { this.a = 'beep'; this.b = 'boop'; return this; } Foo.prototype = Object.create( null ); Foo.prototype.c = 'foo'; Foo.prototype.d = 'bar'; var obj = new Foo(); var out = groupIn( obj, indicator ); // e.g., returns { '[object Object]': [ 'beep', 'boop', 'foo', 'bar' ] } ``` while each group identifier is unique, all object values resolve to the same group because each group identifier serializes to the same `string`.
## Examples ```javascript var randu = require( '@stdlib/random-base-randu' ); var fromCodePoint = require( '@stdlib/string-from-code-point' ); var groupIn = require( '@stdlib/utils-group-in' ); var key; var obj; var out; var i; function Foo() { var key; var i; for ( i = 0; i < 50; i++ ) { key = fromCodePoint( 147+i ); this[ key ] = randu(); } return this; } Foo.prototype = Object.create( null ); for ( i = 0; i < 50; i++ ) { key = fromCodePoint( 97+i ); Foo.prototype[ key ] = randu(); } // Generate a random object: obj = new Foo(); // Compute the groups... function indicator( v ) { if ( v < 0.5 ) { return 'low'; } return 'high'; } out = groupIn( obj, indicator ); console.log( out ); ```
* * * ## See Also - [`@stdlib/utils-bifurcate-in`][@stdlib/utils/bifurcate-in]: split an object's own and inherited property values into two groups according to a predicate function. - [`@stdlib/utils-group-by`][@stdlib/utils/group-by]: group values according to an indicator function. - [`@stdlib/utils-group-own`][@stdlib/utils/group-own]: group an object's own property values according to an indicator function.
* * * ## 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: 18
Last Year
  • Push event: 18

Committers

Last synced: 6 months ago

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

Issues and Pull Requests

Last synced: 6 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

Dependencies

package.json npm
  • @stdlib/bench ^0.0.x development
  • @stdlib/math-base-special-floor ^0.0.x development
  • @stdlib/random-base-randu ^0.0.x development
  • @stdlib/string-from-code-point ^0.0.x development
  • @stdlib/utils-noop ^0.0.x development
  • istanbul ^0.4.1 development
  • tap-spec 5.x.x development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/assert-has-own-property ^0.0.x
  • @stdlib/assert-is-function ^0.0.x
  • @stdlib/assert-is-object-like ^0.0.x
  • @stdlib/assert-is-plain-object ^0.0.x
  • @stdlib/string-format ^0.0.x
  • @stdlib/utils-index-of ^0.0.x
.github/workflows/benchmark.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request v3 composite
.github/workflows/examples.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/upload-artifact v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/productionize.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • JS-DevTools/npm-publish v1 composite
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/test.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/test_bundles.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • denoland/setup-deno v1 composite
.github/workflows/test_coverage.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • codecov/codecov-action v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/test_install.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite