time-to-botec/js/node_modules/@stdlib/assert/is-symmetric-matrix/lib/index.js

46 lines
1.2 KiB
JavaScript
Raw Normal View History

/**
* @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';
/**
* Test if a value is a symmetric matrix.
*
* @module @stdlib/assert/is-symmetric-matrix
*
* @example
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var isSymmetricMatrix = require( '@stdlib/assert/is-symmetric-matrix' );
*
* var arr = ndarray( 'generic', [ 0, 1, 1, 2 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
* var bool = isSymmetricMatrix( arr );
* // returns true
*
* bool = isSymmetricMatrix( [] );
* // returns false
*/
// MODULES //
var isSymmetricMatrix = require( './main.js' );
// EXPORTS //
module.exports = isSymmetricMatrix;