@stdlib/math-tools-unary 0.2.2 → 0.3.0

package/lib/resolve_output_dtype.js

@@ -1,78 +0,0 @@
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2021 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-'use strict';
-
-// MODULES //
-
-var format = require( '@stdlib/string-format' );
-
-
-// MAIN //
-
-/**
-* Resolves an output array data type.
-*
-* @private
-* @param {string} xdtype - input array data type
-* @param {string} policy - policy determining an output array data type
-* @throws {Error} unsupported policy
-* @returns {string} output array data type
-*/
-function resolve( xdtype, policy ) {
-	switch ( policy ) {
-	case 'same':
-		return xdtype;
-	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' ||
-			xdtype === 'generic'
-		) {
-			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( format( 'invalid option. Unsupported policy for determining an output array data type. Option: `%s`.', policy ) );
-	}
-}
-
-
-// EXPORTS //
-
-module.exports = resolve;

package/lib/validate_options.js

@@ -1,67 +0,0 @@
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2021 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-'use strict';
-
-// MODULES //
-
-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' );
-
-
-// MAIN //
-
-/**
-* Validates function options.
-*
-* @private
-* @param {Object} opts - destination object
-* @param {Object} options - options
-* @param {string} [options.output_dtype_policy] - policy for determining the output array data type
-* @returns {(Error|null)} null or an error object
-*
-* @example
-* var opts = {};
-* var options = {
-*     'output_dtype_policy': 'float'
-* };
-* var err = validate( opts, options );
-* if ( err ) {
-*     throw err;
-* }
-*/
-function validate( opts, options ) {
-	if ( !isPlainObject( 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( format( 'invalid option. `%s` option must be a recognized/supported output array data type policy. Option: `%s`.', 'output_dtype_policy', opts.policy ) );
-		}
-	}
-	return null;
-}
-
-
-// EXPORTS //
-
-module.exports = validate;

package/lib/validate_table.js

@@ -1,84 +0,0 @@
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2021 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-'use strict';
-
-// MODULES //
-
-var isPlainObject = require( '@stdlib/assert-is-plain-object' );
-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 //
-
-/**
-* Validates a resolution table object.
-*
-* @private
-* @param {Object} out - destination object
-* @param {Object} table - resolution table object
-* @param {(Function|null)} [table.number] - function to invoke upon receiving a number
-* @param {(Function|null)} [table.complex] - function to invoke upon receiving a complex number
-* @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
-* @returns {(Error|null)} null or an error object
-*
-* @example
-* var out = {};
-* var table = {
-*     'number': null,
-*     'complex': null,
-*     'array': null,
-*     'ndarray': null
-* };
-* var err = validate( out, table );
-* if ( err ) {
-*     throw err;
-* }
-*/
-function validate( out, table ) {
-	var fields;
-	var tmp;
-	var key;
-	var i;
-
-	if ( !isPlainObject( 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++ ) {
-		key = fields[ i ];
-		if ( hasOwnProp( table, key ) ) {
-			tmp = table[ key ];
-			if ( !isFunction( tmp ) && !isNull( 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;
-		}
-	}
-	return null;
-}
-
-
-// EXPORTS //
-
-module.exports = validate;