Skip to content
Merged
Changes from all commits
Commits
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
68 changes: 66 additions & 2 deletions lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import dasum = require( '@stdlib/blas/base/ndarray/dasum' );
import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' );
import dcopy = require( '@stdlib/blas/base/ndarray/dcopy' );
import ddot = require( '@stdlib/blas/base/ndarray/ddot' );
import dscal = require( '@stdlib/blas/base/ndarray/dscal' );
import dswap = require( '@stdlib/blas/base/ndarray/dswap' );
import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
import gaxpy = require( '@stdlib/blas/base/ndarray/gaxpy' );
Expand All @@ -37,6 +38,7 @@ import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
import scopy = require( '@stdlib/blas/base/ndarray/scopy' );
import sdot = require( '@stdlib/blas/base/ndarray/sdot' );
import sscal = require( '@stdlib/blas/base/ndarray/sscal' );
import sswap = require( '@stdlib/blas/base/ndarray/sswap' );
import zaxpy = require( '@stdlib/blas/base/ndarray/zaxpy' );
import zcopy = require( '@stdlib/blas/base/ndarray/zcopy' );
Expand Down Expand Up @@ -108,7 +110,7 @@ interface Namespace {
ccopy: typeof ccopy;

/**
* Interchanges two one-dimensional single-precision complex floating-point ndarrays.
* Interchanges two one-dimensional complex single-precision floating-point ndarrays.
*
* ## Notes
*
Expand Down Expand Up @@ -241,6 +243,37 @@ interface Namespace {
*/
ddot: typeof ddot;

/**
* Multiplies a one-dimensional double-precision 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 Float64Vector = require( '@stdlib/ndarray/vector/float64' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
*
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'float64'
* });
*
* var y = ns.dscal( [ x, alpha ] );
* // returns <ndarray>[ 5.0, 10.0, 15.0, 20.0, 25.0 ]
*
* var bool = ( y === x );
* // returns true
*/
dscal: typeof dscal;

/**
* Interchanges two one-dimensional double-precision floating-point ndarrays.
*
Expand Down Expand Up @@ -509,6 +542,37 @@ interface Namespace {
*/
sdot: typeof sdot;

/**
* Multiplies a one-dimensional single-precision 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 Float32Vector = require( '@stdlib/ndarray/vector/float32' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
*
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'float32'
* });
*
* var y = ns.sscal( [ x, alpha ] );
* // returns <ndarray>[ 5.0, 10.0, 15.0, 20.0, 25.0 ]
*
* var bool = ( y === x );
* // returns true
*/
sscal: typeof sscal;

/**
* Interchanges two one-dimensional single-precision floating-point ndarrays.
*
Expand Down Expand Up @@ -599,7 +663,7 @@ interface Namespace {
zcopy: typeof zcopy;

/**
* Interchanges two one-dimensional double-precision complex floating-point ndarrays.
* Interchanges two one-dimensional complex double-precision floating-point ndarrays.
*
* ## Notes
*
Expand Down