Package Exports

@stdlib/assert-is-square-matrix

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/assert-is-square-matrix) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

isSquareMatrix

Test if a value is a 2-dimensional ndarray-like object having equal dimensions.

Installation

npm install @stdlib/assert-is-square-matrix

Usage

var isSquareMatrix = require( '@stdlib/assert-is-square-matrix' );

isSquareMatrix( value )

Tests if a value is a 2-dimensional ndarray-like object having equal dimensions.

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

Examples

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

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

License

See LICENSE.

@stdlib/assert-is-square-matrix