Skip to content

feat: update namespace TypeScript declarations #2351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 52 additions & 1 deletion lib/node_modules/@stdlib/blas/base/assert/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,66 @@
/* eslint-disable max-lines */

import isLayout = require( '@stdlib/blas/base/assert/is-layout' );
import isMatrixTriangle = require( '@stdlib/blas/base/assert/is-matrix-triangle' );
import isTransposeOperation = require( '@stdlib/blas/base/assert/is-transpose-operation' );

/**
* Interface describing the `assert` namespace.
*/
interface Namespace {
/**
* TODO
* Tests whether an input value is a BLAS memory layout.
*
* @param v - value to test
* @returns boolean indicating whether an input value is a memory layout
*
* @example
* var bool = ns.isLayout( 'row-major' );
* // returns true
*
* bool = ns.isLayout( 'column-major' );
* // returns true
*
* bool = ns.isLayout( 'foo' );
* // returns false
*/
isLayout: typeof isLayout;

/**
* Tests whether an input value is a BLAS matrix triangle.
*
* @param v - value to test
* @returns boolean indicating whether an input value is a matrix triangle
*
* @example
* var bool = ns.isMatrixTriangle( 'lower' );
* // returns true
*
* bool = ns.isMatrixTriangle( 'upper' );
* // returns true
*
* bool = ns.isMatrixTriangle( 'foo' );
* // returns false
*/
isMatrixTriangle: typeof isMatrixTriangle;

/**
* Tests whether an input value is a BLAS transpose operation.
*
* @param v - value to test
* @returns boolean indicating whether an input value is a transpose operation
*
* @example
* var bool = ns.isTransposeOperation( 'transpose' );
* // returns true
*
* bool = ns.isTransposeOperation( 'conjugate-transpose' );
* // returns true
*
* bool = ns.isTransposeOperation( 'foo' );
* // returns false
*/
isTransposeOperation: typeof isTransposeOperation;
}

/**
Expand Down
Loading
Loading