Skip to content

feat: update namespace TypeScript declarations #2514

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
Jul 5, 2024
Merged
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
201 changes: 201 additions & 0 deletions lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ import daxpy = require( '@stdlib/blas/base/daxpy' );
import dcabs1 = require( '@stdlib/blas/base/dcabs1' );
import dcopy = require( '@stdlib/blas/base/dcopy' );
import ddot = require( '@stdlib/blas/base/ddot' );
import diagonalTypeEnum2Str = require( '@stdlib/blas/base/diagonal-type-enum2str' );
import diagonalTypeResolveEnum = require( '@stdlib/blas/base/diagonal-type-resolve-enum' );
import diagonalTypeResolveStr = require( '@stdlib/blas/base/diagonal-type-resolve-str' );
import diagonalTypeStr2Enum = require( '@stdlib/blas/base/diagonal-type-str2enum' );
import diagonalTypes = require( '@stdlib/blas/base/diagonal-types' );
import dnrm2 = require( '@stdlib/blas/base/dnrm2' );
import drotg = require( '@stdlib/blas/base/drotg' );
Expand All @@ -49,7 +53,15 @@ import layoutResolveEnum = require( '@stdlib/blas/base/layout-resolve-enum' );
import layoutResolveStr = require( '@stdlib/blas/base/layout-resolve-str' );
import layoutStr2Enum = require( '@stdlib/blas/base/layout-str2enum' );
import layouts = require( '@stdlib/blas/base/layouts' );
import matrixTriangleEnum2Str = require( '@stdlib/blas/base/matrix-triangle-enum2str' );
import matrixTriangleResolveEnum = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' );
import matrixTriangleResolveStr = require( '@stdlib/blas/base/matrix-triangle-resolve-str' );
import matrixTriangleStr2Enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' );
import matrixTriangles = require( '@stdlib/blas/base/matrix-triangles' );
import operationSideEnum2Str = require( '@stdlib/blas/base/operation-side-enum2str' );
import operationSideResolveEnum = require( '@stdlib/blas/base/operation-side-resolve-enum' );
import operationSideResolveStr = require( '@stdlib/blas/base/operation-side-resolve-str' );
import operationSideStr2Enum = require( '@stdlib/blas/base/operation-side-str2enum' );
import operationSides = require( '@stdlib/blas/base/operation-sides' );
import sasum = require( '@stdlib/blas/base/sasum' );
import saxpy = require( '@stdlib/blas/base/saxpy' );
Expand Down Expand Up @@ -378,6 +390,69 @@ interface Namespace {
*/
ddot: typeof ddot;

/**
* Returns the BLAS diagonal type string associated with a BLAS diagonal type enumeration constant.
*
* @param value - enumeration constant
* @returns diagonal type string
*
* @example
* var str2enum = require( '@stdlib/blas/base/diagonal-type-str2enum' );
*
* var v = str2enum( 'unit' );
* // returns <number>
*
* var s = ns.diagonalTypeEnum2Str( v );
* // returns 'unit'
*/
diagonalTypeEnum2Str: typeof diagonalTypeEnum2Str;

/**
* Returns the enumeration constant associated with a BLAS diagonal type value.
*
* ## Notes
*
* - Downstream consumers of this function should **not** rely on specific integer values (e.g., `UNIT == 0`). Instead, the function should be used in an opaque manner.
*
* @param value - diagonal type value
* @returns enumeration constant
*
* @example
* var v = ns.diagonalTypeResolveEnum( 'non-unit' );
* // returns <number>
*/
diagonalTypeResolveEnum: typeof diagonalTypeResolveEnum;

/**
* Returns the diagonal type string associated with a BLAS diagonal type value.
*
* @param value - diagonal type value
* @returns diagonal type string
*
* @example
* var str2enum = require( '@stdlib/blas/base/diagonal-type-str2enum' );
*
* var v = ns.diagonalTypeResolveStr( str2enum( 'unit' ) );
* // returns 'unit'
*/
diagonalTypeResolveStr: typeof diagonalTypeResolveStr;

/**
* Returns the enumeration constant associated with a BLAS diagonal type.
*
* ## Notes
*
* - Downstream consumers of this function should **not** rely on specific integer values (e.g., `UNIT == 0`). Instead, the function should be used in an opaque manner.
*
* @param diagonal - diagonal type
* @returns enumeration constant
*
* @example
* var v = ns.diagonalTypeStr2Enum( 'unit' );
* // returns <number>
*/
diagonalTypeStr2Enum: typeof diagonalTypeStr2Enum;

/**
* Returns a list of diagonal element types.
*
Expand Down Expand Up @@ -827,6 +902,69 @@ interface Namespace {
*/
layouts: typeof layouts;

/**
* Returns the BLAS matrix triangle string associated with a BLAS matrix triangle enumeration constant.
*
* @param value - enumeration constant
* @returns matrix triangle string
*
* @example
* var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' );
*
* var v = str2enum( 'upper' );
* // returns <number>
*
* var s = ns.matrixTriangleEnum2Str( v );
* // returns 'upper'
*/
matrixTriangleEnum2Str: typeof matrixTriangleEnum2Str;

/**
* Returns the enumeration constant associated with a BLAS matrix triangle value.
*
* ## Notes
*
* - Downstream consumers of this function should **not** rely on specific integer values (e.g., `UPPER == 0`). Instead, the function should be used in an opaque manner.
*
* @param value - matrix triangle value
* @returns enumeration constant
*
* @example
* var v = ns.matrixTriangleResolveEnum( 'lower' );
* // returns <number>
*/
matrixTriangleResolveEnum: typeof matrixTriangleResolveEnum;

/**
* Returns the matrix triangle string associated with a BLAS matrix triangle value.
*
* @param value - matrix triangle value
* @returns matrix triangle string
*
* @example
* var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' );
*
* var v = ns.matrixTriangleResolveStr( str2enum( 'upper' ) );
* // returns 'upper'
*/
matrixTriangleResolveStr: typeof matrixTriangleResolveStr;

/**
* Returns the enumeration constant associated with a BLAS matrix triangle.
*
* ## Notes
*
* - Downstream consumers of this function should **not** rely on specific integer values (e.g., `UPPER == 0`). Instead, the function should be used in an opaque manner.
*
* @param value - matrix triangle string
* @returns enumeration constant
*
* @example
* var v = ns.matrixTriangleStr2Enum( 'upper' );
* // returns <number>
*/
matrixTriangleStr2Enum: typeof matrixTriangleStr2Enum;

/**
* Returns a list of matrix triangles.
*
Expand All @@ -838,6 +976,69 @@ interface Namespace {
*/
matrixTriangles: typeof matrixTriangles;

/**
* Returns the BLAS operation side string associated with a BLAS operation side enumeration constant.
*
* @param operation - enumeration constant
* @returns operation string
*
* @example
* var str2enum = require( '@stdlib/blas/base/operation-side-str2enum' );
*
* var v = str2enum( 'left' );
* // returns <number>
*
* var s = ns.operationSideEnum2Str( v );
* // returns 'left'
*/
operationSideEnum2Str: typeof operationSideEnum2Str;

/**
* Returns the enumeration constant associated with a BLAS operation side value.
*
* ## Notes
*
* - Downstream consumers of this function should **not** rely on specific integer values (e.g., `LEFT == 0`). Instead, the function should be used in an opaque manner.
*
* @param operation - operation value
* @returns enumeration constant
*
* @example
* var v = ns.operationSideResolveEnum( 'right' );
* // returns <number>
*/
operationSideResolveEnum: typeof operationSideResolveEnum;

/**
* Returns the operation side string associated with a BLAS operation side value.
*
* @param operation - operation value
* @returns operation side string
*
* @example
* var str2enum = require( '@stdlib/blas/base/operation-side-str2enum' );
*
* var v = ns.operationSideResolveStr( str2enum( 'left' ) );
* // returns 'left'
*/
operationSideResolveStr: typeof operationSideResolveStr;

/**
* Returns the enumeration constant associated with a BLAS operation side.
*
* ## Notes
*
* - Downstream consumers of this function should **not** rely on specific integer values (e.g., `LEFT == 0`). Instead, the function should be used in an opaque manner.
*
* @param operation - operation side
* @returns enumeration constant
*
* @example
* var v = ns.operationSideStr2Enum( 'left' );
* // returns <number>
*/
operationSideStr2Enum: typeof operationSideStr2Enum;

/**
* Returns a list of operation sides.
*
Expand Down
Loading