@stdlib/math-tools-unary 0.0.6 → 0.2.0

package/lib/main.js

@@ -28,6 +28,7 @@ var isCollection = require( '@stdlib/assert-is-collection' );
 var dtype = require( '@stdlib/ndarray-base-buffer-dtype' );
 var buffer = require( '@stdlib/ndarray-base-buffer' );
 var broadcast = require( '@stdlib/ndarray-base-broadcast-array' );
+var format = require( '@stdlib/string-format' );
 var ndarrayfcn = require( './ndarray.js' );
 var odtype = require( './resolve_output_dtype.js' );
 var defaults = require( './defaults.json' );
@@ -47,7 +48,7 @@ var validate = require( './validate.js' );
 * @param {(Function|null)} [table.array] - function to invoke upon receiving an array-like object
 * @param {(Function|null)} [table.ndarray] - function to invoke upon receiving an ndarray-like object
 * @param {Options} [options] - options
-* @param {string} [options.output_dtype_policy='float'] - policy for determining the output array data type
+* @param {string} [options.output_dtype_policy='floating-point'] - policy for determining the output array data type
 * @throws {TypeError} first argument must be an object
 * @throws {TypeError} first argument must have valid table fields
 * @throws {Error} each table field value must be either a function or `null`
@@ -132,7 +133,7 @@ function dispatch( table, options ) {
 	* @throws {TypeError} must provide valid options
 	* @returns {(ndarray|Collection|number|Complex)} results
 	*/
-	function dispatcher( x, options ) {
+	function dispatcher( x ) {
 		var xdtype;
 		var ydtype;
 		var opts;
@@ -152,7 +153,7 @@ function dispatch( table, options ) {
 		}
 		opts = {};
 		if ( arguments.length > 1 ) {
-			err = validate( opts, options );
+			err = validate( opts, arguments[ 1 ] );
 			if ( err ) {
 				throw err;
 			}
@@ -171,12 +172,10 @@ function dispatch( table, options ) {
 			xdtype = dtype( x ) || 'generic';
 			ydtype = opts.dtype || odtype( xdtype, OPTS.policy );
 			y = buffer( ydtype, x.length );
-
-			// FIXME: need to supply dtype enum argument for each array argument...
-			t.array( x.length, x, 1, y, 1 );
+			t.array( x.length, xdtype, x, 1, ydtype, y, 1 );
 			return y;
 		}
-		throw new TypeError( 'invalid argument. Must provide an argument having a supported data type. Value: `' + x + '`.' );
+		throw new TypeError( format( 'invalid argument. Must provide an argument having a supported data type. Value: `%s`.', x ) );
 	}
 
 	/**
@@ -225,8 +224,7 @@ function dispatch( table, options ) {
 				if ( y.length !== x.length ) {
 					throw new RangeError( 'invalid argument. Output array must have the same number of elements (i.e., length) as the input array.' );
 				}
-				// FIXME: need to supply dtype enum argument for each array argument...
-				t.array( x.length, x, 1, y, 1 );
+				t.array( x.length, dtype( x ) || 'generic', x, 1, dtype( y ) || 'generic', y, 1 );
 				return y;
 			}
 			throw new TypeError( 'invalid argument. If the first argument is an array-like object, the second argument must be an array-like object.' );
@@ -237,7 +235,7 @@ function dispatch( table, options ) {
 		if ( isComplexLike( x ) ) {
 			throw new TypeError( 'invalid argument. Providing a complex number is not supported. Consider providing a zero-dimensional ndarray containing the complex number value.' );
 		}
-		throw new TypeError( 'invalid argument. Must provide an argument having a supported data type. Value: `' + x + '`.' );
+		throw new TypeError( format( 'invalid argument. Must provide an argument having a supported data type. Value: `%s`.', x ) );
 	}
 }
 

package/lib/ndarray.js

@@ -24,27 +24,7 @@ var ndarray = require( '@stdlib/ndarray-ctor' );
 var buffer = require( '@stdlib/ndarray-base-buffer' );
 var shape2strides = require( '@stdlib/ndarray-base-shape2strides' );
 var numel = require( '@stdlib/ndarray-base-numel' );
-
-
-// FUNCTIONS //
-
-/**
-* Copies an array-like object to a generic array.
-*
-* @private
-* @param {ArrayLikeObject} x - input array
-* @returns {Array} output array
-*/
-function copy( x ) {
-	var out;
-	var i;
-
-	out = [];
-	for ( i = 0; i < x.length; i++ ) {
-		out.push( x[ i ] );
-	}
-	return out;
-}
+var copy = require( '@stdlib/array-base-copy-indexed' );
 
 
 // MAIN //
@@ -57,7 +37,6 @@ function copy( x ) {
 * @param {ndarray} x - input array
 * @param {string} ydtype - output array data type
 * @param {string} yorder - output array order
-* @throws {TypeError} must provide an input array argument with a supported data type
 * @returns {ndarray} output array
 */
 function ndarrayfcn( fcn, x, ydtype, yorder ) {

package/lib/policies.json

@@ -1,4 +1,6 @@
 [
 	"same",
-	"float"
+	"floating-point",
+  "real floating-point",
+  "complex floating-point"
 ]

package/lib/resolve_output_dtype.js

@@ -18,6 +18,13 @@
 
 'use strict';
 
+// MODULES //
+
+var format = require( '@stdlib/string-format' );
+
+
+// MAIN //
+
 /**
 * Resolves an output array data type.
 *
@@ -31,7 +38,19 @@ function resolve( xdtype, policy ) {
 	switch ( policy ) {
 	case 'same':
 		return xdtype;
-	case 'float':
+	case 'floating-point':
+		// TODO: we may want to delegate checking for a floating-point dtype to a utility function/package (e.g., isFloatDtype), in order to centralize logic for testing whether a dtype is "floating-point". Otherwise, this will be yet another place to update logic should we ever add, e.g., a `float128` or `float16` dtype.
+		if (
+			xdtype === 'float64' ||
+			xdtype === 'float32' ||
+			xdtype === 'generic' ||
+			xdtype === 'complex128' ||
+			xdtype === 'complex64'
+		) {
+			return xdtype;
+		}
+		return 'float64'; // TODO: constants/math/default-real-floating-point-dtype?
+	case 'real floating-point':
 		if (
 			xdtype === 'float64' ||
 			xdtype === 'float32' ||
@@ -40,8 +59,16 @@ function resolve( xdtype, policy ) {
 			return xdtype;
 		}
 		return 'float64';
+	case 'complex floating-point':
+		if (
+			xdtype === 'complex128' ||
+			xdtype === 'complex64'
+		) {
+			return xdtype;
+		}
+		return 'complex128'; // TODO: constants/math/default-complex-floating-point-dtype?
 	default:
-		throw new Error( 'invalid option. Unsupported policy for determining an output array data type. Option: `' + policy + '`.' );
+		throw new Error( format( 'invalid option. Unsupported policy for determining an output array data type. Option: `%s`.', policy ) );
 	}
 }
 

package/lib/validate.js

@@ -25,6 +25,7 @@ var hasOwnProp = require( '@stdlib/assert-has-own-property' );
 var contains = require( '@stdlib/assert-contains' );
 var orders = require( '@stdlib/ndarray-orders' );
 var dtypes = require( '@stdlib/ndarray-dtypes' );
+var format = require( '@stdlib/string-format' );
 
 
 // VARIABLES //
@@ -57,18 +58,18 @@ var DTYPES = dtypes();
 */
 function validate( opts, options ) {
 	if ( !isPlainObject( options ) ) {
-		return new TypeError( 'invalid argument. Options argument must be a plain object. Value: `' + options + '`.' );
+		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 	}
 	if ( hasOwnProp( options, 'dtype' ) ) {
 		opts.dtype = options.dtype;
 		if ( !contains( DTYPES, opts.dtype ) ) {
-			return new TypeError( 'invalid option. `dtype` option must be a recognized/supported data type. Option: `' + opts.dtype + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a recognized/supported data type. Option: `%s`.', 'dtype', opts.dtype ) );
 		}
 	}
 	if ( hasOwnProp( options, 'order' ) ) {
 		opts.order = options.order;
 		if ( !contains( ORDERS, opts.order ) ) {
-			return new TypeError( 'invalid option. `order` option must be a recognized/supported data type. Option: `' + opts.order + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a recognized/supported data type. Option: `%s`.', 'order', opts.order ) );
 		}
 	}
 	return null;

package/lib/validate_options.js

@@ -23,6 +23,7 @@
 var isPlainObject = require( '@stdlib/assert-is-plain-object' );
 var hasOwnProp = require( '@stdlib/assert-has-own-property' );
 var contains = require( '@stdlib/assert-contains' );
+var format = require( '@stdlib/string-format' );
 var POLICIES = require( './policies.json' );
 
 
@@ -49,12 +50,12 @@ var POLICIES = require( './policies.json' );
 */
 function validate( opts, options ) {
 	if ( !isPlainObject( options ) ) {
-		return new TypeError( 'invalid argument. Options argument must be a plain object. Value: `' + options + '`.' );
+		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 	}
 	if ( hasOwnProp( options, 'output_dtype_policy' ) ) {
 		opts.policy = options.output_dtype_policy;
 		if ( !contains( POLICIES, opts.policy ) ) {
-			return new TypeError( 'invalid option. `output_dtype_policy` option must be a recognized/supported output array data type policy. Option: `' + opts.policy + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a recognized/supported output array data type policy. Option: `%s`.', 'output_dtype_policy', opts.policy ) );
 		}
 	}
 	return null;

package/lib/validate_table.js

@@ -25,6 +25,7 @@ var hasOwnProp = require( '@stdlib/assert-has-own-property' );
 var isFunction = require( '@stdlib/assert-is-function' );
 var isNull = require( '@stdlib/assert-is-null' );
 var objectKeys = require( '@stdlib/utils-keys' );
+var format = require( '@stdlib/string-format' );
 
 
 // MAIN //
@@ -61,7 +62,7 @@ function validate( out, table ) {
 	var i;
 
 	if ( !isPlainObject( table ) ) {
-		return new TypeError( 'invalid argument. Resolution table must be a plain object. Value: `' + table + '`.' );
+		return new TypeError( format( 'invalid argument. Resolution table must be an object. Value: `%s`.', table ) );
 	}
 	fields = objectKeys( out );
 	for ( i = 0; i < fields.length; i++ ) {
@@ -69,7 +70,7 @@ function validate( out, table ) {
 		if ( hasOwnProp( table, key ) ) {
 			tmp = table[ key ];
 			if ( !isFunction( tmp ) && !isNull( tmp ) ) {
-				return new TypeError( 'invalid argument. Resolution table `' + key + '` field value must be either a function or `null`. Value: `' + tmp + '`.' );
+				return new TypeError( format( 'invalid argument. Resolution table `%s` field value must be either a function or null. Value: `%s`.', key, tmp ) );
 			}
 			out[ key ] = tmp;
 		}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/math-tools-unary",
-  "version": "0.0.6",
+  "version": "0.2.0",
   "description": "Multiple dispatch for unary mathematical functions.",
   "license": "Apache-2.0",
   "author": {
@@ -37,46 +37,47 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-contains": "^0.0.x",
-    "@stdlib/assert-has-own-property": "^0.0.x",
-    "@stdlib/assert-is-collection": "^0.0.x",
-    "@stdlib/assert-is-complex-like": "^0.0.x",
-    "@stdlib/assert-is-function": "^0.0.x",
-    "@stdlib/assert-is-ndarray-like": "^0.0.x",
-    "@stdlib/assert-is-null": "^0.0.x",
-    "@stdlib/assert-is-number": "^0.0.x",
-    "@stdlib/assert-is-plain-object": "^0.0.x",
-    "@stdlib/ndarray-base-broadcast-array": "^0.0.x",
-    "@stdlib/ndarray-base-buffer": "^0.0.x",
-    "@stdlib/ndarray-base-buffer-dtype": "^0.0.x",
-    "@stdlib/ndarray-base-numel": "^0.0.x",
-    "@stdlib/ndarray-base-shape2strides": "^0.0.x",
-    "@stdlib/ndarray-ctor": "^0.0.x",
-    "@stdlib/ndarray-dtypes": "^0.0.x",
-    "@stdlib/ndarray-orders": "^0.0.x",
-    "@stdlib/types": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
-    "@stdlib/utils-keys": "^0.0.x"
+    "@stdlib/array-base-copy-indexed": "^0.2.0",
+    "@stdlib/assert-contains": "^0.2.0",
+    "@stdlib/assert-has-own-property": "^0.2.0",
+    "@stdlib/assert-is-collection": "^0.2.0",
+    "@stdlib/assert-is-complex-like": "^0.2.0",
+    "@stdlib/assert-is-function": "^0.2.0",
+    "@stdlib/assert-is-ndarray-like": "^0.2.0",
+    "@stdlib/assert-is-null": "^0.2.0",
+    "@stdlib/assert-is-number": "^0.2.0",
+    "@stdlib/assert-is-plain-object": "^0.2.0",
+    "@stdlib/ndarray-base-broadcast-array": "^0.2.0",
+    "@stdlib/ndarray-base-buffer": "^0.2.0",
+    "@stdlib/ndarray-base-buffer-dtype": "^0.2.0",
+    "@stdlib/ndarray-base-numel": "^0.2.0",
+    "@stdlib/ndarray-base-shape2strides": "^0.2.0",
+    "@stdlib/ndarray-ctor": "^0.2.0",
+    "@stdlib/ndarray-dtypes": "^0.2.0",
+    "@stdlib/ndarray-orders": "^0.2.0",
+    "@stdlib/string-format": "^0.2.0",
+    "@stdlib/types": "^0.3.1",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0",
+    "@stdlib/utils-keys": "^0.2.0",
+    "@stdlib/error-tools-fmtprodmsg": "^0.2.0"
   },
   "devDependencies": {
-    "@stdlib/array-float32": "^0.0.x",
-    "@stdlib/array-float64": "^0.0.x",
-    "@stdlib/array-int32": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-special-abs": "^0.0.x",
-    "@stdlib/math-base-special-pow": "^0.0.x",
-    "@stdlib/math-strided-special-abs": "^0.0.x",
-    "@stdlib/math-strided-special-dabs": "^0.0.x",
-    "@stdlib/math-strided-special-sabs": "^0.0.x",
-    "@stdlib/ndarray-array": "^0.0.x",
-    "@stdlib/ndarray-base-unary": "^0.0.x",
-    "@stdlib/ndarray-dispatch": "^0.0.x",
-    "@stdlib/ndarray-ind2sub": "^0.0.x",
-    "@stdlib/random-base-uniform": "^0.0.x",
+    "@stdlib/array-float32": "^0.2.0",
+    "@stdlib/array-float64": "^0.2.0",
+    "@stdlib/math-base-assert-is-nan": "^0.2.0",
+    "@stdlib/math-base-special-abs": "^0.2.0",
+    "@stdlib/math-base-special-pow": "^0.2.0",
+    "@stdlib/math-strided-special-abs": "^0.2.0",
+    "@stdlib/ndarray-array": "^0.1.0",
+    "@stdlib/ndarray-base-unary": "^0.1.0",
+    "@stdlib/ndarray-dispatch": "^0.2.0",
+    "@stdlib/ndarray-ind2sub": "^0.1.1",
+    "@stdlib/random-base-uniform": "^0.1.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
+    "@stdlib/bench-harness": "^0.2.0",
+    "@stdlib/bench": "^0.3.1"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -108,7 +109,7 @@
   ],
   "__stdlib__": {},
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,119 +0,0 @@
-
-{{alias}}( table )
-    Returns a function which dispatches to specified functions based on input
-    argument types.
-
-    A `table` resolution object may contain one or more of the following fields:
-
-    - scalar: strided look-up table for scalar arguments.
-    - array: strided look-up table for array-like object arguments.
-    - ndarray: strided look-up table for ndarray arguments.
-
-    Each strided look-up table should be comprised as follows:
-
-      [ <dtype>, <fcn>, <dtype>, <fcn>, ... ]
-
-    If an argument's data type is *not* found in the argument's corresponding
-    look-up table and if a 'generic' data type is present in that same table,
-    the returned dispatch function will resolve the "generic" implementation. In
-    other words, an implementation associated with a 'generic' data type will be
-    treated as the default implementation.
-
-    If unable to resolve an implementation for a provided argument data type,
-    the returned function throws an error.
-
-    If provided a number, the returned function returns a number.
-
-    If provided an ndarray or array-like object, the returned function performs
-    element-wise computation.
-
-    If provided an array-like object, the returned function returns an array-
-    like object having the same length and data type as the provided input
-    argument.
-
-    If provided an ndarray, the returned function returns an ndarray having the
-    same shape and data type as the provided input argument.
-
-    Parameters
-    ----------
-    table: Object
-        Table resolution object.
-
-    table.scalar: ArrayLikeObject (optional)
-        Strided look-up table for scalar arguments. Supported data types:
-        'number' and 'complex'.
-
-    table.array: ArrayLikeObject (optional)
-        Strided look-up table for array-like object arguments. Implementation
-        functions must follow strided array interface argument conventions:
-
-          fcn( N, x, strideX, y, strideY )
-
-        where
-
-        - N: number of indexed elements.
-        - x: input strided array.
-        - strideX: index increment for `x`.
-        - y: destination strided array.
-        - strideY: index increment for `y`.
-
-        Supported array data types consist of all supported ndarray data types.
-
-    table.ndarray: ArrayLikeObject (optional)
-        Strided look-up table for ndarray arguments. Implementation functions
-        must follow strided array ndarray interface argument conventions:
-
-        fcn( N, x, strideX, offsetX, y, strideY, offsetY )
-
-        where
-
-        - N: number of indexed elements.
-        - x: input strided array (i.e., underlying input ndarray buffer).
-        - strideX: index increment for `x`.
-        - offsetX: starting index for `x`.
-        - y: destination strided array (i.e., underlying output ndarray buffer).
-        - strideY: index increment for `y`.
-        - offsetY: starting index for `y`.
-
-        Supported data types consist of all supported ndarray data types.
-
-    Returns
-    -------
-    fcn: Function
-        Dispatch function.
-
-    Examples
-    --------
-    > var t = {};
-    > t.scalar = [ 'number', {{alias:@stdlib/math/base/special/abs}} ];
-    > t.array = [
-    ...    'float64', {{alias:@stdlib/math/strided/special/dabs}},
-    ...    'float32', {{alias:@stdlib/math/strided/special/sabs}},
-    ...    'generic', {{alias:@stdlib/math/strided/special/abs}}
-    ... ];
-    > t.ndarray = [
-    ...    'float64', {{alias:@stdlib/math/strided/special/dabs}}.ndarray,
-    ...    'float32', {{alias:@stdlib/math/strided/special/sabs}}.ndarray,
-    ...    'generic', {{alias:@stdlib/math/strided/special/abs}}.ndarray
-    ... ];
-    > var fcn = {{alias}}( t );
-
-    // Provide a number:
-    > var y = fcn( -1.0 )
-    1.0
-
-    // Provide an array-like object:
-    > var x = new {{alias:@stdlib/array/float64}}( [ -1.0, -2.0 ] );
-    > y = fcn( x )
-    <Float64Array>[ 1.0, 2.0 ]
-
-    // Provide an ndarray:
-    > x = {{alias:@stdlib/ndarray/array}}( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
-    > y = fcn( x )
-    <ndarray>
-    > y.get( 0, 1 )
-    2.0
-
-    See Also
-    --------
-