@stdlib/math-tools 0.2.1 → 0.3.0

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2026 The Stdlib Authors.

package/README.md

@@ -68,7 +68,7 @@ The namespace exposes the following functions:
 
 <div class="namespace-toc">
 
--   <span class="signature">[`unary( table )`][@stdlib/math/tools/unary]</span><span class="delimiter">: </span><span class="description">multiple dispatch for unary mathematical functions.</span>
+-   <span class="signature">[`unary( fcn, idtypes, odtypes, policies )`][@stdlib/math/tools/unary]</span><span class="delimiter">: </span><span class="description">create a function which performs element-wise computation by applying a unary function to each element in an input ndarray.</span>
 
 </div>
 
@@ -131,7 +131,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -144,8 +144,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/math-tools.svg
 [npm-url]: https://npmjs.org/package/@stdlib/math-tools
 
-[test-image]: https://github.com/stdlib-js/math-tools/actions/workflows/test.yml/badge.svg?branch=v0.2.1
-[test-url]: https://github.com/stdlib-js/math-tools/actions/workflows/test.yml?query=branch:v0.2.1
+[test-image]: https://github.com/stdlib-js/math-tools/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/math-tools/actions/workflows/test.yml?query=branch:v0.3.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-tools/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/math-tools?branch=main
@@ -157,8 +157,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 -->
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
+[chat-url]: https://stdlib.zulipchat.com
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/docs/types/index.d.ts

@@ -27,42 +27,50 @@ import unary = require( '@stdlib/math-tools-unary' );
 */
 interface Namespace {
 	/**
-	* Returns a function which dispatches to specified functions based on input argument types.
+	* Returns a function which performs element-wise computation.
 	*
-	* @param table - resolution table object
-	* @throws must provide valid table fields
-	* @throws table field values must be array-like objects having an even number of elements
-	* @throws table field values must consist of dtype-function pairs
-	* @returns dispatch function
+	* @param fcn - function applies a unary function to each element in an ndarray
+	* @param idtypes - list containing lists of supported input data types for each ndarray argument
+	* @param odtypes - list of supported output data types
+	* @param policies - dispatch policies
+	* @returns function which performs element-wise computation
 	*
 	* @example
-	* var nabs = require( '@stdlib/math-base-special-abs' );
-	* var dabs = require( '@stdlib/math-strided-special-dabs' );
-	* var sabs = require( '@stdlib/math-strided-special-sabs' );
-	* var gabs = require( '@stdlib/math-strided-special-abs' );
-	* var Float64Array = require( '@stdlib/array-float64' );
+	* var base = require( '@stdlib/math-base-special-abs' );
+	* var dispatch = require( '@stdlib/ndarray-dispatch' );
+	* var ndarrayUnary = require( '@stdlib/ndarray-base-unary' );
+	* var ndarray2array = require( '@stdlib/ndarray-to-array' );
+	* var array = require( '@stdlib/ndarray-array' );
 	*
-	* var table = {
-	*     'scalar': [
-	*         'number', nabs
-	*     ],
-	*     'array': [
-	*         'float64', dabs,
-	*         'float32', sabs,
-	*         'generic', gabs
-	*     ],
-	*     'ndarray': [
-	*         'float64', dabs.ndarray,
-	*         'float32', sabs.ndarray,
-	*         'generic', gabs.ndarray
-	*     ]
+	* var types = [
+	*     'float64', 'float64',
+	*     'float32', 'float32',
+	*     'generic', 'generic'
+	* ];
+	* var data = [
+	*     base,
+	*     base,
+	*     base
+	* ];
+	* var dispatcher = dispatch( ndarrayUnary, types, data, 2, 1, 1 );
+	*
+	* var idt = [ 'float64', 'float32', 'generic' ];
+	* var odt = idt;
+	*
+	* var policies = {
+	*     'output': 'real_and_generic',
+	*     'casting': 'none'
 	* };
+	* var abs = ns.unary( dispatcher, [ idt ], odt, policies );
 	*
-	* var abs = ns.unary( table );
+	* var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
+	* // returns <ndarray>
 	*
-	* var x = new Float64Array( [ -1.0, -2.0, -3.0 ] );
 	* var y = abs( x );
-	* // returns <Float64Array>[ 1.0, 2.0, 3.0 ]
+	* // returns <ndarray>
+	*
+	* var arr = ndarray2array( y );
+	* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 	*/
 	unary: typeof unary;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/math-tools",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Math tools.",
   "license": "Apache-2.0",
   "author": {
@@ -30,8 +30,8 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-tools-unary": "^0.2.1",
-    "@stdlib/utils-define-read-only-property": "^0.2.1"
+    "@stdlib/math-tools-unary": "^0.2.2",
+    "@stdlib/utils-define-read-only-property": "^0.2.2"
   },
   "devDependencies": {},
   "engines": {