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
78 changes: 78 additions & 0 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 @@ -35,6 +35,7 @@ import dger = require( '@stdlib/blas/base/ndarray/dger' );
import dnrm2 = require( '@stdlib/blas/base/ndarray/dnrm2' );
import dscal = require( '@stdlib/blas/base/ndarray/dscal' );
import dsdot = require( '@stdlib/blas/base/ndarray/dsdot' );
import dspr = require( '@stdlib/blas/base/ndarray/dspr' );
import dswap = require( '@stdlib/blas/base/ndarray/dswap' );
import dzasum = require( '@stdlib/blas/base/ndarray/dzasum' );
import dznrm2 = require( '@stdlib/blas/base/ndarray/dznrm2' );
Expand All @@ -61,6 +62,7 @@ import sgemv = require( '@stdlib/blas/base/ndarray/sgemv' );
import sger = require( '@stdlib/blas/base/ndarray/sger' );
import snrm2 = require( '@stdlib/blas/base/ndarray/snrm2' );
import sscal = require( '@stdlib/blas/base/ndarray/sscal' );
import sspr = require( '@stdlib/blas/base/ndarray/sspr' );
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 @@ -534,6 +536,44 @@ interface Namespace {
*/
dsdot: typeof dsdot;

/**
* Performs the symmetric rank 1 operation `A = alpha*x*x^T + A`, where `alpha` is a scalar, `x` is a one-dimensional ndarray, and `A` is a symmetric `N` by `N` matrix supplied in packed form.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray corresponding to `x`.
* - a one-dimensional input/output ndarray corresponding to the packed form of `A`.
* - a zero-dimensional ndarray specifying whether the upper or lower triangular part of `A` is supplied.
* - a zero-dimensional ndarray containing a scalar constant corresponding to `alpha`.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var resolveEnum = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' );
*
* var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] );
* var AP = new Float64Vector( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] );
*
* var uplo = scalar2ndarray( resolveEnum( 'upper' ), {
* 'dtype': 'int8'
* });
* var alpha = scalar2ndarray( 1.0, {
* 'dtype': 'float64'
* });
*
* var y = ns.dspr( [ x, AP, uplo, alpha ] );
* // returns <ndarray>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]
*
* var bool = ( y === AP );
* // returns true
*/
dspr: typeof dspr;

/**
* Interchanges two one-dimensional double-precision floating-point ndarrays.
*
Expand Down Expand Up @@ -1254,6 +1294,44 @@ interface Namespace {
*/
sscal: typeof sscal;

/**
* Performs the symmetric rank 1 operation `A = alpha*x*x^T + A`, where `alpha` is a scalar, `x` is a one-dimensional ndarray, and `A` is a symmetric `N` by `N` matrix supplied in packed form.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray corresponding to `x`.
* - a one-dimensional input/output ndarray corresponding to the packed form of `A`.
* - a zero-dimensional ndarray specifying whether the upper or lower triangular part of `A` is supplied.
* - a zero-dimensional ndarray containing a scalar constant corresponding to `alpha`.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var resolveEnum = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' );
*
* var x = new Float32Vector( [ 1.0, 2.0, 3.0 ] );
* var AP = new Float32Vector( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] );
*
* var uplo = scalar2ndarray( resolveEnum( 'upper' ), {
* 'dtype': 'int8'
* });
* var alpha = scalar2ndarray( 1.0, {
* 'dtype': 'float32'
* });
*
* var y = ns.sspr( [ x, AP, uplo, alpha ] );
* // returns <ndarray>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]
*
* var bool = ( y === AP );
* // returns true
*/
sspr: typeof sspr;

/**
* Interchanges two one-dimensional single-precision floating-point ndarrays.
*
Expand Down