|
21 | 21 | /* eslint-disable max-lines */
|
22 | 22 |
|
23 | 23 | import isLayout = require( '@stdlib/blas/base/assert/is-layout' );
|
| 24 | +import isMatrixTriangle = require( '@stdlib/blas/base/assert/is-matrix-triangle' ); |
| 25 | +import isTransposeOperation = require( '@stdlib/blas/base/assert/is-transpose-operation' ); |
24 | 26 |
|
25 | 27 | /**
|
26 | 28 | * Interface describing the `assert` namespace.
|
27 | 29 | */
|
28 | 30 | interface Namespace {
|
29 | 31 | /**
|
30 |
| - * TODO |
| 32 | + * Tests whether an input value is a BLAS memory layout. |
| 33 | + * |
| 34 | + * @param v - value to test |
| 35 | + * @returns boolean indicating whether an input value is a memory layout |
| 36 | + * |
| 37 | + * @example |
| 38 | + * var bool = ns.isLayout( 'row-major' ); |
| 39 | + * // returns true |
| 40 | + * |
| 41 | + * bool = ns.isLayout( 'column-major' ); |
| 42 | + * // returns true |
| 43 | + * |
| 44 | + * bool = ns.isLayout( 'foo' ); |
| 45 | + * // returns false |
31 | 46 | */
|
32 | 47 | isLayout: typeof isLayout;
|
| 48 | + |
| 49 | + /** |
| 50 | + * Tests whether an input value is a BLAS matrix triangle. |
| 51 | + * |
| 52 | + * @param v - value to test |
| 53 | + * @returns boolean indicating whether an input value is a matrix triangle |
| 54 | + * |
| 55 | + * @example |
| 56 | + * var bool = ns.isMatrixTriangle( 'lower' ); |
| 57 | + * // returns true |
| 58 | + * |
| 59 | + * bool = ns.isMatrixTriangle( 'upper' ); |
| 60 | + * // returns true |
| 61 | + * |
| 62 | + * bool = ns.isMatrixTriangle( 'foo' ); |
| 63 | + * // returns false |
| 64 | + */ |
| 65 | + isMatrixTriangle: typeof isMatrixTriangle; |
| 66 | + |
| 67 | + /** |
| 68 | + * Tests whether an input value is a BLAS transpose operation. |
| 69 | + * |
| 70 | + * @param v - value to test |
| 71 | + * @returns boolean indicating whether an input value is a transpose operation |
| 72 | + * |
| 73 | + * @example |
| 74 | + * var bool = ns.isTransposeOperation( 'transpose' ); |
| 75 | + * // returns true |
| 76 | + * |
| 77 | + * bool = ns.isTransposeOperation( 'conjugate-transpose' ); |
| 78 | + * // returns true |
| 79 | + * |
| 80 | + * bool = ns.isTransposeOperation( 'foo' ); |
| 81 | + * // returns false |
| 82 | + */ |
| 83 | + isTransposeOperation: typeof isTransposeOperation; |
33 | 84 | }
|
34 | 85 |
|
35 | 86 | /**
|
|
0 commit comments