Skip to content

Commit b8bd516

Browse files
feat: update namespace TypeScript declarations
PR-URL: #2351 Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent b6edfd8 commit b8bd516

File tree

3 files changed

+442
-2
lines changed

3 files changed

+442
-2
lines changed

lib/node_modules/@stdlib/blas/base/assert/docs/types/index.d.ts

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,66 @@
2121
/* eslint-disable max-lines */
2222

2323
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' );
2426

2527
/**
2628
* Interface describing the `assert` namespace.
2729
*/
2830
interface Namespace {
2931
/**
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
3146
*/
3247
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;
3384
}
3485

3586
/**

0 commit comments

Comments
 (0)