All files / assert/is-equal-data-type/lib main.js

74.69% Statements 62/83
100% Branches 1/1
0% Functions 0/1
74.69% Lines 62/83

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 841x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x                                           1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 isDataTypeString = require( '@stdlib/ndarray/base/assert/is-data-type-string' );
var isDataTypeObject = require( '@stdlib/ndarray/base/assert/is-data-type-object' );
var isStructDataType = require( '@stdlib/ndarray/base/assert/is-struct-data-type' );
 
 
// MAIN //
 
/**
* Tests whether two values are equal ndarray data types.
*
* @param {*} v1 - first input value
* @param {*} v2 - second input value
* @returns {boolean} boolean indicating whether two input values are equal ndarray data types
*
* @example
* var DataType = require( '@stdlib/ndarray/dtype-ctor' );
*
* var bool = isEqualDataType( 'binary', 'binary' );
* // returns true
*
* bool = isEqualDataType( 'float32', 'float32' );
* // returns true
*
* bool = isEqualDataType( 'float64', new DataType( 'float64' ) );
* // returns true
*
* bool = isEqualDataType( 'generic', new DataType( 'generic' ) );
* // returns true
*
* bool = isEqualDataType( 'int16', 'int32' );
* // returns false
*
* bool = isEqualDataType( 'int32', new DataType( 'int16' ) );
* // returns false
*/
function isEqualDataType( v1, v2 ) {
	if ( isDataTypeString( v1 ) ) {
		// Nothing to do here. Branch is kept to avoid additional assertion logic for what is expected to be a common use case; namely, comparing data type strings...
	} else if ( isDataTypeObject( v1 ) ) {
		v1 = String( v1 );
	} else if ( isStructDataType( v1 ) ) {
		v1 = v1.layout;
	} else {
		return false;
	}
	if ( isDataTypeString( v2 ) ) {
		// Nothing to do here. Branch is kept to avoid additional assertion logic for what is expected to be a common use case; namely, comparing data type strings...
	} else if ( isDataTypeObject( v2 ) ) {
		v2 = String( v2 );
	} else if ( isStructDataType( v2 ) ) {
		v2 = v2.layout;
	} else {
		return false;
	}
	return ( v1 === v2 );
}
 
 
// EXPORTS //
 
module.exports = isEqualDataType;