Skip to content

Commit dd73ff2

Browse files
stdlib-botkgryte
stdlib-bot
and
kgryte
authored
feat: update namespace TypeScript declarations
PR-URL: #2514 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 4d3d36e commit dd73ff2

File tree

1 file changed

+201
-0
lines changed
  • lib/node_modules/@stdlib/blas/base/docs/types

1 file changed

+201
-0
lines changed

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

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ import daxpy = require( '@stdlib/blas/base/daxpy' );
2929
import dcabs1 = require( '@stdlib/blas/base/dcabs1' );
3030
import dcopy = require( '@stdlib/blas/base/dcopy' );
3131
import ddot = require( '@stdlib/blas/base/ddot' );
32+
import diagonalTypeEnum2Str = require( '@stdlib/blas/base/diagonal-type-enum2str' );
33+
import diagonalTypeResolveEnum = require( '@stdlib/blas/base/diagonal-type-resolve-enum' );
34+
import diagonalTypeResolveStr = require( '@stdlib/blas/base/diagonal-type-resolve-str' );
35+
import diagonalTypeStr2Enum = require( '@stdlib/blas/base/diagonal-type-str2enum' );
3236
import diagonalTypes = require( '@stdlib/blas/base/diagonal-types' );
3337
import dnrm2 = require( '@stdlib/blas/base/dnrm2' );
3438
import drotg = require( '@stdlib/blas/base/drotg' );
@@ -49,7 +53,15 @@ import layoutResolveEnum = require( '@stdlib/blas/base/layout-resolve-enum' );
4953
import layoutResolveStr = require( '@stdlib/blas/base/layout-resolve-str' );
5054
import layoutStr2Enum = require( '@stdlib/blas/base/layout-str2enum' );
5155
import layouts = require( '@stdlib/blas/base/layouts' );
56+
import matrixTriangleEnum2Str = require( '@stdlib/blas/base/matrix-triangle-enum2str' );
57+
import matrixTriangleResolveEnum = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' );
58+
import matrixTriangleResolveStr = require( '@stdlib/blas/base/matrix-triangle-resolve-str' );
59+
import matrixTriangleStr2Enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' );
5260
import matrixTriangles = require( '@stdlib/blas/base/matrix-triangles' );
61+
import operationSideEnum2Str = require( '@stdlib/blas/base/operation-side-enum2str' );
62+
import operationSideResolveEnum = require( '@stdlib/blas/base/operation-side-resolve-enum' );
63+
import operationSideResolveStr = require( '@stdlib/blas/base/operation-side-resolve-str' );
64+
import operationSideStr2Enum = require( '@stdlib/blas/base/operation-side-str2enum' );
5365
import operationSides = require( '@stdlib/blas/base/operation-sides' );
5466
import sasum = require( '@stdlib/blas/base/sasum' );
5567
import saxpy = require( '@stdlib/blas/base/saxpy' );
@@ -378,6 +390,69 @@ interface Namespace {
378390
*/
379391
ddot: typeof ddot;
380392

393+
/**
394+
* Returns the BLAS diagonal type string associated with a BLAS diagonal type enumeration constant.
395+
*
396+
* @param value - enumeration constant
397+
* @returns diagonal type string
398+
*
399+
* @example
400+
* var str2enum = require( '@stdlib/blas/base/diagonal-type-str2enum' );
401+
*
402+
* var v = str2enum( 'unit' );
403+
* // returns <number>
404+
*
405+
* var s = ns.diagonalTypeEnum2Str( v );
406+
* // returns 'unit'
407+
*/
408+
diagonalTypeEnum2Str: typeof diagonalTypeEnum2Str;
409+
410+
/**
411+
* Returns the enumeration constant associated with a BLAS diagonal type value.
412+
*
413+
* ## Notes
414+
*
415+
* - 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.
416+
*
417+
* @param value - diagonal type value
418+
* @returns enumeration constant
419+
*
420+
* @example
421+
* var v = ns.diagonalTypeResolveEnum( 'non-unit' );
422+
* // returns <number>
423+
*/
424+
diagonalTypeResolveEnum: typeof diagonalTypeResolveEnum;
425+
426+
/**
427+
* Returns the diagonal type string associated with a BLAS diagonal type value.
428+
*
429+
* @param value - diagonal type value
430+
* @returns diagonal type string
431+
*
432+
* @example
433+
* var str2enum = require( '@stdlib/blas/base/diagonal-type-str2enum' );
434+
*
435+
* var v = ns.diagonalTypeResolveStr( str2enum( 'unit' ) );
436+
* // returns 'unit'
437+
*/
438+
diagonalTypeResolveStr: typeof diagonalTypeResolveStr;
439+
440+
/**
441+
* Returns the enumeration constant associated with a BLAS diagonal type.
442+
*
443+
* ## Notes
444+
*
445+
* - 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.
446+
*
447+
* @param diagonal - diagonal type
448+
* @returns enumeration constant
449+
*
450+
* @example
451+
* var v = ns.diagonalTypeStr2Enum( 'unit' );
452+
* // returns <number>
453+
*/
454+
diagonalTypeStr2Enum: typeof diagonalTypeStr2Enum;
455+
381456
/**
382457
* Returns a list of diagonal element types.
383458
*
@@ -827,6 +902,69 @@ interface Namespace {
827902
*/
828903
layouts: typeof layouts;
829904

905+
/**
906+
* Returns the BLAS matrix triangle string associated with a BLAS matrix triangle enumeration constant.
907+
*
908+
* @param value - enumeration constant
909+
* @returns matrix triangle string
910+
*
911+
* @example
912+
* var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' );
913+
*
914+
* var v = str2enum( 'upper' );
915+
* // returns <number>
916+
*
917+
* var s = ns.matrixTriangleEnum2Str( v );
918+
* // returns 'upper'
919+
*/
920+
matrixTriangleEnum2Str: typeof matrixTriangleEnum2Str;
921+
922+
/**
923+
* Returns the enumeration constant associated with a BLAS matrix triangle value.
924+
*
925+
* ## Notes
926+
*
927+
* - 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.
928+
*
929+
* @param value - matrix triangle value
930+
* @returns enumeration constant
931+
*
932+
* @example
933+
* var v = ns.matrixTriangleResolveEnum( 'lower' );
934+
* // returns <number>
935+
*/
936+
matrixTriangleResolveEnum: typeof matrixTriangleResolveEnum;
937+
938+
/**
939+
* Returns the matrix triangle string associated with a BLAS matrix triangle value.
940+
*
941+
* @param value - matrix triangle value
942+
* @returns matrix triangle string
943+
*
944+
* @example
945+
* var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' );
946+
*
947+
* var v = ns.matrixTriangleResolveStr( str2enum( 'upper' ) );
948+
* // returns 'upper'
949+
*/
950+
matrixTriangleResolveStr: typeof matrixTriangleResolveStr;
951+
952+
/**
953+
* Returns the enumeration constant associated with a BLAS matrix triangle.
954+
*
955+
* ## Notes
956+
*
957+
* - 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.
958+
*
959+
* @param value - matrix triangle string
960+
* @returns enumeration constant
961+
*
962+
* @example
963+
* var v = ns.matrixTriangleStr2Enum( 'upper' );
964+
* // returns <number>
965+
*/
966+
matrixTriangleStr2Enum: typeof matrixTriangleStr2Enum;
967+
830968
/**
831969
* Returns a list of matrix triangles.
832970
*
@@ -838,6 +976,69 @@ interface Namespace {
838976
*/
839977
matrixTriangles: typeof matrixTriangles;
840978

979+
/**
980+
* Returns the BLAS operation side string associated with a BLAS operation side enumeration constant.
981+
*
982+
* @param operation - enumeration constant
983+
* @returns operation string
984+
*
985+
* @example
986+
* var str2enum = require( '@stdlib/blas/base/operation-side-str2enum' );
987+
*
988+
* var v = str2enum( 'left' );
989+
* // returns <number>
990+
*
991+
* var s = ns.operationSideEnum2Str( v );
992+
* // returns 'left'
993+
*/
994+
operationSideEnum2Str: typeof operationSideEnum2Str;
995+
996+
/**
997+
* Returns the enumeration constant associated with a BLAS operation side value.
998+
*
999+
* ## Notes
1000+
*
1001+
* - 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.
1002+
*
1003+
* @param operation - operation value
1004+
* @returns enumeration constant
1005+
*
1006+
* @example
1007+
* var v = ns.operationSideResolveEnum( 'right' );
1008+
* // returns <number>
1009+
*/
1010+
operationSideResolveEnum: typeof operationSideResolveEnum;
1011+
1012+
/**
1013+
* Returns the operation side string associated with a BLAS operation side value.
1014+
*
1015+
* @param operation - operation value
1016+
* @returns operation side string
1017+
*
1018+
* @example
1019+
* var str2enum = require( '@stdlib/blas/base/operation-side-str2enum' );
1020+
*
1021+
* var v = ns.operationSideResolveStr( str2enum( 'left' ) );
1022+
* // returns 'left'
1023+
*/
1024+
operationSideResolveStr: typeof operationSideResolveStr;
1025+
1026+
/**
1027+
* Returns the enumeration constant associated with a BLAS operation side.
1028+
*
1029+
* ## Notes
1030+
*
1031+
* - 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.
1032+
*
1033+
* @param operation - operation side
1034+
* @returns enumeration constant
1035+
*
1036+
* @example
1037+
* var v = ns.operationSideStr2Enum( 'left' );
1038+
* // returns <number>
1039+
*/
1040+
operationSideStr2Enum: typeof operationSideStr2Enum;
1041+
8411042
/**
8421043
* Returns a list of operation sides.
8431044
*

0 commit comments

Comments
 (0)