Skip to content

Commit 6560df2

Browse files
authored
feat: update blas/base/ndarray TypeScript declarations
PR-URL: #11886 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 0c65a95 commit 6560df2

1 file changed

Lines changed: 29 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: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
3131
import gaxpy = require( '@stdlib/blas/base/ndarray/gaxpy' );
3232
import gcopy = require( '@stdlib/blas/base/ndarray/gcopy' );
3333
import gdot = require( '@stdlib/blas/base/ndarray/gdot' );
34+
import gswap = require( '@stdlib/blas/base/ndarray/gswap' );
3435
import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
3536
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
3637
import scopy = require( '@stdlib/blas/base/ndarray/scopy' );
@@ -344,6 +345,34 @@ interface Namespace {
344345
*/
345346
gdot: typeof gdot;
346347

348+
/**
349+
* Interchanges two one-dimensional ndarrays.
350+
*
351+
* ## Notes
352+
*
353+
* - The function expects the following ndarrays:
354+
*
355+
* - first one-dimensional input ndarray.
356+
* - second one-dimensional input ndarray.
357+
*
358+
* @param arrays - array-like object containing ndarrays
359+
* @returns second input ndarray
360+
*
361+
* @example
362+
* var vector = require( '@stdlib/ndarray/vector/ctor' );
363+
*
364+
* var x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' );
365+
* var y = vector( [ 6.0, 7.0, 8.0, 9.0, 10.0 ], 'generic' );
366+
*
367+
* var z = ns.gswap( [ x, y ] );
368+
* // x => <ndarray>[ 6.0, 7.0, 8.0, 9.0, 10.0 ]
369+
* // y => <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
370+
*
371+
* var bool = ( z === y );
372+
* // returns true
373+
*/
374+
gswap: typeof gswap;
375+
347376
/**
348377
* Computes the sum of absolute values for all elements in a one-dimensional single-precision floating-point ndarray.
349378
*

0 commit comments

Comments
 (0)