@stdlib/assert-is-square-matrix

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


Keywords
stdlib, stdassert, assertion, assert, utilities, utility, utils, util, is, isndarray, ndarray, ndarray-like, matrix, ismatrix, 2d, square, validate, isvalid, test, type, check, javascript, node, node-js, nodejs
License
Apache-2.0
Install
npm install @stdlib/assert-is-square-matrix@0.0.5

Documentation

isSquareMatrix

NPM version Build Status Coverage Status dependencies

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.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.