main.js (1365B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MODULES // 22 23 var isMatrixLike = require( './../../is-matrix-like' ); 24 25 26 // MAIN // 27 28 /** 29 * Tests if a value is a 2-dimensional ndarray-like object having equal dimensions. 30 * 31 * @param {*} v - value to test 32 * @returns {boolean} boolean indicating if a value is a 2-dimensional ndarray-like object having equal dimensions 33 * 34 * @example 35 * var ndarray = require( '@stdlib/ndarray/ctor' ); 36 * 37 * var arr = ndarray( 'generic', [ 0, 0, 0, 0 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' ); 38 * var bool = isSquareMatrix( arr ); 39 * // returns true 40 * 41 * bool = isSquareMatrix( [] ); 42 * // returns false 43 */ 44 function isSquareMatrix( v ) { 45 return ( 46 isMatrixLike( v ) && 47 v.shape[ 0 ] === v.shape[ 1 ] 48 ); 49 } 50 51 52 // EXPORTS // 53 54 module.exports = isSquareMatrix;