Skip to content

Commit 7e5f19e

Browse files
authored
feat: update blas/base/ndarray TypeScript declarations
PR-URL: #11854 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent e34b36c commit 7e5f19e

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
@@ -35,6 +35,7 @@ import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
3535
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
3636
import scopy = require( '@stdlib/blas/base/ndarray/scopy' );
3737
import sdot = require( '@stdlib/blas/base/ndarray/sdot' );
38+
import sswap = require( '@stdlib/blas/base/ndarray/sswap' );
3839
import zaxpy = require( '@stdlib/blas/base/ndarray/zaxpy' );
3940
import zcopy = require( '@stdlib/blas/base/ndarray/zcopy' );
4041

@@ -449,6 +450,34 @@ interface Namespace {
449450
*/
450451
sdot: typeof sdot;
451452

453+
/**
454+
* Interchanges two one-dimensional single-precision floating-point ndarrays.
455+
*
456+
* ## Notes
457+
*
458+
* - The function expects the following ndarrays:
459+
*
460+
* - first one-dimensional input ndarray.
461+
* - second one-dimensional input ndarray.
462+
*
463+
* @param arrays - array-like object containing ndarrays
464+
* @returns second input ndarray
465+
*
466+
* @example
467+
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
468+
*
469+
* var x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
470+
* var y = new Float32Vector( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] );
471+
*
472+
* var z = ns.sswap( [ x, y ] );
473+
* // x => <ndarray>[ 6.0, 7.0, 8.0, 9.0, 10.0 ]
474+
* // y => <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
475+
*
476+
* var bool = ( z === y );
477+
* // returns true
478+
*/
479+
sswap: typeof sswap;
480+
452481
/**
453482
* Multiplies a one-dimensional double-precision complex floating-point ndarray `x` by a constant `alpha` and adds the result to a one-dimensional double-precision complex floating-point ndarray `y`.
454483
*

0 commit comments

Comments
 (0)