strided-base-ternary

Apply a ternary callback to strided input array elements and assign results to elements in a strided output array.

https://github.com/stdlib-js/strided-base-ternary

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

Keywords

apply array base foreach javascript map ndarray node node-js nodejs stdlib strided ternary transform
Last synced: 6 months ago · JSON representation ·

Repository

Apply a ternary callback to strided input array elements and assign results to elements in a strided output array.

Basic Info
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
apply array base foreach javascript map ndarray node node-js nodejs stdlib strided ternary transform
Created over 4 years ago · Last pushed 9 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!

Ternary

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

Apply a ternary callback to strided input array elements and assign results to elements in a strided output array.

## Installation ```bash npm install @stdlib/strided-base-ternary ``` 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 ternary = require( '@stdlib/strided-base-ternary' ); ``` #### ternary( arrays, shape, strides, fcn ) Applies a ternary callback to strided input array elements and assigns results to elements in a strided output array. ```javascript var add = require( '@stdlib/number-float64-base-add3' ); var Float64Array = require( '@stdlib/array-float64' ); var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); var w = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] ); ternary( [ x, y, z, w ], [ x.length ], [ 1, 1, 1, 1 ], add ); // w => [ 3.0, 6.0, 9.0, 12.0, 15.0 ] ``` The function accepts the following arguments: - **arrays**: array-like object containing three strided input arrays and one strided output array. - **shape**: array-like object containing a single element, the number of indexed elements. - **strides**: array-like object containing the stride lengths for the strided input and output arrays. - **fcn**: ternary function to apply. The `shape` and `strides` parameters determine which elements in the strided input and output arrays are accessed at runtime. For example, to index every other value in the strided input arrays and to index the first `N` elements of the strided output array in reverse order, ```javascript var add = require( '@stdlib/number-float64-base-add3' ); var Float64Array = require( '@stdlib/array-float64' ); var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); var w = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] ); ternary( [ x, y, z, w ], [ 3 ], [ 2, 2, 2, -1 ], add ); // w => [ 15.0, 9.0, 3.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 add = require( '@stdlib/number-float64-base-add3' ); var Float64Array = require( '@stdlib/array-float64' ); // Initial arrays... var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var y0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var z0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var w0 = 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*1 ); // start at 2nd element var z1 = new Float64Array( z0.buffer, z0.BYTES_PER_ELEMENT*1 ); // start at 2nd element var w1 = new Float64Array( w0.buffer, w0.BYTES_PER_ELEMENT*3 ); // start at 4th element ternary( [ x1, y1, z1, w1 ], [ 3 ], [ -2, -2, -2, 1 ], add ); // w0 => [ 0.0, 0.0, 0.0, 18.0, 12.0, 6.0 ] ``` #### ternary.ndarray( arrays, shape, strides, offsets, fcn ) Applies a ternary callback to strided input array elements and assigns results to elements in a strided output array using alternative indexing semantics. ```javascript var add = require( '@stdlib/number-float64-base-add3' ); var Float64Array = require( '@stdlib/array-float64' ); var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); var w = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] ); ternary.ndarray( [ x, y, z, w ], [ x.length ], [ 1, 1, 1, 1 ], [ 0, 0, 0, 0 ], add ); // w => [ 3.0, 6.0, 9.0, 12.0, 15.0 ] ``` The function accepts the following additional arguments: - **offsets**: array-like object containing the starting indices (i.e., index offsets) for the strided input and output arrays. While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offsets` parameter supports indexing semantics based on starting indices. For example, to index every other value in the strided input arrays starting from the second value and to index the last `N` elements in the strided output array, ```javascript var add = require( '@stdlib/number-float64-base-add3' ); var Float64Array = require( '@stdlib/array-float64' ); var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var w = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); ternary.ndarray( [ x, y, z, w ], [ 3 ], [ 2, 2, 2, -1 ], [ 1, 1, 1, w.length-1 ], add ); // w => [ 0.0, 0.0, 0.0, 18.0, 12.0, 6.0 ] ```
## Examples ```javascript var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; var filledarray = require( '@stdlib/array-filled' ); var filledarrayBy = require( '@stdlib/array-filled-by' ); var add = require( '@stdlib/number-float64-base-add3' ); var ternary = require( '@stdlib/strided-base-ternary' ); var N = 10; var x = filledarrayBy( N, 'generic', discreteUniform( -100, 100 ) ); console.log( x ); var y = filledarrayBy( N, 'generic', discreteUniform( -100, 100 ) ); console.log( y ); var z = filledarrayBy( N, 'generic', discreteUniform( -100, 100 ) ); console.log( z ); var w = filledarray( 0.0, N, 'generic' ); console.log( w ); var shape = [ N ]; var strides = [ 1, 1, 1, -1 ]; var offsets = [ 0, 0, 0, N-1 ]; ternary.ndarray( [ x, y, z, w ], shape, strides, offsets, add ); console.log( w ); ```
* * * ## 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: 13
Last Year
  • Push event: 13

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 76
  • Total Committers: 1
  • Avg Commits per committer: 76.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 8
  • Committers: 1
  • Avg Commits per committer: 8.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 76
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

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

Dependencies

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-floor ^0.0.x development
  • @stdlib/math-base-special-pow ^0.0.x development
  • @stdlib/math-base-special-round ^0.0.x development
  • @stdlib/random-base-discrete-uniform ^0.0.x development
  • @stdlib/random-base-randu ^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/types ^0.0.x
  • @stdlib/utils-define-nonenumerable-read-only-property ^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