84 lines
1.8 KiB
Markdown
84 lines
1.8 KiB
Markdown
<!--
|
|
|
|
@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.
|
|
|
|
-->
|
|
|
|
# isSquareMatrix
|
|
|
|
> Test if a value is a 2-dimensional [ndarray][@stdlib/ndarray/ctor]-like object having equal dimensions.
|
|
|
|
<section class="usage">
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var isSquareMatrix = require( '@stdlib/assert/is-square-matrix' );
|
|
```
|
|
|
|
#### isSquareMatrix( value )
|
|
|
|
Tests if a value is a 2-dimensional [ndarray][@stdlib/ndarray/ctor]-like object having equal dimensions.
|
|
|
|
```javascript
|
|
var ndarray = require( '@stdlib/ndarray/ctor' );
|
|
|
|
var arr = ndarray( 'generic', [ 0, 0, 0, 0 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
|
|
var bool = isSquareMatrix( arr );
|
|
// returns true
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```javascript
|
|
var ndarray = require( '@stdlib/ndarray/ctor' );
|
|
var isSquareMatrix = require( '@stdlib/assert/is-square-matrix' );
|
|
|
|
var arr = ndarray( 'generic', [ 0, 0, 0, 0 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
|
|
var out = isSquareMatrix( arr );
|
|
// returns true
|
|
|
|
out = isSquareMatrix( [ 1, 2, 3, 4 ] );
|
|
// returns false
|
|
|
|
out = isSquareMatrix( {} );
|
|
// returns false
|
|
|
|
out = isSquareMatrix( null );
|
|
// returns false
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
<section class="links">
|
|
|
|
[@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|