https://github.com/stdlib-js/math-array-tools-unary
Constructor for applying a unary function to each element in an input array.
https://github.com/stdlib-js/math-array-tools-unary
apply array call element-wise javascript math mathematics node node-js nodejs stdlib tools vector vectorization vectorized
Last synced: 2 months ago
JSON representation
Constructor for applying a unary function to each element in an input array.
- Host: GitHub
- URL: https://github.com/stdlib-js/math-array-tools-unary
- Owner: stdlib-js
- License: apache-2.0
- Created: 2025-02-24T10:47:43.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-17T10:09:41.000Z (2 months ago)
- Last Synced: 2025-03-17T11:26:17.907Z (2 months ago)
- Topics: apply, array, call, element-wise, javascript, math, mathematics, node, node-js, nodejs, stdlib, tools, vector, vectorization, vectorized
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 479 KB
- Stars: 0
- Watchers: 2
- 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!
# Unary
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Constructor for applying a unary function to each element in an input array.
## Installation
```bash
npm install @stdlib/math-array-tools-unary
```
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 Unary = require( '@stdlib/math-array-tools-unary' );
```
#### Unary( fcn, idtypes, odtypes, policy )
Constructor for applying a unary function to each element in an input array.
```javascript
var abs = require( '@stdlib/math-base-special-abs' );
var dtypes = [ 'float64', 'float32', 'generic' ];
var policy = 'same';
var unary = new Unary( abs, dtypes, dtypes, policy );
```
The constructor has the following parameters:
- **fcn**: unary function to apply.
- **idtypes**: list of supported input data types.
- **odtypes**: list of supported input data types.
- **policy**: output data type policy.
#### Unary.prototype.apply( x\[, options] )
Applies a unary function to each element in a provided input array.
```javascript
var abs = require( '@stdlib/math-base-special-abs' );
var dtypes = [ 'float64', 'float32', 'generic' ];
var policy = 'same';
var unary = new Unary( abs, dtypes, dtypes, policy );
var v = unary.apply( [ -1.0, 2.0, -3.0, 4.0 ] );
// returns [ 1.0, 2.0, 3.0, 4.0 ]
```
The method has the following parameters:
- **x**: input array.
- **options**: function options.
The method accepts the following options:
- **dtype**: output array data type. Setting this option, overrides the output data type policy.
By default, the method returns an array having a data type determined by the output data type policy. To override the default behavior, set the `dtype` option.
```javascript
var abs = require( '@stdlib/math-base-special-abs' );
var dtypes = [ 'float64', 'float32', 'generic' ];
var policy = 'same';
var unary = new Unary( abs, dtypes, dtypes, policy );
var v = unary.apply( [ -1.0, 2.0, -3.0, 4.0 ], {
'dtype': 'float64'
});
// returns [ 1.0, 2.0, 3.0, 4.0 ]
```
#### Unary.prototype.assign( x, out )
Applies a unary function to each element in a provided input array and assigns results to a provided output array.
```javascript
var abs = require( '@stdlib/math-base-special-abs' );
var zeros = require( '@stdlib/array-zeros' );
var dtypes = [ 'float64', 'float32', 'generic' ];
var policy = 'same';
var unary = new Unary( abs, dtypes, dtypes, policy );
var out = zeros( 4, 'float64' );
// returns [ 0.0, 0.0, 0.0, 0.0 ]
var v = unary.assign( [ -1.0, 2.0, -3.0, 4.0 ], out );
// returns [ 1.0, 2.0, 3.0, 4.0 ]
var bool = ( v === out );
// returns true
```
The method has the following parameters:
- **x**: input array.
- **out**: output array.
## Notes
- The output data type policy only applies to the `apply` method. For the `assign` method, the output array is allowed to be any array-like object, including [accessor arrays][@stdlib/array/base/accessor].
## Examples
```javascript
var base = require( '@stdlib/math-base-special-sin' );
var uniform = require( '@stdlib/random-array-uniform' );
var dtypes = require( '@stdlib/array-dtypes' );
var dtype = require( '@stdlib/array-dtype' );
var logEach = require( '@stdlib/console-log-each' );
var Unary = require( '@stdlib/math-array-tools-unary' );
// Define the supported input and output data types:
var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );
// Define the policy mapping an input data type to an output data type:
var policy = 'real_floating_point_and_generic';
// Create an interface for computing the element-wise sine:
var sin = new Unary( base, idt, odt, policy );
// Generate an array of random numbers:
var x = uniform( 10, -1.0, 1.0, {
'dtype': 'generic'
});
// Compute the element-wise sine:
var y = sin.apply( x );
// Resolve the output array data type:
var dt = dtype( y );
console.log( dt );
// Print the results:
logEach( 'sin(%0.5f) = %0.5f', x, 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].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-array-tools-unary.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-array-tools-unary
[test-image]: https://github.com/stdlib-js/math-array-tools-unary/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/math-array-tools-unary/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-array-tools-unary/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-array-tools-unary?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-array-tools-unary/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-array-tools-unary/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-array-tools-unary/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-array-tools-unary/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-array-tools-unary/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-array-tools-unary/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-array-tools-unary/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-array-tools-unary/main/LICENSE
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/array-base-accessor