Skip to content

Commit 9b3c5a5

Browse files
authored
feat: update blas/ext/base/ndarray TypeScript declarations
PR-URL: #11400 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent db9343f commit 9b3c5a5

File tree

1 file changed

+39
-5
lines changed
  • lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types

1 file changed

+39
-5
lines changed

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

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020

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

23+
import coneTo = require( '@stdlib/blas/ext/base/ndarray/cone-to' );
2324
import csum = require( '@stdlib/blas/ext/base/ndarray/csum' );
2425
import csumkbn = require( '@stdlib/blas/ext/base/ndarray/csumkbn' );
2526
import czeroTo = require( '@stdlib/blas/ext/base/ndarray/czero-to' );
@@ -95,6 +96,7 @@ import ssumkbn2 = require( '@stdlib/blas/ext/base/ndarray/ssumkbn2' );
9596
import ssumors = require( '@stdlib/blas/ext/base/ndarray/ssumors' );
9697
import ssumpw = require( '@stdlib/blas/ext/base/ndarray/ssumpw' );
9798
import szeroTo = require( '@stdlib/blas/ext/base/ndarray/szero-to' );
99+
import zoneTo = require( '@stdlib/blas/ext/base/ndarray/zone-to' );
98100
import zsum = require( '@stdlib/blas/ext/base/ndarray/zsum' );
99101
import zsumkbn = require( '@stdlib/blas/ext/base/ndarray/zsumkbn' );
100102
import zzeroTo = require( '@stdlib/blas/ext/base/ndarray/zzero-to' );
@@ -103,6 +105,24 @@ import zzeroTo = require( '@stdlib/blas/ext/base/ndarray/zzero-to' );
103105
* Interface describing the `ndarray` namespace.
104106
*/
105107
interface Namespace {
108+
/**
109+
* Fills a one-dimensional single-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one.
110+
*
111+
* @param arrays - array-like object containing a one-dimensional input ndarray
112+
* @returns input ndarray
113+
*
114+
* @example
115+
* var Complex64Array = require( '@stdlib/array/complex64' );
116+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
117+
*
118+
* var xbuf = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
119+
* var x = new ndarray( 'complex64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
120+
*
121+
* var out = ns.coneTo( [ x ] );
122+
* // returns <ndarray>[ <Complex64>[ 1.0, 0.0 ], <Complex64>[ 2.0, 0.0 ], <Complex64>[ 3.0, 0.0 ], <Complex64>[ 4.0, 0.0 ] ]
123+
*/
124+
coneTo: typeof coneTo;
125+
106126
/**
107127
* Computes the sum of all elements in a one-dimensional single-precision complex floating-point ndarray.
108128
*
@@ -215,7 +235,6 @@ interface Namespace {
215235
*
216236
* @example
217237
* var Float64Array = require( '@stdlib/array/float64' );
218-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
219238
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
220239
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
221240
*
@@ -228,13 +247,10 @@ interface Namespace {
228247
* var initial = scalar2ndarray( 0.0, 'float64', 'row-major' );
229248
*
230249
* var v = ns.dcusumkbn( [ x, y, initial ] );
231-
* // returns <ndarray>
250+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
232251
*
233252
* var bool = ( v === y );
234253
* // returns true
235-
*
236-
* var arr = ndarray2array( v );
237-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
238254
*/
239255
dcusumkbn: typeof dcusumkbn;
240256

@@ -1847,6 +1863,24 @@ interface Namespace {
18471863
*/
18481864
szeroTo: typeof szeroTo;
18491865

1866+
/**
1867+
* Fills a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one.
1868+
*
1869+
* @param arrays - array-like object containing a one-dimensional input ndarray
1870+
* @returns input ndarray
1871+
*
1872+
* @example
1873+
* var Complex128Array = require( '@stdlib/array/complex128' );
1874+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
1875+
*
1876+
* var xbuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
1877+
* var x = new ndarray( 'complex128', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
1878+
*
1879+
* var out = ns.zoneTo( [ x ] );
1880+
* // returns <ndarray>[ <Complex128>[ 1.0, 0.0 ], <Complex128>[ 2.0, 0.0 ], <Complex128>[ 3.0, 0.0 ], <Complex128>[ 4.0, 0.0 ] ]
1881+
*/
1882+
zoneTo: typeof zoneTo;
1883+
18501884
/**
18511885
* Computes the sum of all elements in a one-dimensional double-precision complex floating-point ndarray.
18521886
*

0 commit comments

Comments
 (0)