https://github.com/stdlib-js/math-strided-special-dcbrt-by
Compute the cube root of each element retrieved from a double-precision floating-point strided array via a callback function.
https://github.com/stdlib-js/math-strided-special-dcbrt-by
array cube dbl double double-precision float64 float64array javascript math mathematics ndarray node node-js nodejs pow power root stdlib strided vector
Last synced: about 2 months ago
JSON representation
Compute the cube root of each element retrieved from a double-precision floating-point strided array via a callback function.
- Host: GitHub
- URL: https://github.com/stdlib-js/math-strided-special-dcbrt-by
- Owner: stdlib-js
- License: apache-2.0
- Created: 2022-12-10T02:35:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-30T04:07:59.000Z (5 months ago)
- Last Synced: 2025-03-02T09:48:50.120Z (3 months ago)
- Topics: array, cube, dbl, double, double-precision, float64, float64array, javascript, math, mathematics, ndarray, node, node-js, nodejs, pow, power, root, stdlib, strided, vector
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.04 MB
- Stars: 1
- 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!
# dcbrtBy
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute the [cube root][@stdlib/math/base/special/cbrt] of each element retrieved from a double-precision floating-point strided array via a callback function.
## Installation
```bash
npm install @stdlib/math-strided-special-dcbrt-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 dcbrtBy = require( '@stdlib/math-strided-special-dcbrt-by' );
```
#### dcbrtBy( N, x, strideX, y, strideY, clbk\[, thisArg] )
Computes the [cube root][@stdlib/math/base/special/cbrt] of each element retrieved from an input double-precision floating-point strided array via a callback function and assigns each result to an element in an output double-precision floating-point strided array.
```javascript
var Float64Array = require( '@stdlib/array-float64' );
function accessor( v ) {
return v;
}
var x = new Float64Array( [ 1.0, 9.0, -27.0, 81.0, -125.0 ] );
var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
dcbrtBy( x.length, x, 1, out, 1, accessor );
// out => [ 1.0, ~2.08, -3.0, ~4.327, -5.0 ]
```
The function accepts the following arguments:
- **N**: number of indexed elements.
- **x**: input [`Float64Array`][@stdlib/array/float64].
- **strideX**: index increment for `x`.
- **y**: output [`Float64Array`][@stdlib/array/float64].
- **strideY**: index increment for `y`.
- **clbk**: callback function.
- **thisArg**: execution context (_optional_).
The invoked callback function is provided four arguments:
- **value**: input array element.
- **idx**: iteration index (zero-based).
- **indices**: input and output array strided indices `[ix, iy]` (computed according to `offset + idx*stride`).
- **arrays**: input and output arrays `[x, y]`.
To set the callback execution context, provide a `thisArg`.
```javascript
var Float64Array = require( '@stdlib/array-float64' );
function accessor( v ) {
this.count += 1;
return v;
}
var context = {
'count': 0
};
var x = new Float64Array( [ 1.0, 9.0, -27.0, 81.0, -125.0 ] );
var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
dcbrtBy( x.length, x, 1, out, 1, accessor, context );
// out => [ 1.0, ~2.08, -3.0, ~4.327, -5.0 ]
var cnt = context.count;
// returns 5
```
The `N` and stride parameters determine which strided array elements 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
var Float64Array = require( '@stdlib/array-float64' );
function accessor( v ) {
return v;
}
var x = new Float64Array( [ 1.0, 9.0, -27.0, 81.0, -125.0, -9.14 ] );
var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
dcbrtBy( 3, x, 2, out, -1, accessor );
// out => [ -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`][@stdlib/array/float64] 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 out0 = 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 out1 = new Float64Array( out0.buffer, out0.BYTES_PER_ELEMENT*3 ); // start at 4th element
dcbrtBy( 3, x1, -2, out1, 1, accessor );
// out0 => [ 0.0, 0.0, 0.0, ~-2.091, ~4.327, ~2.08 ]
```
#### dcbrtBy.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 double-precision floating-point strided array via a callback function and assigns each result to an element in an output double-precision floating-point strided array using alternative indexing semantics.
```javascript
var Float64Array = require( '@stdlib/array-float64' );
function accessor( v ) {
return v;
}
var x = new Float64Array( [ 1.0, 9.0, -27.0, 81.0, -125.0 ] );
var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
dcbrtBy.ndarray( x.length, x, 1, 0, out, 1, 0, accessor );
// out => [ 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`][@stdlib/array/float64] views mandate a view offset based on the underlying `buffer`, the offset 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
var Float64Array = require( '@stdlib/array-float64' );
function accessor( v ) {
return v;
}
var x = new Float64Array( [ 1.0, 9.0, -27.0, 81.0, -125.0, -9.14 ] );
var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
dcbrtBy.ndarray( 3, x, 2, 1, out, -1, out.length-1, accessor );
// out => [ 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
var Float64Array = require( '@stdlib/array-float64' );
function accessor() {
// No-op...
}
var x = new Float64Array( [ 1.0, 9.0, -27.0, 81.0, -125.0 ] );
var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
dcbrtBy( x.length, x, 1, out, 1, accessor );
// out => [ 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 dcbrtBy = require( '@stdlib/math-strided-special-dcbrt-by' );
function accessor( v, i ) {
if ( (i%3) === 0 ) {
// Simulate a "missing" value...
return;
}
return v;
}
var x = filledarrayBy( 10, 'float64', uniform( -10.0, 10.0 ) );
console.log( x );
var out = filledarray( null, 10, 'float64' );
console.log( out );
dcbrtBy.ndarray( x.length, x, 1, 0, out, -1, out.length-1, accessor );
console.log( out );
```
* * *
## See Also
- [`@stdlib/math-strided/special/cbrt`][@stdlib/math/strided/special/cbrt]: compute the cube root of each element in a strided array.
* * *
## 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/math-strided-special-dcbrt-by.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-strided-special-dcbrt-by
[test-image]: https://github.com/stdlib-js/math-strided-special-dcbrt-by/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/math-strided-special-dcbrt-by/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-strided-special-dcbrt-by/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-strided-special-dcbrt-by?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/math-strided-special-dcbrt-by/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-strided-special-dcbrt-by/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-strided-special-dcbrt-by/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-strided-special-dcbrt-by/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-strided-special-dcbrt-by/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-strided-special-dcbrt-by/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-strided-special-dcbrt-by/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-strided-special-dcbrt-by/main/LICENSE
[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64
[@stdlib/math/base/special/cbrt]: https://github.com/stdlib-js/math-base-special-cbrt
[@stdlib/math/strided/special/cbrt]: https://github.com/stdlib-js/math-strided-special-cbrt