55 lines
1.3 KiB
JavaScript
55 lines
1.3 KiB
JavaScript
/**
|
|
* @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 isMatrixLike = require( './../../is-matrix-like' );
|
|
|
|
|
|
// MAIN //
|
|
|
|
/**
|
|
* Tests if a value is a 2-dimensional ndarray-like object having equal dimensions.
|
|
*
|
|
* @param {*} v - 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
|
|
*/
|
|
function isSquareMatrix( v ) {
|
|
return (
|
|
isMatrixLike( v ) &&
|
|
v.shape[ 0 ] === v.shape[ 1 ]
|
|
);
|
|
}
|
|
|
|
|
|
// EXPORTS //
|
|
|
|
module.exports = isSquareMatrix;
|