{"id":26468658,"url":"https://github.com/stdlib-js/math-array-tools-unary-factory","last_synced_at":"2025-03-19T16:14:49.086Z","repository":{"id":282863273,"uuid":"938051943","full_name":"stdlib-js/math-array-tools-unary-factory","owner":"stdlib-js","description":"Create a function for applying a unary function to each element in a provided array.","archived":false,"fork":false,"pushed_at":"2025-03-17T10:06:33.000Z","size":484,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-17T11:26:06.733Z","etag":null,"topics":["apply","array","element-wise","elementwise","factory","fcn","func","function","javascript","math","mathematics","node","node-js","nodejs","stdlib","vector"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2025-02-24T10:47:29.000Z","updated_at":"2025-03-17T10:05:45.000Z","dependencies_parsed_at":"2025-03-17T11:26:28.050Z","dependency_job_id":"12717ea1-7fb9-4abd-bfba-49c0fdfd486b","html_url":"https://github.com/stdlib-js/math-array-tools-unary-factory","commit_stats":null,"previous_names":["stdlib-js/math-array-tools-unary-factory"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fmath-array-tools-unary-factory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fmath-array-tools-unary-factory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fmath-array-tools-unary-factory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fmath-array-tools-unary-factory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/math-array-tools-unary-factory/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244460247,"owners_count":20456301,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apply","array","element-wise","elementwise","factory","fcn","func","function","javascript","math","mathematics","node","node-js","nodejs","stdlib","vector"],"created_at":"2025-03-19T16:14:48.470Z","updated_at":"2025-03-19T16:14:49.064Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2025 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# factory\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Create a function for applying a unary function to each element in an input array.\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/math-array-tools-unary-factory\n```\n\nAlternatively,\n\n-   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]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   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]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo 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.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar factory = require( '@stdlib/math-array-tools-unary-factory' );\n```\n\n#### factory( fcn, idtypes, odtypes, policy )\n\nReturns a function for applying a unary function to each element in an input array.\n\n```javascript\nvar abs = require( '@stdlib/math-base-special-abs' );\n\nvar dtypes = [ 'float64', 'float32', 'generic' ];\nvar policy = 'same';\n\nvar unary = factory( abs, dtypes, dtypes, policy );\n```\n\nThe constructor has the following parameters:\n\n-   **fcn**: unary function to apply.\n-   **idtypes**: list of supported input data types.\n-   **odtypes**: list of supported input data types.\n-   **policy**: output data type policy.\n\n#### unary( x\\[, options] )\n\nApplies a unary function to each element in a provided input array.\n\n```javascript\nvar abs = require( '@stdlib/math-base-special-abs' );\n\nvar dtypes = [ 'float64', 'float32', 'generic' ];\nvar policy = 'same';\n\nvar unary = factory( abs, dtypes, dtypes, policy );\n\nvar v = unary( [ -1.0, 2.0, -3.0, 4.0 ] );\n// returns [ 1.0, 2.0, 3.0, 4.0 ]\n```\n\nThe function has the following parameters:\n\n-   **x**: input array.\n-   **options**: function options.\n\nThe function accepts the following options:\n\n-   **dtype**: output array data type. Setting this option, overrides the output data type policy.\n\nBy default, the function returns an array having a data type determined by the output data type policy. To override the default behavior, set the `dtype` option.\n\n```javascript\nvar abs = require( '@stdlib/math-base-special-abs' );\n\nvar dtypes = [ 'float64', 'float32', 'generic' ];\nvar policy = 'same';\n\nvar unary = factory( abs, dtypes, dtypes, policy );\n\nvar v = unary( [ -1.0, 2.0, -3.0, 4.0 ], {\n    'dtype': 'float64'\n});\n// returns \u003cFloat64Array\u003e[ 1.0, 2.0, 3.0, 4.0 ]\n```\n\n#### unary.assign( x, out )\n\nApplies a unary function to each element in a provided input array and assigns results to a provided output array.\n\n```javascript\nvar abs = require( '@stdlib/math-base-special-abs' );\nvar zeros = require( '@stdlib/array-zeros' );\n\nvar dtypes = [ 'float64', 'float32', 'generic' ];\nvar policy = 'same';\n\nvar unary = factory( abs, dtypes, dtypes, policy );\n\nvar out = zeros( 4, 'float64' );\n// returns \u003cFloat64Array\u003e[ 0.0, 0.0, 0.0, 0.0 ]\n\nvar v = unary.assign( [ -1.0, 2.0, -3.0, 4.0 ], out );\n// returns \u003cFloat64Array\u003e[ 1.0, 2.0, 3.0, 4.0 ]\n\nvar bool = ( v === out );\n// returns true\n```\n\nThe method has the following parameters:\n\n-   **x**: input array.\n-   **out**: output array.\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   The output data type policy only applies to the function returned by `factory`. For the `assign` method, the output array is allowed to be any array-like object, including [accessor arrays][@stdlib/array/base/accessor].\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar base = require( '@stdlib/math-base-special-sin' );\nvar uniform = require( '@stdlib/random-array-uniform' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar dtype = require( '@stdlib/array-dtype' );\nvar logEach = require( '@stdlib/console-log-each' );\nvar factory = require( '@stdlib/math-array-tools-unary-factory' );\n\n// Define the supported input and output data types:\nvar idt = dtypes( 'real_and_generic' );\nvar odt = dtypes( 'real_floating_point_and_generic' );\n\n// Define the policy mapping an input data type to an output data type:\nvar policy = 'real_floating_point_and_generic';\n\n// Create an interface for computing the element-wise sine:\nvar sin = factory( base, idt, odt, policy );\n\n// Generate an array of random numbers:\nvar x = uniform( 10, -1.0, 1.0, {\n    'dtype': 'generic'\n});\n\n// Compute the element-wise sine:\nvar y = sin( x );\n\n// Resolve the output array data type:\nvar dt = dtype( y );\nconsole.log( dt );\n\n// Print the results:\nlogEach( 'sin(%0.5f) = %0.5f', x, y );\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2025. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/math-array-tools-unary-factory.svg\n[npm-url]: https://npmjs.org/package/@stdlib/math-array-tools-unary-factory\n\n[test-image]: https://github.com/stdlib-js/math-array-tools-unary-factory/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/math-array-tools-unary-factory/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-array-tools-unary-factory/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/math-array-tools-unary-factory?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/math-array-tools-unary-factory.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/math-array-tools-unary-factory/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/math-array-tools-unary-factory/tree/deno\n[deno-readme]: https://github.com/stdlib-js/math-array-tools-unary-factory/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/math-array-tools-unary-factory/tree/umd\n[umd-readme]: https://github.com/stdlib-js/math-array-tools-unary-factory/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/math-array-tools-unary-factory/tree/esm\n[esm-readme]: https://github.com/stdlib-js/math-array-tools-unary-factory/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/math-array-tools-unary-factory/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-array-tools-unary-factory/main/LICENSE\n\n[@stdlib/array/base/accessor]: https://github.com/stdlib-js/array-base-accessor\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fmath-array-tools-unary-factory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fmath-array-tools-unary-factory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fmath-array-tools-unary-factory/lists"}