Skip to content

Constructor for applying a unary function to each element in an input array.

License

Notifications You must be signed in to change notification settings

stdlib-js/math-array-tools-unary

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 Build Status Coverage Status

Constructor for applying a unary function to each element in an input array.

Usage

import Unary from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-array-tools-unary@deno/mod.js';

Unary( fcn, idtypes, odtypes, policy )

Constructor for applying a unary function to each element in an input array.

import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@deno/mod.js';

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.

import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@deno/mod.js';

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.

import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@deno/mod.js';

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 <Float64Array>[ 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.

import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@deno/mod.js';
import zeros from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-zeros@deno/mod.js';

var dtypes = [ 'float64', 'float32', 'generic' ];
var policy = 'same';

var unary = new Unary( abs, dtypes, dtypes, policy );

var out = zeros( 4, 'float64' );
// returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0 ]

var v = unary.assign( [ -1.0, 2.0, -3.0, 4.0 ], out );
// returns <Float64Array>[ 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.

Examples

import base from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-sin@deno/mod.js';
import uniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-uniform@deno/mod.js';
import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@deno/mod.js';
import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@deno/mod.js';
import logEach from 'https://cdn.jsdelivr.net/gh/stdlib-js/console-log-each@deno/mod.js';
import Unary from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-array-tools-unary@deno/mod.js';

// 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, a standard library 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, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.

Releases

No releases published

Packages

No packages published