Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop

Author: kgryte

lib/node_modules/@stdlib/assert/docs/types/index.d.ts

@@ -0,0 +1,29 @@
+/*
+* @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.
+*/
+
+/* tslint:disable:no-unused-expression */
+
+import assert = require( './index' );
+
+
+// TESTS //
+
+// The exported value is the expected interface...
+{
+	assert; // $ExpectType ASSERT
+}

lib/node_modules/@stdlib/assert/docs/types/test.ts

@@ -0,0 +1,48 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Tests if a value is a centrosymmetric matrix.
+*
+* ## Notes
+*
+* -   The implementation must rely on manually checking that \\(M_{ij} = M_{N-i-1,N-j-1}\\), and, while element access is deterministic, no way exists to prevent cache misses outside of reordering the underlying matrix elements, thus incurring a larger performance penalty than just "jumping around" in a single pass.
+* -   Worst case scenario: O(N^2).
+*
+* @param v - value to test
+* @returns boolean indicating if a value is a centrosymmetric matrix
+*
+* @example
+* var ndarray = require( `@stdlib/ndarray/ctor` );
+*
+* var arr = ndarray( 'generic', [ 2, 1, 1, 2 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+*
+* var bool = isCentrosymmetricMatrix( arr );
+* // returns true
+*
+* bool = isCentrosymmetricMatrix( [] );
+* // returns false
+*/
+declare function isCentrosymmetricMatrix( v: any ): boolean;
+
+
+// EXPORTS //
+
+export = isCentrosymmetricMatrix;

lib/node_modules/@stdlib/assert/is-centrosymmetric-matrix/docs/types/index.d.ts

@@ -0,0 +1,56 @@
+/*
+* @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.
+*/
+
+/* tslint:disable:no-invalid-this */
+
+import isCentrosymmetricMatrix = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	const matrix =	{
+		'data': [ 2, 1, 1, 2 ],
+		'ndims': 2,
+		'shape': [ 2, 2 ],
+		'strides': [ 2, 1 ],
+		'offset': 0,
+		'order': 'row-major',
+		'dtype': 'generic',
+		'length': 4,
+		'flags': {},
+		'get': function get( i: number, j: number ): number {
+			const idx = ( this.strides[ 0 ] * i ) + ( this.strides[ 1 ] * j );
+			return this.data[ idx ];
+		},
+		'set': function set( i: number, j: number, v: number ): number {
+			const idx = ( this.strides[ 0 ] * i ) + ( this.strides[ 1 ] * j );
+			this.data[ idx ] = v;
+			return v;
+		}
+	};
+	isCentrosymmetricMatrix( matrix ); // $ExpectType boolean
+	isCentrosymmetricMatrix( [] ); // $ExpectType boolean
+	isCentrosymmetricMatrix( false ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isCentrosymmetricMatrix(); // $ExpectError
+}

lib/node_modules/@stdlib/assert/is-centrosymmetric-matrix/docs/types/test.ts

@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {

lib/node_modules/@stdlib/assert/is-centrosymmetric-matrix/package.json

@@ -0,0 +1,57 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Tests if a value is a plain object containing a circular reference.
+*
+* @param value - value to test
+* @returns boolean indicating whether value is a plain object containing a circular reference
+*
+* @example
+* var obj = {
+*   'a': 'beep',
+*   'b': {
+*     'c': 'boop'
+*   }
+* };
+* obj.b.self = obj;
+* var bool = isCircularPlainObject( obj );
+* // returns true
+*
+* @example
+* var arr = [ 1, 2, 3 ];
+* arr.push( arr );
+* var bool = isCircularPlainObject( arr );
+* // returns false
+*
+* @example
+* var bool = isCircularPlainObject( {} );
+* // returns false
+*
+* @example
+* var bool = isCircularPlainObject( null );
+* // returns false
+*/
+declare function isCircularPlainObject( value: any ): boolean;
+
+
+// EXPORTS //
+
+export = isCircularPlainObject;

lib/node_modules/@stdlib/assert/is-circular-plain-object/docs/types/index.d.ts

@@ -0,0 +1,34 @@
+/*
+* @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.
+*/
+
+import isCircularPlainObject = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isCircularPlainObject( {} ); // $ExpectType boolean
+	isCircularPlainObject( [] ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isCircularPlainObject(); // $ExpectError
+	isCircularPlainObject( [], 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/assert/is-circular-plain-object/docs/types/test.ts

@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {

lib/node_modules/@stdlib/assert/is-circular-plain-object/package.json

@@ -0,0 +1,38 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Tests if a value is a complex typed array.
+*
+* @param value - value to test
+* @returns boolean indicating if a value is a complex typed array
+*
+* @example
+* var Complex128Array = require( `@stdlib/array/complex128` );
+*
+* var bool = isComplexTypedArray( new Complex128Array( 10 ) );
+* // returns true
+*/
+declare function isComplexTypedArray( value: any ): boolean;
+
+
+// EXPORTS //
+
+export = isComplexTypedArray;

lib/node_modules/@stdlib/assert/is-complex-typed-array/docs/types/index.d.ts

@@ -0,0 +1,33 @@
+/*
+* @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.
+*/
+
+import isComplexTypedArray = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isComplexTypedArray( [] ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isComplexTypedArray(); // $ExpectError
+	isComplexTypedArray( [], 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/assert/is-complex-typed-array/docs/types/test.ts

@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {

lib/node_modules/@stdlib/assert/is-complex-typed-array/package.json

@@ -0,0 +1,40 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Tests if a value is a Complex128Array.
+*
+* @param value - value to test
+* @returns boolean indicating whether value is a Complex128Array
+*
+* @example
+* var bool = isComplex128Array( new Complex128Array( 10 ) );
+* // returns true
+*
+* @example
+* var bool = isComplex128Array( [] );
+* // returns false
+*/
+declare function isComplex128Array( value: any ): boolean;
+
+
+// EXPORTS //
+
+export = isComplex128Array;