@ohos-ports/stdlib-assert 0.0.0-stage → 0.4.1-beta.0

package/is-symbol-array/docs/types/index.d.ts

@@ -0,0 +1,118 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 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
+
+/**
+* Interface defining `isSymbolArray` with methods for testing for primitive and object arrays, respectively.
+*/
+interface IsSymbolArray {
+	/**
+	* Tests if a value is an array-like object containing only symbols.
+	*
+	* ## Notes
+	*
+	* -   In pre-ES2015 environments, the function always returns `false`.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether value is an array-like object containing only symbols
+	*
+	* @example
+	* var bool = isSymbolArray( [ Symbol( 'abc' ), Symbol( 'def' ) ] );
+	* // returns true
+	*
+	* @example
+	* var bool = isSymbolArray( [ Symbol( 'abc' ), 'def' ] );
+	* // returns false
+	*/
+	( value: any ): value is ArrayLike<symbol | Symbol>;
+
+	/**
+	*  Tests if a value is an array-like object containing only `symbol` primitives.
+	*
+	* ## Notes
+	*
+	* -   In pre-ES2015 environments, the function always returns `false`.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether value is an array-like object containing only symbol primitives
+	*
+	* @example
+	* var bool = isSymbolArray.primitives( [ Symbol( 'abc' ), Symbol( 'def' ) ] );
+	* // returns true
+	*
+	* @example
+	* var bool = isSymbolArray.primitives( [ Symbol( 'abc' ), Object( Symbol( 'def' ) ) ] );
+	* // returns false
+	*/
+	primitives( value: any ): value is ArrayLike<symbol>;
+
+	/**
+	* Tests if a value is an array-like object containing only `Symbol` objects.
+	*
+	*
+	* ## Notes
+	*
+	* -   In pre-ES2015 environments, the function always returns `false`.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether a value is an array-like object containing only `Symbol` objects
+	*
+	* @example
+	* var bool = isSymbolArray.objects( [ Object( Symbol( 'abc' ) ), Object( Symbol( 'def' ) ) ] );
+	* // returns true
+	*
+	* @example
+	* var bool = isSymbolArray.objects( [ Symbol( 'abc' ), Symbol( 'def' ) ] );
+	* // returns false
+	*/
+	objects( value: any ): value is ArrayLike<Symbol>;
+}
+
+/**
+* Tests if a value is an array-like object containing only symbols.
+*
+* ## Notes
+*
+* -   In pre-ES2015 environments, the function always returns `false`.
+*
+* @param value - value to test
+* @returns boolean indicating whether value is an array-like object containing only symbols
+*
+* @example
+* var bool = isSymbolArray( [ Symbol( 'abc' ), Symbol( 'def' ) ] );
+* // returns true
+*
+* @example
+* var bool = isSymbolArray( [ Symbol( 'abc' ), 'def' ] );
+* // returns false
+*
+* @example
+* var bool = isSymbolArray.primitives( [ Symbol( 'abc' ), Symbol( 'def' ) ] );
+* // returns true
+*
+* @example
+* var bool = isSymbolArray.objects( [ Object( Symbol( 'abc' ) ), Object( Symbol( 'def' ) ) ] );
+* // returns true
+*/
+declare var isSymbolArray: IsSymbolArray;
+
+
+// EXPORTS //
+
+export = isSymbolArray;

package/is-symbol-array/docs/types/test.ts

@@ -0,0 +1,60 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 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 isSymbolArray = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isSymbolArray( [ Symbol( 'abc' ) ] ); // $ExpectType boolean
+	isSymbolArray( [ 2 ] ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isSymbolArray(); // $ExpectError
+	isSymbolArray( [ Symbol( 'abc' ) ], 10.23 ); // $ExpectError
+}
+
+// Attached to main export is a `primitives` method which returns a boolean...
+{
+	// eslint-disable-next-line no-new-wrappers
+	isSymbolArray.primitives( [ Object( Symbol( 'abc' ) ) ] ); // $ExpectType boolean
+	isSymbolArray.primitives( [ Symbol( 'abc' ) ] ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the `primitives` method is provided an unsupported number of arguments...
+{
+	isSymbolArray.primitives(); // $ExpectError
+	isSymbolArray.primitives( [ Symbol( 'abc' ) ], 123 ); // $ExpectError
+}
+
+// Attached to main export is an `objects` method which returns a boolean...
+{
+	// eslint-disable-next-line no-new-wrappers
+	isSymbolArray.objects( [ Object( Symbol( 'abc' ) ) ] ); // $ExpectType boolean
+	isSymbolArray.objects( [ Symbol( 'abc' ) ] ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the `objects` method is provided an unsupported number of arguments...
+{
+	isSymbolArray.objects(); // $ExpectError
+	isSymbolArray.objects( [ Symbol( 'abc' ) ], 123 ); // $ExpectError
+}

package/is-symbol-array/lib/index.js

@@ -0,0 +1,76 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+/**
+* Test if a value is an array-like object containing only symbols.
+*
+* @module @stdlib/assert/is-symbol-array
+*
+* @example
+* var isSymbolArray = require( '@stdlib/assert/is-symbol-array' );
+*
+* var bool = isSymbolArray( [ Symbol( 'abc' ), Symbol( 'def' ) ] );
+* // returns true
+*
+* bool = isSymbolArray( [ Symbol( 'abc' ), 'def' ] );
+* // returns false
+*
+* @example
+* var isSymbolArray = require( '@stdlib/assert/is-symbol-array' ).primitives;
+*
+* var bool = isSymbolArray( [ Symbol( 'abc' ), Symbol( 'def' ) ] );
+* // returns true
+*
+* bool = isSymbolArray( [ Symbol( 'abc' ), Object( Symbol( 'def' ) ) ] );
+* // returns false
+*
+* @example
+* var isSymbolArray = require( '@stdlib/assert/is-symbol-array' ).objects;
+*
+* var bool = isSymbolArray( [ Object( Symbol( 'abc' ) ), Object( Symbol( 'def' ) ) ] );
+* // returns true
+*
+* bool = isSymbolArray( [ Symbol( 'abc' ), Symbol( 'def' ) ] );
+* // returns false
+*/
+
+// MODULES //
+
+var setReadOnly = require( '@ohos-ports/stdlib-utils/define-nonenumerable-read-only-property' );
+var arrayfun = require( './../../tools/array-like-function' );
+var isSymbol = require( './../../is-symbol' );
+
+
+// VARIABLES //
+
+var isPrimitiveArray = arrayfun( isSymbol.isPrimitive );
+var isObjectArray = arrayfun( isSymbol.isObject );
+
+
+// MAIN //
+
+var isSymbolArray = arrayfun( isSymbol );
+setReadOnly( isSymbolArray, 'primitives', isPrimitiveArray );
+setReadOnly( isSymbolArray, 'objects', isObjectArray );
+
+
+// EXPORTS //
+
+module.exports = isSymbolArray;

package/is-symbol-array/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@stdlib/assert/is-symbol-array",
+  "version": "0.0.0",
+  "description": "Test if a value is an array-like object containing only symbols.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "./lib",
+  "directories": {
+    "benchmark": "./benchmark",
+    "doc": "./docs",
+    "example": "./examples",
+    "lib": "./lib",
+    "test": "./test"
+  },
+  "types": "./docs/types",
+  "scripts": {},
+  "homepage": "https://github.com/stdlib-js/stdlib",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/stdlib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {},
+  "devDependencies": {},
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "stdassert",
+    "assertion",
+    "assert",
+    "utilities",
+    "utility",
+    "utils",
+    "util",
+    "function",
+    "array",
+    "array-like",
+    "symbol",
+    "sym",
+    "is",
+    "issymbol",
+    "isarray",
+    "isarraylike",
+    "type",
+    "check",
+    "valid",
+    "validate",
+    "test"
+  ]
+}

package/is-symmetric-matrix/README.md

@@ -0,0 +1,111 @@
+<!--
+
+@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.
+
+-->
+
+# isSymmetricMatrix
+
+> Test if a value is a [symmetric matrix][symmetric-matrix].
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var isSymmetricMatrix = require( '@stdlib/assert/is-symmetric-matrix' );
+```
+
+#### isSymmetricMatrix( value )
+
+Tests if a value is a [symmetric matrix][symmetric-matrix].
+
+```javascript
+var ndarray = require( '@stdlib/ndarray/ctor' );
+
+var arr = ndarray( 'generic', [ 0, 1, 1, 2 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+var bool = isSymmetricMatrix( arr );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var ndarray = require( '@stdlib/ndarray/ctor' );
+var isSymmetricMatrix = require( '@stdlib/assert/is-symmetric-matrix' );
+
+var arr = ndarray( 'generic', [ 0, 1, 1, 2 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+var out = isSymmetricMatrix( arr );
+// returns true
+
+out = isSymmetricMatrix( [ 1, 2, 3, 4 ] );
+// returns false
+
+out = isSymmetricMatrix( {} );
+// returns false
+
+out = isSymmetricMatrix( null );
+// returns 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/is-matrix-like`][@stdlib/assert/is-matrix-like]</span><span class="delimiter">: </span><span class="description">test if a value is a 2-dimensional ndarray-like object.</span>
+-   <span class="package-name">[`@stdlib/assert/is-nonsymmetric-matrix`][@stdlib/assert/is-nonsymmetric-matrix]</span><span class="delimiter">: </span><span class="description">test if a value is a non-symmetric matrix.</span>
+-   <span class="package-name">[`@stdlib/assert/is-square-matrix`][@stdlib/assert/is-square-matrix]</span><span class="delimiter">: </span><span class="description">test if a value is a 2-dimensional ndarray-like object having equal dimensions.</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">
+
+[symmetric-matrix]: https://en.wikipedia.org/wiki/Symmetric_matrix
+
+<!-- <related-links> -->
+
+[@stdlib/assert/is-matrix-like]: https://github.com/stdlib-js/assert/tree/main/is-matrix-like
+
+[@stdlib/assert/is-nonsymmetric-matrix]: https://github.com/stdlib-js/assert/tree/main/is-nonsymmetric-matrix
+
+[@stdlib/assert/is-square-matrix]: https://github.com/stdlib-js/assert/tree/main/is-square-matrix
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

package/is-symmetric-matrix/docs/repl.txt

@@ -0,0 +1,32 @@
+
+{{alias}}( value )
+    Tests if a value is a square matrix which equals its transpose.
+
+    Parameters
+    ----------
+    value: any
+        Value to test.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating whether a value is a symmetric matrix.
+
+    Examples
+    --------
+    > var buf = [ 0, 1, 1, 2 ];
+    > var sh = [ 2, 2 ];
+    > var st = [ 2, 1 ];
+    > var M = {{alias:@stdlib/ndarray/ctor}}( 'generic', buf, sh, st, 0, 'row-major' );
+    > var bool = {{alias}}( M )
+    true
+    > bool = {{alias}}( [ 1, 2, 3, 4 ] )
+    false
+    > bool = {{alias}}( 3.14 )
+    false
+    > bool = {{alias}}( {} )
+    false
+
+    See Also
+    --------
+

package/is-symmetric-matrix/docs/types/index.d.ts

@@ -0,0 +1,47 @@
+/*
+* @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: 4.1
+
+/**
+* Tests if a value is a symmetric matrix.
+*
+* ## Notes
+*
+* -   The implementation must rely on manually checking that \\(M_{ij} = M_{ji}\\), 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 symmetric matrix
+*
+* @example
+* var ndarray = require( '@stdlib/ndarray/ctor' );
+*
+* var arr = ndarray( 'generic', [ 0, 1, 1, 2 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+* var bool = isSymmetricMatrix( arr );
+* // returns true
+*
+* bool = isSymmetricMatrix( [] );
+* // returns false
+*/
+declare function isSymmetricMatrix( v: any ): boolean;
+
+
+// EXPORTS //
+
+export = isSymmetricMatrix;

package/is-symmetric-matrix/docs/types/test.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.
+*/
+
+/* eslint-disable @typescript-eslint/no-invalid-this */
+
+import isSymmetricMatrix = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	const matrix =	{
+		'data': [ 0, 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;
+		}
+	};
+	isSymmetricMatrix( matrix ); // $ExpectType boolean
+	isSymmetricMatrix( [] ); // $ExpectType boolean
+	isSymmetricMatrix( false ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isSymmetricMatrix(); // $ExpectError
+}

package/is-symmetric-matrix/lib/index.js

@@ -0,0 +1,45 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+/**
+* Test if a value is a symmetric matrix.
+*
+* @module @stdlib/assert/is-symmetric-matrix
+*
+* @example
+* var ndarray = require( '@stdlib/ndarray/ctor' );
+* var isSymmetricMatrix = require( '@stdlib/assert/is-symmetric-matrix' );
+*
+* var arr = ndarray( 'generic', [ 0, 1, 1, 2 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+* var bool = isSymmetricMatrix( arr );
+* // returns true
+*
+* bool = isSymmetricMatrix( [] );
+* // returns false
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;

package/is-symmetric-matrix/lib/main.js

@@ -0,0 +1,70 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var isSquareMatrix = require( './../../is-square-matrix' );
+
+
+// MAIN //
+
+/**
+* Tests if a value is a symmetric matrix.
+*
+* ## Notes
+*
+* -   The implementation must rely on manually checking that \\(M_{ij} = M_{ji}\\), 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} boolean indicating if a value is a symmetric matrix
+*
+* @example
+* var ndarray = require( '@stdlib/ndarray/ctor' );
+*
+* var arr = ndarray( 'generic', [ 0, 1, 1, 2 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+* var bool = isSymmetricMatrix( arr );
+* // returns true
+*
+* bool = isSymmetricMatrix( [] );
+* // returns false
+*/
+function isSymmetricMatrix( v ) {
+	var M;
+	var i;
+	var j;
+	if ( !isSquareMatrix( v ) ) {
+		return false;
+	}
+	M = v.shape[ 0 ];
+	for ( i = 0; i < M; i++ ) {
+		for ( j = 0; j < i; j++ ) {
+			if ( v.get( i, j ) !== v.get( j, i ) ) {
+				return false;
+			}
+		}
+	}
+	return true;
+}
+
+
+// EXPORTS //
+
+module.exports = isSymmetricMatrix;