Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Functions

Export assignment isNonSymmetricMatrix

  • isNonSymmetricMatrix(v: any): boolean
  • Tests if a value is a non-symmetric matrix.

    Notes

    • The implementation must rely on manually checking that \(M_{ij} \neq M_{ji}\), and, while element access is deterministic, no way exists to prevent cache misses outside of reordering the underlying matrix elements, thus incurring a larger performance penalty than just "jumping around" in a single pass.
    • Worst case scenario: O(N^2).

    Parameters

    • v: any

      value to test

    Returns boolean

    boolean indicating if a value is a non-symmetric matrix

    Example

    var ndarray = require( `@stdlib/ndarray/ctor` );
    
    var arr = ndarray( 'generic', [ 1, 2, 3, 4 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
    var bool = isNonSymmetricMatrix( arr );
    // returns true
    
    bool = isNonSymmetricMatrix( [] );
    // returns false