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
62 changes: 62 additions & 0 deletions lib/node_modules/@stdlib/blas/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,51 @@

/* eslint-disable max-lines */

import asum = require( '@stdlib/blas/asum' );
import base = require( '@stdlib/blas/base' );
import ddot = require( '@stdlib/blas/ddot' );
import dswap = require( '@stdlib/blas/dswap' );
import ext = require( '@stdlib/blas/ext' );
import gdot = require( '@stdlib/blas/gdot' );
import gswap = require( '@stdlib/blas/gswap' );
import nrm2 = require( '@stdlib/blas/nrm2' );
import sdot = require( '@stdlib/blas/sdot' );
import sswap = require( '@stdlib/blas/sswap' );

/**
* Interface describing the `blas` namespace.
*/
interface Namespace {
/**
* Computes the sum of absolute values (L1 norm) along one or more ndarray dimensions.
*
* @param x - input ndarray
* @param options - function options
* @returns output ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ 1.0, -2.0, 2.0 ] );
*
* var y = ns.asum( x );
* // returns <ndarray>[ 5.0 ]
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var x = array( [ 1.0, -2.0, 2.0 ] );
* var y = zeros( [] );
*
* var out = ns.asum.assign( x, y );
* // returns <ndarray>[ 5.0 ]
*
* var bool = ( out === y );
* // returns true
*/
asum: typeof asum;

/**
* Base (i.e., lower-level) basic linear algebra subprograms (BLAS).
*/
Expand Down Expand Up @@ -158,6 +190,36 @@ interface Namespace {
*/
gswap: typeof gswap;

/**
* Computes the L2-norm along one or more ndarray dimensions.
*
* @param x - input ndarray
* @param options - function options
* @returns output ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ 1.0, -2.0, 2.0 ] );
*
* var y = ns.nrm2( x );
* // returns <ndarray>[ 3.0 ]
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var x = array( [ 1.0, -2.0, 2.0 ] );
* var y = zeros( [] );
*
* var out = ns.nrm2.assign( x, y );
* // returns <ndarray>[ 3.0 ]
*
* var bool = ( out === y );
* // returns true
*/
nrm2: typeof nrm2;

/**
* Computes the dot product of two single-precision floating-point vectors.
*
Expand Down