Skip to content

Commit ea264e0

Browse files
authored
feat: update blas/base/ndarray TypeScript declarations
PR-URL: #11250 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 3fce7ca commit ea264e0

File tree

1 file changed

+98
-1
lines changed
  • lib/node_modules/@stdlib/blas/base/ndarray/docs/types

1 file changed

+98
-1
lines changed

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

Lines changed: 98 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,113 @@
2020

2121
/* eslint-disable max-lines */
2222

23+
import dasum = require( '@stdlib/blas/base/ndarray/dasum' );
2324
import ddot = require( '@stdlib/blas/base/ndarray/ddot' );
25+
import gdot = require( '@stdlib/blas/base/ndarray/gdot' );
26+
import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
27+
import sdot = require( '@stdlib/blas/base/ndarray/sdot' );
2428

2529
/**
2630
* Interface describing the `ndarray` namespace.
2731
*/
2832
interface Namespace {
2933
/**
30-
* TODO
34+
* Computes the sum of absolute values for all elements in a one-dimensional double-precision floating-point ndarray.
35+
*
36+
* @param arrays - array-like object containing a one-dimensional input ndarray
37+
* @returns sum
38+
*
39+
* @example
40+
* var Float64Array = require( '@stdlib/array/float64' );
41+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
42+
*
43+
* var xbuf = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0 ] );
44+
* var x = new ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
45+
*
46+
* var y = ns.dasum( [ x ] );
47+
* // returns 15.0
48+
*/
49+
dasum: typeof dasum;
50+
51+
/**
52+
* Computes the dot product of two one-dimensional double-precision floating-point ndarrays.
53+
*
54+
* @param arrays - array-like object containing two one-dimensional input ndarrays
55+
* @returns dot product
56+
*
57+
* @example
58+
* var Float64Array = require( '@stdlib/array/float64' );
59+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
60+
*
61+
* var xbuf = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
62+
* var x = new ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
63+
*
64+
* var ybuf = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
65+
* var y = new ndarray( 'float64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
66+
*
67+
* var z = ns.ddot( [ x, y ] );
68+
* // returns -5.0
3169
*/
3270
ddot: typeof ddot;
71+
72+
/**
73+
* Computes the dot product of two one-dimensional ndarrays.
74+
*
75+
* @param arrays - array-like object containing two one-dimensional input ndarrays
76+
* @returns dot product
77+
*
78+
* @example
79+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
80+
*
81+
* var xbuf = [ 4.0, 2.0, -3.0, 5.0, -1.0 ];
82+
* var x = new ndarray( 'generic', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
83+
*
84+
* var ybuf = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
85+
* var y = new ndarray( 'generic', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
86+
*
87+
* var z = ns.gdot( [ x, y ] );
88+
* // returns -5.0
89+
*/
90+
gdot: typeof gdot;
91+
92+
/**
93+
* Computes the sum of absolute values for all elements in a one-dimensional single-precision floating-point ndarray.
94+
*
95+
* @param arrays - array-like object containing a one-dimensional input ndarray
96+
* @returns sum
97+
*
98+
* @example
99+
* var Float32Array = require( '@stdlib/array/float32' );
100+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
101+
*
102+
* var xbuf = new Float32Array( [ 1.0, -2.0, 3.0, -4.0, 5.0 ] );
103+
* var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
104+
*
105+
* var y = ns.sasum( [ x ] );
106+
* // returns 15.0
107+
*/
108+
sasum: typeof sasum;
109+
110+
/**
111+
* Computes the dot product of two one-dimensional single-precision floating-point ndarrays.
112+
*
113+
* @param arrays - array-like object containing two one-dimensional input ndarrays
114+
* @returns dot product
115+
*
116+
* @example
117+
* var Float32Array = require( '@stdlib/array/float32' );
118+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
119+
*
120+
* var xbuf = new Float32Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
121+
* var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
122+
*
123+
* var ybuf = new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
124+
* var y = new ndarray( 'float32', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
125+
*
126+
* var z = ns.sdot( [ x, y ] );
127+
* // returns -5.0
128+
*/
129+
sdot: typeof sdot;
33130
}
34131

35132
/**

0 commit comments

Comments
 (0)