feat: add assert/has-same-constructor

lib/node_modules/@stdlib/assert/has-same-constructor/README.md

@@ -0,0 +1,121 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2018 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.
+
+-->
+
+# hasSameConstructor
+
+> Test if two values have same constructor.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var hasSameConstructor = require( '@stdlib/assert/has-same-constructor' );
+```
+
+#### hasSameConstructor( v1, v2 )
+
+Tests if two values have same constructor.
+
+<!-- eslint-disable no-new-wrappers -->
+
+```javascript
+var obj1 = new Date();
+var obj2 = new Date();
+var bool = hasSameConstructor(obj1, obj2);
+// returns true
+
+var obj1 = new Date();
+var obj3 = new String("Hello");
+bool = hasSameConstructor(obj1, obj3);
+// returns false
+
+var obj3 = new String("Hello");
+var obj4 = "World";
+bool = hasSameConstructor(obj3, obj4);
+// returns true
+```
+
+</section>
+
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint-disable no-new-wrappers -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var DateObj1 = new Date();
+var DateObj2 = new Date();
+var FloatArrObj = new Float64Array( 10 );
+var IntArrObj = new Int32Array( [ 1, 2, 3 ] );
+var ComplexObj = new Complex64( 5.0, 3.0 );
+
+var bool = hasSameConstructor( DateObj1, DateObj2 );
+// => true
+
+bool = hasSameConstructor( DateObj1, FloatArrObj );
+// => false
+
+bool = hasSameConstructor( FloatArrObj , IntArrObj );
+// => false
+
+bool = hasSameConstructor( ComplexObj , IntArrObj );
+// => false
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/assert/has-iterator-symbol-support`][@stdlib/assert/has-iterator-symbol-support]</span><span class="delimiter">: </span><span class="description">detect native Symbol.iterator support.</span>
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[mdn-symbol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol
+
+<!-- <related-links> -->
+
+[@stdlib/assert/has-iterator-symbol-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-iterator-symbol-support
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/assert/has-same-constructor/benchmark/benchmark.js

@@ -0,0 +1,65 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+/* eslint-disable no-empty-function */
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
+var pkg = require( './../package.json' ).name;
+var hasSameConstructor = require( './../lib' );
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var values;
+	var bool;
+	var i;
+
+	values = [
+		'5',
+		5,
+		NaN,
+		true,
+		false,
+		null,
+		void 0,
+		[],
+		{},
+		new Date(),
+		function noop() {}
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		bool = hasSameConstructor( values[ i % values.length ], values[ (i+1) % values.length ] );
+		if ( typeof bool !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+
+	if ( !isBoolean( bool ) ) {
+		b.fail( 'should return a boolean' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/assert/has-same-constructor/docs/repl.txt

@@ -0,0 +1,35 @@
+{{alias}}( value )
+    Tests if two values have same constructor.
+
+    If provided with two values with different constructors, the function returns `false`.
+
+    Parameters
+    ----------
+    value: any
+        Value to test.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating whether two values have same constructor.
+
+    Examples
+    --------
+    > var obj1 = new Date();
+      var obj2 = new Date();
+      var bool = {{alias}}(obj1, obj2);
+    true
+
+    > var obj1 = new Date();
+      var obj3 = new String("Hello");
+      bool = {{alias}}(obj1, obj3);
+    false
+
+    > var obj3 = new String("Hello");
+      var obj4 = "World";
+      bool = {{alias}}(obj3, obj4);
+    true
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/assert/has-same-constructor/docs/types/index.d.ts

@@ -0,0 +1,50 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Test whether two provided values have the same constructor.
+*
+* @param {*} a - The first value to test.
+* @param {*} b - The second value to test.
+* @returns {boolean} Returns `true` if both values have the same constructor, else `false`.
+
+* @example
+* var obj1 = new Date();
+* var obj2 = new Date();
+* var bool = hasSameConstructor(obj1, obj2);
+* // returns true
+* @example
+* var obj1 = new Date();
+* var obj3 = new String("Hello");
+* var bool = hasSameConstructor(obj1, obj3);
+* // returns false
+*
+* @example
+* var obj3 = new String("Hello");
+* var obj4 = "World";
+* var bool = hasSameConstructor(obj3, obj4);
+* // returns true
+*/
+
+declare function hasSameConstructor(a: any, b: any): boolean;
+
+// EXPORTS //
+
+export = hasSameConstructor;

lib/node_modules/@stdlib/assert/has-same-constructor/docs/types/tests.ts

@@ -0,0 +1,34 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+import hasSameConstructor from './index';
+
+// TESTS //
+
+// The function returns a boolean...
+{
+    hasSameConstructor(new Date(), new String("Hello")); // $ExpectType boolean
+    hasSameConstructor(new String("Hello"), "World"); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+    hasSameConstructor(); // $ExpectError
+    hasSameConstructor(new Date(), new Date(), new Date()); // $ExpectError
+}
+

lib/node_modules/@stdlib/assert/has-same-constructor/examples/index.js

@@ -0,0 +1,44 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+/* eslint-disable object-curly-newline, no-empty-function, no-restricted-syntax */
+
+'use strict';
+
+var hasSameConstructor = require( './../lib' );
+var Float64Array = require( '@stdlib/array/float64' );
+var Int32Array = require( '@stdlib/array/int32' );
+var Complex64 = require( '@stdlib/complex/float32' );
+
+var DateObj1 = new Date();
+var DateObj2 = new Date();
+var FloatArrObj = new Float64Array( 10 );
+var IntArrObj = new Int32Array( [ 1, 2, 3 ] );
+var ComplexObj = new Complex64( 5.0, 3.0 );
+
+console.log( hasSameConstructor( DateObj1, DateObj2 ) );
+// => true
+
+console.log( hasSameConstructor( DateObj1, FloatArrObj ) );
+// => false
+
+console.log( hasSameConstructor( FloatArrObj , IntArrObj ) );
+// => false
+
+console.log( hasSameConstructor( ComplexObj , IntArrObj ) );
+// =>