External module "assert/is-square-matrix/docs/types/index.d"

Export assignment isSquareMatrix

• isSquareMatrix(v: any): boolean

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

  Parameters

  • v: any

    value to test

  Returns boolean

  boolean indicating if a value is a 2-dimensional ndarray-like object having equal dimensions

  Example

  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
  
  bool = isSquareMatrix( [] );
  // returns false