@stdlib/math-strided-special-cbrt-by

Compute the cube root of each element retrieved from an input strided array via a callback function.

https://github.com/stdlib-js/math-strided-special-cbrt-by

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 (14.7%) to scientific vocabulary

Keywords

accessor array callback cube element-wise javascript map math mathematics ndarray node node-js nodejs pow power root stdlib strided transform vector
Last synced: 4 months ago · JSON representation ·

Repository

Compute the cube root of each element retrieved from an input strided array via a callback function.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
accessor array callback cube element-wise javascript map math mathematics ndarray node node-js nodejs pow power root stdlib strided transform vector
Created about 3 years ago · Last pushed 8 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!

cbrtBy

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

Compute the cube root of each element retrieved from an input strided array via a callback function.

## Installation ```bash npm install @stdlib/math-strided-special-cbrt-by ``` 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 cbrtBy = require( '@stdlib/math-strided-special-cbrt-by' ); ``` #### cbrtBy( N, x, strideX, y, strideY, clbk\[, thisArg] ) Computes the [cube root][@stdlib/math/base/special/cbrt] of each element retrieved from an input strided array `x` via a callback function and assigns each result to an element in an output strided array `y`. ```javascript function accessor( v ) { return v; } var x = [ 1.0, 9.0, -27.0, 81.0, -125.0 ]; var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ]; cbrtBy( x.length, x, 1, y, 1, accessor ); // y => [ 1.0, ~2.08, -3.0, ~4.327, -5.0 ] ``` The function accepts the following arguments: - **N**: number of indexed elements. - **x**: input [`Array`][mdn-array], [`typed array`][mdn-typed-array], or an array-like object (excluding strings and functions). - **strideX**: index increment for `x`. - **y**: output [`Array`][mdn-array], [`typed array`][mdn-typed-array], or an array-like object (excluding strings and functions). - **strideY**: index increment for `y`. - **clbk**: callback function. - **thisArg**: execution context (_optional_). The invoked callback function is provided six arguments: - **value**: input array element. - **idx**: iteration index (zero-based). - **xi**: input array strided index (`offsetX + idx*strideX`). - **yi**: output array strided index (`offsetY + idx*strideY`). - **x**: input array/collection. - **y**: output array/collection. To set the callback execution context, provide a `thisArg`. ```javascript function accessor( v ) { this.count += 1; return v; } var context = { 'count': 0 }; var x = [ 1.0, 9.0, -27.0, 81.0, -125.0 ]; var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ]; cbrtBy( x.length, x, 1, y, 1, accessor, context ); // y => [ 1.0, ~2.08, -3.0, ~4.327, -5.0 ] var cnt = context.count; // returns 5 ``` The `N` and `stride` parameters determine which elements in `x` and `y` are accessed at runtime. For example, to index every other value in `x` and to index the first `N` elements of `y` in reverse order, ```javascript function accessor( v ) { return v; } var x = [ 1.0, 9.0, -27.0, 81.0, -125.0, -9.14 ]; var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]; cbrtBy( 3, x, 2, y, -1, accessor ); // y => [ -5.0, -3.0, 1.0, 0.0, 0.0, 0.0 ] ``` 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' ); function accessor( v ) { return v; } // Initial arrays... var x0 = new Float64Array( [ 1.0, 9.0, -27.0, 81.0, -125.0, -9.14 ] ); var y0 = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); // Create offset views... var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element cbrtBy( 3, x1, -2, y1, 1, accessor ); // y0 => [ 0.0, 0.0, 0.0, ~-2.091, ~4.327, ~2.08 ] ``` #### cbrtBy.ndarray( N, x, strideX, offsetX, y, strideY, offsetY, clbk\[, thisArg] ) Computes the [cube root][@stdlib/math/base/special/cbrt] of each element retrieved from an input strided array `x` via a callback function and assigns each result to an element in an output strided array `y` using alternative indexing semantics. ```javascript function accessor( v ) { return v; } var x = [ 1.0, 9.0, -27.0, 81.0, -125.0 ]; var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ]; cbrtBy.ndarray( x.length, x, 1, 0, y, 1, 0, accessor ); // y => [ 1.0, ~2.08, -3.0, ~4.327, -5.0 ] ``` The function accepts the following additional arguments: - **offsetX**: starting index for `x`. - **offsetY**: starting index for `y`. While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offsetX` and `offsetY` parameters support indexing semantics based on starting indices. For example, to index every other value in `x` starting from the second value and to index the last `N` elements in `y`, ```javascript function accessor( v ) { return v; } var x = [ 1.0, 9.0, -27.0, 81.0, -125.0, -9.14 ]; var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]; cbrtBy.ndarray( 3, x, 2, 1, y, -1, y.length-1, accessor ); // y => [ 0.0, 0.0, 0.0, ~-2.091, ~4.327, ~2.08 ] ```
## Notes - If a provided callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is **ignored**. ```javascript function accessor() { // No-op... } var x = [ 1.0, 9.0, -27.0, 81.0, -125.0 ]; var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ]; cbrtBy( x.length, x, 1, y, 1, accessor ); // y => [ 0.0, 0.0, 0.0, 0.0, 0.0 ] ```
## Examples ```javascript var uniform = require( '@stdlib/random-base-uniform' ).factory; var filledarray = require( '@stdlib/array-filled' ); var filledarrayBy = require( '@stdlib/array-filled-by' ); var cbrtBy = require( '@stdlib/math-strided-special-cbrt-by' ); function accessor( v, i ) { if ( (i%3) === 0 ) { // Simulate a "missing" value... return; } return v; } var x = filledarrayBy( 10, 'generic', uniform( -10.0, 10.0 ) ); console.log( x ); var y = filledarray( null, 10, 'generic' ); console.log( y ); cbrtBy.ndarray( x.length, x, 1, 0, y, -1, y.length-1, accessor ); console.log( y ); ```
* * * ## 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: 4
Last Year
  • Push event: 4

Committers

Last synced: about 1 year ago

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

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
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 4 last-month
  • Total dependent packages: 2
  • Total dependent repositories: 2
  • Total versions: 5
  • Total maintainers: 4
npmjs.org: @stdlib/math-strided-special-cbrt-by

Compute the cube root of each element retrieved from an input strided array via a callback function.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 5
  • Dependent Packages: 2
  • Dependent Repositories: 2
  • Downloads: 4 Last month
Rankings
Dependent repos count: 7.6%
Dependent packages count: 8.8%
Average: 12.7%
Downloads: 14.9%
Forks count: 15.4%
Stargazers count: 16.7%
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-filled ^0.0.x development
  • @stdlib/array-filled-by ^0.0.x development
  • @stdlib/array-float64 ^0.0.x development
  • @stdlib/bench ^0.0.x development
  • @stdlib/math-base-assert-is-nan ^0.0.x development
  • @stdlib/math-base-special-pow ^0.0.x development
  • @stdlib/random-base-uniform ^0.0.x development
  • istanbul ^0.4.1 development
  • tap-min git+https://github.com/Planeshifter/tap-min.git development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/math-base-special-cbrt ^0.0.x
  • @stdlib/strided-base-map-by ^0.0.x
  • @stdlib/types ^0.0.x
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.0.x