Skip to content

Commit 402f587

Browse files
authored
feat: update blas/base/ndarray TypeScript declarations
PR-URL: #12308 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent e508f18 commit 402f587

1 file changed

Lines changed: 79 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: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ import dcopy = require( '@stdlib/blas/base/ndarray/dcopy' );
3131
import ddot = require( '@stdlib/blas/base/ndarray/ddot' );
3232
import dnrm2 = require( '@stdlib/blas/base/ndarray/dnrm2' );
3333
import dscal = require( '@stdlib/blas/base/ndarray/dscal' );
34+
import dsdot = require( '@stdlib/blas/base/ndarray/dsdot' );
3435
import dswap = require( '@stdlib/blas/base/ndarray/dswap' );
3536
import dznrm2 = require( '@stdlib/blas/base/ndarray/dznrm2' );
3637
import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
@@ -42,9 +43,11 @@ import gscal = require( '@stdlib/blas/base/ndarray/gscal' );
4243
import gswap = require( '@stdlib/blas/base/ndarray/gswap' );
4344
import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
4445
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
46+
import scasum = require( '@stdlib/blas/base/ndarray/scasum' );
4547
import scnrm2 = require( '@stdlib/blas/base/ndarray/scnrm2' );
4648
import scopy = require( '@stdlib/blas/base/ndarray/scopy' );
4749
import sdot = require( '@stdlib/blas/base/ndarray/sdot' );
50+
import sdsdot = require( '@stdlib/blas/base/ndarray/sdsdot' );
4851
import snrm2 = require( '@stdlib/blas/base/ndarray/snrm2' );
4952
import sscal = require( '@stdlib/blas/base/ndarray/sscal' );
5053
import sswap = require( '@stdlib/blas/base/ndarray/sswap' );
@@ -369,6 +372,30 @@ interface Namespace {
369372
*/
370373
dscal: typeof dscal;
371374

375+
/**
376+
* Computes the dot product of two one-dimensional single-precision floating-point ndarrays with double-precision accumulation.
377+
*
378+
* ## Notes
379+
*
380+
* - The function expects the following ndarrays:
381+
*
382+
* - first one-dimensional input ndarray.
383+
* - second one-dimensional input ndarray.
384+
*
385+
* @param arrays - array-like object containing ndarrays
386+
* @returns dot product
387+
*
388+
* @example
389+
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
390+
*
391+
* var x = new Float32Vector( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
392+
* var y = new Float32Vector( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
393+
*
394+
* var z = ns.dsdot( [ x, y ] );
395+
* // returns -5.0
396+
*/
397+
dsdot: typeof dsdot;
398+
372399
/**
373400
* Interchanges two one-dimensional double-precision floating-point ndarrays.
374401
*
@@ -661,6 +688,28 @@ interface Namespace {
661688
*/
662689
saxpy: typeof saxpy;
663690

691+
/**
692+
* Computes the sum of absolute values for all elements in a one-dimensional single-precision complex floating-point ndarray.
693+
*
694+
* ## Notes
695+
*
696+
* - The function expects the following ndarrays:
697+
*
698+
* - a one-dimensional input ndarray.
699+
*
700+
* @param arrays - array-like object containing ndarrays
701+
* @returns sum
702+
*
703+
* @example
704+
* var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
705+
*
706+
* var x = new Complex64Vector( [ 1.0, -2.0, 3.0, -4.0 ] );
707+
*
708+
* var y = ns.scasum( [ x ] );
709+
* // returns 10.0
710+
*/
711+
scasum: typeof scasum;
712+
664713
/**
665714
* Computes the L2-norm of a one-dimensional single-precision complex floating-point ndarray.
666715
*
@@ -734,6 +783,36 @@ interface Namespace {
734783
*/
735784
sdot: typeof sdot;
736785

786+
/**
787+
* Computes the dot product of two one-dimensional single-precision floating-point ndarrays with extended accumulation.
788+
*
789+
* ## Notes
790+
*
791+
* - The function expects the following ndarrays:
792+
*
793+
* - first one-dimensional input ndarray.
794+
* - second one-dimensional input ndarray.
795+
* - a zero-dimensional ndarray containing a scalar constant.
796+
*
797+
* @param arrays - array-like object containing ndarrays
798+
* @returns dot product
799+
*
800+
* @example
801+
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
802+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
803+
*
804+
* var x = new Float32Vector( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
805+
* var y = new Float32Vector( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
806+
*
807+
* var scalar = scalar2ndarray( 10.0, {
808+
* 'dtype': 'float32'
809+
* });
810+
*
811+
* var z = ns.sdsdot( [ x, y, scalar ] );
812+
* // returns 5.0
813+
*/
814+
sdsdot: typeof sdsdot;
815+
737816
/**
738817
* Computes the L2-norm of a one-dimensional single-precision floating-point ndarray.
739818
*

0 commit comments

Comments
 (0)