Skip to content

Commit d33beca

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

1 file changed

Lines changed: 74 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/blas/base/ndarray/docs/types

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

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,15 @@
2323
import caxpy = require( '@stdlib/blas/base/ndarray/caxpy' );
2424
import dasum = require( '@stdlib/blas/base/ndarray/dasum' );
2525
import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' );
26+
import dcopy = require( '@stdlib/blas/base/ndarray/dcopy' );
2627
import ddot = require( '@stdlib/blas/base/ndarray/ddot' );
2728
import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
2829
import gaxpy = require( '@stdlib/blas/base/ndarray/gaxpy' );
30+
import gcopy = require( '@stdlib/blas/base/ndarray/gcopy' );
2931
import gdot = require( '@stdlib/blas/base/ndarray/gdot' );
3032
import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
3133
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
34+
import scopy = require( '@stdlib/blas/base/ndarray/scopy' );
3235
import sdot = require( '@stdlib/blas/base/ndarray/sdot' );
3336
import zaxpy = require( '@stdlib/blas/base/ndarray/zaxpy' );
3437

@@ -109,6 +112,30 @@ interface Namespace {
109112
*/
110113
daxpy: typeof daxpy;
111114

115+
/**
116+
* Copies values from a one-dimensional double-precision floating-point ndarray `x` into a one-dimensional double-precision floating-point ndarray `y`.
117+
*
118+
* @param arrays - array-like object containing an input ndarray and an output ndarray
119+
* @returns output ndarray
120+
*
121+
* @example
122+
* var Float64Array = require( '@stdlib/array/float64' );
123+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
124+
*
125+
* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
126+
* var x = new ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
127+
*
128+
* var ybuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
129+
* var y = new ndarray( 'float64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
130+
*
131+
* var z = ns.dcopy( [ x, y ] );
132+
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
133+
*
134+
* var bool = ( z === y );
135+
* // returns true
136+
*/
137+
dcopy: typeof dcopy;
138+
112139
/**
113140
* Computes the dot product of two one-dimensional double-precision floating-point ndarrays.
114141
*
@@ -173,6 +200,29 @@ interface Namespace {
173200
*/
174201
gaxpy: typeof gaxpy;
175202

203+
/**
204+
* Copies values from a one-dimensional ndarray `x` into a one-dimensional ndarray `y`.
205+
*
206+
* @param arrays - array-like object containing an input ndarray and an output ndarray
207+
* @returns output ndarray
208+
*
209+
* @example
210+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
211+
*
212+
* var xbuf = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
213+
* var x = new ndarray( 'generic', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
214+
*
215+
* var ybuf = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
216+
* var y = new ndarray( 'generic', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
217+
*
218+
* var z = ns.gcopy( [ x, y ] );
219+
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
220+
*
221+
* var bool = ( z === y );
222+
* // returns true
223+
*/
224+
gcopy: typeof gcopy;
225+
176226
/**
177227
* Computes the dot product of two one-dimensional ndarrays.
178228
*
@@ -238,6 +288,30 @@ interface Namespace {
238288
*/
239289
saxpy: typeof saxpy;
240290

291+
/**
292+
* Copies values from a one-dimensional single-precision floating-point ndarray `x` into a one-dimensional single-precision floating-point ndarray `y`.
293+
*
294+
* @param arrays - array-like object containing an input ndarray and an output ndarray
295+
* @returns output ndarray
296+
*
297+
* @example
298+
* var Float32Array = require( '@stdlib/array/float32' );
299+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
300+
*
301+
* var xbuf = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
302+
* var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
303+
*
304+
* var ybuf = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
305+
* var y = new ndarray( 'float32', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
306+
*
307+
* var z = ns.scopy( [ x, y ] );
308+
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
309+
*
310+
* var bool = ( z === y );
311+
* // returns true
312+
*/
313+
scopy: typeof scopy;
314+
241315
/**
242316
* Computes the dot product of two one-dimensional single-precision floating-point ndarrays.
243317
*

0 commit comments

Comments
 (0)