Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/ndarray-base-ndarraylike2object

Convert an ndarray-like object to an object likely to have the same "shape".

https://github.com/stdlib-js/ndarray-base-ndarraylike2object

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.4%) to scientific vocabulary

Keywords

array base hidden javascript meta multidimensional ndarray node node-js nodejs objectify shape standardize stdlib types util utilities utility utils
Last synced: 4 months ago · JSON representation ·

Repository

Convert an ndarray-like object to an object likely to have the same "shape".

Basic Info
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
array base hidden javascript meta multidimensional ndarray node node-js nodejs objectify shape standardize stdlib types util utilities utility utils
Created almost 4 years ago · Last pushed 6 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!

ndarraylike2object

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

Convert an ndarray-like object to an object likely to have the same "shape".

## Installation ```bash npm install @stdlib/ndarray-base-ndarraylike2object ``` 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 ndarraylike2object = require( '@stdlib/ndarray-base-ndarraylike2object' ); ``` #### ndarraylike2object( x ) Converts an [`ndarray`][@stdlib/ndarray/ctor]-like object to an object likely to have the same "shape". ```javascript var array = require( '@stdlib/ndarray-array' ); var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] ); var obj = ndarraylike2object( arr ); // returns {...} ```
## Notes - The returned object has the following properties: - **ref**: reference to the original [`ndarray`][@stdlib/ndarray/ctor]-like object. - **dtype**: underlying data type. - **data**: data buffer. - **length**: number of elements. - **shape**: array dimensions. - **strides**: array strides. - **offset**: index offset. - **order**: order. - **accessorProtocol**: `boolean` indicating whether the data buffer supports the get/set protocol (i.e., uses accessors for getting and setting elements). - **accessors**: a two-element array whose first element is an accessor for retrieving an ndarray element and whose second element is an accessor for setting an ndarray element. - The getter accessor accepts two arguments: - **data**: data buffer. - **idx**: element index. - The setter accessor accepts three arguments: - **data**: data buffer. - **idx**: element index. - **value**: value to set. - This function is intended as a potential performance optimization. In V8, for example, even if two objects share common properties, if those properties were added in different orders or if one object has additional properties not shared by the other object, then those objects will have different "hidden" classes. If a function is provided many objects having different "shapes", some JavaScript VMs (e.g., V8) will consider the function "megamorphic" and fail to perform various runtime optimizations. Accordingly, the intent of this function is to standardize the "shape" of the object holding [`ndarray`][@stdlib/ndarray/ctor] meta data to ensure that internal functions operating on ndarrays are provided consistent argument "shapes".
## Examples ```javascript var array = require( '@stdlib/ndarray-array' ); var ndarraylike2object = require( '@stdlib/ndarray-base-ndarraylike2object' ); // Create an ndarray: var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); // Convert to a standardized object: var obj = ndarraylike2object( x ); // returns {...} // Print various properties: console.log( 'dtype: %s', obj.dtype ); console.log( 'ndims: %d', obj.shape.length ); console.log( 'numel: %d', obj.length ); console.log( 'shape: [ %s ]', obj.shape.join( ', ' ) ); console.log( 'strides: [ %s ]', obj.strides.join( ', ' ) ); console.log( 'offset: %d', obj.offset ); console.log( 'order: %s', obj.order ); console.log( 'accessor protocol: %s', obj.accessorProtocol ); ```
* * * ## 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: 17
Last Year
  • Push event: 17

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 33
  • Total Committers: 1
  • Avg Commits per committer: 33.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 33
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: almost 2 years 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 761 last-month
  • Total dependent packages: 14
  • Total dependent repositories: 9
  • Total versions: 5
  • Total maintainers: 4
npmjs.org: @stdlib/ndarray-base-ndarraylike2object

Convert an ndarray-like object to an object likely to have the same "shape".

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 5
  • Dependent Packages: 14
  • Dependent Repositories: 9
  • Downloads: 761 Last month
Rankings
Dependent packages count: 1.6%
Dependent repos count: 3.9%
Downloads: 5.6%
Average: 8.2%
Stargazers count: 14.6%
Forks count: 15.5%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 4 months ago

Dependencies

.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
package.json npm
  • @stdlib/array-complex64 ^0.0.x development
  • @stdlib/array-float64 ^0.0.x development
  • @stdlib/assert-is-collection ^0.0.x development
  • @stdlib/bench ^0.0.x development
  • @stdlib/complex-float32 ^0.0.x development
  • @stdlib/complex-imagf ^0.0.x development
  • @stdlib/complex-realf ^0.0.x development
  • @stdlib/ndarray-array ^0.0.x development
  • @stdlib/ndarray-base-ctor ^0.0.x development
  • @stdlib/ndarray-ctor ^0.0.x development
  • istanbul ^0.4.1 development
  • tap-min 2.x.x development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/array-base-accessor-getter ^0.0.x
  • @stdlib/array-base-accessor-setter ^0.0.x
  • @stdlib/array-base-assert-is-accessor-array ^0.0.x
  • @stdlib/array-base-getter ^0.0.x
  • @stdlib/array-base-setter ^0.0.x
  • @stdlib/ndarray-base-numel ^0.0.x
  • @stdlib/types ^0.0.x