Skip to content

Commit a477fe6

Browse files
committed
feat: update blas/base/ndarray TypeScript declarations
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 8516750 commit a477fe6

1 file changed

Lines changed: 66 additions & 2 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: 66 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import dasum = require( '@stdlib/blas/base/ndarray/dasum' );
2727
import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' );
2828
import dcopy = require( '@stdlib/blas/base/ndarray/dcopy' );
2929
import ddot = require( '@stdlib/blas/base/ndarray/ddot' );
30+
import dscal = require( '@stdlib/blas/base/ndarray/dscal' );
3031
import dswap = require( '@stdlib/blas/base/ndarray/dswap' );
3132
import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
3233
import gaxpy = require( '@stdlib/blas/base/ndarray/gaxpy' );
@@ -37,6 +38,7 @@ import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
3738
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
3839
import scopy = require( '@stdlib/blas/base/ndarray/scopy' );
3940
import sdot = require( '@stdlib/blas/base/ndarray/sdot' );
41+
import sscal = require( '@stdlib/blas/base/ndarray/sscal' );
4042
import sswap = require( '@stdlib/blas/base/ndarray/sswap' );
4143
import zaxpy = require( '@stdlib/blas/base/ndarray/zaxpy' );
4244
import zcopy = require( '@stdlib/blas/base/ndarray/zcopy' );
@@ -108,7 +110,7 @@ interface Namespace {
108110
ccopy: typeof ccopy;
109111

110112
/**
111-
* Interchanges two one-dimensional single-precision complex floating-point ndarrays.
113+
* Interchanges two one-dimensional complex single-precision floating-point ndarrays.
112114
*
113115
* ## Notes
114116
*
@@ -241,6 +243,37 @@ interface Namespace {
241243
*/
242244
ddot: typeof ddot;
243245

246+
/**
247+
* Multiplies a one-dimensional double-precision floating-point ndarray by a scalar constant.
248+
*
249+
* ## Notes
250+
*
251+
* - The function expects the following ndarrays:
252+
*
253+
* - a one-dimensional input ndarray.
254+
* - a zero-dimensional ndarray containing a scalar constant.
255+
*
256+
* @param arrays - array-like object containing ndarrays
257+
* @returns input ndarray
258+
*
259+
* @example
260+
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
261+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
262+
*
263+
* var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
264+
*
265+
* var alpha = scalar2ndarray( 5.0, {
266+
* 'dtype': 'float64'
267+
* });
268+
*
269+
* var y = ns.dscal( [ x, alpha ] );
270+
* // returns <ndarray>[ 5.0, 10.0, 15.0, 20.0, 25.0 ]
271+
*
272+
* var bool = ( y === x );
273+
* // returns true
274+
*/
275+
dscal: typeof dscal;
276+
244277
/**
245278
* Interchanges two one-dimensional double-precision floating-point ndarrays.
246279
*
@@ -509,6 +542,37 @@ interface Namespace {
509542
*/
510543
sdot: typeof sdot;
511544

545+
/**
546+
* Multiplies a one-dimensional single-precision floating-point ndarray by a scalar constant.
547+
*
548+
* ## Notes
549+
*
550+
* - The function expects the following ndarrays:
551+
*
552+
* - a one-dimensional input ndarray.
553+
* - a zero-dimensional ndarray containing a scalar constant.
554+
*
555+
* @param arrays - array-like object containing ndarrays
556+
* @returns input ndarray
557+
*
558+
* @example
559+
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
560+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
561+
*
562+
* var x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
563+
*
564+
* var alpha = scalar2ndarray( 5.0, {
565+
* 'dtype': 'float32'
566+
* });
567+
*
568+
* var y = ns.sscal( [ x, alpha ] );
569+
* // returns <ndarray>[ 5.0, 10.0, 15.0, 20.0, 25.0 ]
570+
*
571+
* var bool = ( y === x );
572+
* // returns true
573+
*/
574+
sscal: typeof sscal;
575+
512576
/**
513577
* Interchanges two one-dimensional single-precision floating-point ndarrays.
514578
*
@@ -599,7 +663,7 @@ interface Namespace {
599663
zcopy: typeof zcopy;
600664

601665
/**
602-
* Interchanges two one-dimensional double-precision complex floating-point ndarrays.
666+
* Interchanges two one-dimensional complex double-precision floating-point ndarrays.
603667
*
604668
* ## Notes
605669
*

0 commit comments

Comments
 (0)