@stdlib/assert-is-square-matrix
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.5 • Public • Published

    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.

    Install

    npm i @stdlib/assert-is-square-matrix

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    29

    Version

    0.0.5

    License

    Apache-2.0

    Unpacked Size

    36.2 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser