feat: add assert/has-same-constructor

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

@@ -0,0 +1,93 @@
+<!--
+
+@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 isArrayLikeObject = require( '@stdlib/assert/has-same-constructor' );
+```
+
+#### hasSameConstructor( value , value )
+
+Tests if two values have same `constructor`.
+
+<!-- eslint-disable object-curly-newline -->
+
+```javascript
+    > var obj1 = new Date();
+      var obj2 = new Date();
+      console.log(hasSameConstructor(obj1, obj2));
+    true
+
+    > var obj1 = new Date();
+      var obj3 = new String("Hello");
+      console.log(hasSameConstructor(obj1, obj3));
+    false
+
+    > var obj3 = new String("Hello");
+      var obj4 = "World";
+      console.log(hasSameConstructor(obj3, obj4));
+    true
+```
+
+If provided with two values with different `constructors`, the function returns `false`.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint-disable object-curly-newline, object-curly-spacing, no-empty-function, no-restricted-syntax -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var hasSameConstructor = require( './../lib' );
+
+var DateObject1 = new Date();
+var DateObject2 = new Date();
+var StringObject = new String("Hello");
+var StringPrimitive = "World";
+
+console.log( hasSameConstructor( DateObject1, DateObject2 ) );
+// => true
+
+console.log( hasSameConstructor( DateObject1, StringObject ) );
+// => false
+
+console.log( hasSameConstructor( StringObject, StringPrimitive ) );
+// => true
+
+console.log( (function test() {
+	return hasSameConstructor( arguments, StringObject  );
+})() );
+// => false
+```
+
+</section>

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

@@ -0,0 +1,92 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var pkg = require( './../package.json' ).name;
+var hasSameConstructor = require( './../lib' );
+
+
+// MAIN //
+
+/**
+* Benchmark the hasSameConstructor function when provided with same value types.
+*/
+bench( pkg, function benchmark( b ) {
+	var obj1;
+	var obj2;
+	var bool;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		obj1 = new Date();
+		obj2 = new Date();
+		bool = hasSameConstructor( obj1, obj2 );
+		if ( typeof bool !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+	if ( typeof bool !== 'boolean' ) {
+		b.fail( 'should return a boolean' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+/**
+* Benchmark the hasSameConstructor function when provided with other value types.
+*/
+bench( pkg+':other_types', function benchmark( b ) {
+	var obj1;
+	var obj2;
+	var obj3;
+	var obj4;
+	var bool;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		obj1 = new Date();
+		obj2 = new Date();
+		obj3 = new String( "Hello" );
+		obj4 = "World";
+		bool = hasSameConstructor( obj1, obj2 );
+		if ( typeof bool !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+		bool = hasSameConstructor( obj1, obj3 );
+		if ( typeof bool !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+		bool = hasSameConstructor( obj3, obj4 );
+		if ( typeof bool !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+	if ( typeof bool !== 'boolean' ) {
+		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();
+      console.log({{alias}}(obj1, obj2));
+    true
+
+    > var obj1 = new Date();
+      var obj3 = new String("Hello");
+      console.log({{alias}}tor(obj1, obj3));
+    false
+
+    > var obj3 = new String("Hello");
+      var obj4 = "World";
+      console.log({{alias}}(obj3, obj4));
+    true
+
+    See Also
+    --------
+

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

@@ -0,0 +1,51 @@
+/*
+* @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();
+* console.log(hasSameConstructor(obj1, obj2));
+* // returns true, both are instances of Date
+*
+* @example
+* var obj1 = new Date();
+* var obj3 = new String("Hello");
+* console.log(hasSameConstructor(obj1, obj3));
+* // returns false
+*
+* @example
+* var obj3 = new String("Hello");
+* var obj4 = "World";
+* console.log(hasSameConstructor(obj3, obj4));
+* // returns true, one is String, the other is primitive string; but has same String constructor
+*/
+
+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,42 @@
+/**
+* @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 DateObject1 = new Date();
+var DateObject2 = new Date();
+var StringObject = new String("Hello");
+var StringPrimitive = "World";
+
+console.log( hasSameConstructor( DateObject1, DateObject2 ) );
+// => true
+
+console.log( hasSameConstructor( DateObject1, StringObject ) );
+// => false
+
+console.log( hasSameConstructor( StringObject, StringPrimitive ) );
+// => true
+
+console.log( (function test() {
+	return hasSameConstructor( arguments, StringObject  );
+})() );
+// => false