Skip to content

feat: update blas/base/ndarray TypeScript declarations #11959

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Planeshifter merged 1 commit into from
May 6, 2026
+65 −0
Merged

feat: update blas/base/ndarray TypeScript declarations #11959

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

import caxpy = require( '@stdlib/blas/base/ndarray/caxpy' );
import ccopy = require( '@stdlib/blas/base/ndarray/ccopy' );
import cscal = require( '@stdlib/blas/base/ndarray/cscal' );
import cswap = require( '@stdlib/blas/base/ndarray/cswap' );
import dasum = require( '@stdlib/blas/base/ndarray/dasum' );
import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' );
Expand All @@ -33,6 +34,7 @@ import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
import gaxpy = require( '@stdlib/blas/base/ndarray/gaxpy' );
import gcopy = require( '@stdlib/blas/base/ndarray/gcopy' );
import gdot = require( '@stdlib/blas/base/ndarray/gdot' );
import gscal = require( '@stdlib/blas/base/ndarray/gscal' );
import gswap = require( '@stdlib/blas/base/ndarray/gswap' );
import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
Expand Down Expand Up @@ -109,6 +111,38 @@ interface Namespace {
*/
ccopy: typeof ccopy;

/**
* Multiplies a one-dimensional single-precision complex floating-point ndarray by a scalar constant.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a zero-dimensional ndarray containing a scalar constant.
*
* @param arrays - array-like object containing ndarrays
* @returns input ndarray
*
* @example
* var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Complex64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
*
* var alpha = scalar2ndarray( new Complex64( 2.0, 0.0 ), {
* 'dtype': 'complex64'
* });
*
* var y = ns.cscal( [ x, alpha ] );
* // returns <ndarray>[ <Complex64>[ 2.0, 4.0 ], <Complex64>[ 6.0, 8.0 ], <Complex64>[ 10.0, 12.0 ] ]
*
* var bool = ( y === x );
* // returns true
*/
cscal: typeof cscal;

/**
* Interchanges two one-dimensional single-precision complex floating-point ndarrays.
*
Expand Down Expand Up @@ -408,6 +442,37 @@ interface Namespace {
*/
gdot: typeof gdot;

/**
* Multiplies a one-dimensional ndarray by a scalar constant.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a zero-dimensional ndarray containing a scalar constant.
*
* @param arrays - array-like object containing ndarrays
* @returns input ndarray
*
* @example
* var vector = require( '@stdlib/ndarray/vector/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' );
*
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'generic'
* });
*
* var y = ns.gscal( [ x, alpha ] );
* // returns <ndarray>[ 5.0, 10.0, 15.0, 20.0, 25.0 ]
*
* var bool = ( y === x );
* // returns true
*/
gscal: typeof gscal;

/**
* Interchanges two one-dimensional ndarrays.
*
Expand Down