feat: add object/common-keys-in

Ref: #8755

Author: Neerajpathak07

lib/node_modules/@stdlib/object/common-keys-in/README.md

@@ -0,0 +1,125 @@
+<!--
+
+@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.
+
+-->
+
+# commonKeysIn
+
+> Return the common own and inherited property names of two or more objects.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var commonKeysIn = require( '@stdlib/object/common-keys-in' );
+```
+
+#### commonKeysIn( obj1, obj2\[, obj3\[,...,objN]] )
+
+Returns the common own and inherited property names of two or more objects.
+
+```javascript
+var obj = {
+    'a': 1,
+    'b': 2,
+    'c': 3
+};
+
+var obj2 = {
+    'a': 1,
+    'b': 2
+};
+
+var keys = commonKeysIn( obj, obj2 );
+// returns [ 'a', 'b' ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var commonKeysIn = require( '@stdlib/object/common-keys-in' );
+
+function Foo() {
+    this.beep = 'boop';
+    this.a = {
+        'b': 'c'
+    };
+    return this;
+}
+
+Foo.prototype.foo = [ 'bar' ];
+
+var obj1 = new Foo();
+
+var obj2 = {
+    'beep': 'boop',
+    'foo': 'bar'
+};
+
+var keys = commonKeysIn( obj1, obj2 );
+// returns [ 'beep', 'foo' ]
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/object/common-keys-in/benchmark/benchmark.js

@@ -0,0 +1,71 @@
+/**
+* @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 bench = require( '@stdlib/bench' );
+var isStringArray = require( '@stdlib/assert/is-string-array' ).primitives;
+var isEmptyArray = require( '@stdlib/assert/is-empty-array' );
+var fromCodePoint = require( '@stdlib/string/from-code-point' );
+var pkg = require( './../package.json' ).name;
+var commonKeysIn = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var obj1;
+	var obj2;
+	var out;
+	var i;
+
+	obj1 = {
+		'b': 3.141592653589793,
+		'c': {
+			'c1': 'bap',
+			'c3': {
+				'c3b': 5,
+				'c3c': 'bop'
+			},
+			'c4': 1337
+		},
+		'd': [ 4, 5, 6 ],
+		'e': true
+	};
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		obj2 = {
+			'a': 'beep',
+			'b': 'baz',
+			'c': 'boop'
+		};
+		obj2[ fromCodePoint( i%126 ) ] = 'bar';
+		out = commonKeysIn( obj1, obj2 );
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isStringArray( out ) && !isEmptyArray( out ) ) {
+		b.fail( 'should return an array of strings' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/object/common-keys-in/benchmark/benchmark.num_arguments.js

@@ -0,0 +1,107 @@
+/**
+* @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 bench = require( '@stdlib/bench' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var isStringArray = require( '@stdlib/assert/is-string-array' ).primitives;
+var isEmptyArray = require( '@stdlib/assert/is-empty-array' );
+var pkg = require( './../package.json' ).name;
+var commonKeysIn = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} N - number of arguments
+* @returns {Function} benchmark function
+*/
+function createBenchmark( N ) {
+	var args;
+	var o;
+	var i;
+	var j;
+
+	args = [];
+	for ( i = 0; i < N; i++ ) {
+		o = {};
+		for ( j = 0; j < 10; j++ ) {
+			o[ j ] = i * j;
+		}
+		args.push( o );
+	}
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var keys;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			keys = commonKeysIn.apply( null, args );
+			if ( typeof keys !== 'object' ) {
+				b.fail( 'should return an object' );
+			}
+		}
+		b.toc();
+		if ( !isStringArray( keys ) && !isEmptyArray( keys ) ) {
+			b.fail( 'should return an array of strings' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 2^min
+	max = 6; // 2^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 2, i );
+		f = createBenchmark( len );
+		bench( pkg+':num_args='+len+',num_properties=10', f );
+	}
+}
+
+main();