Skip to content

Commit

Permalink
feat: update namespace TypeScript declarations
Browse files Browse the repository at this point in the history
Signed-off-by: stdlib-bot <[email protected]>
  • Loading branch information
Planeshifter authored and stdlib-bot committed Jan 30, 2025
1 parent 10197ce commit ad8bb6b
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 78 deletions.
50 changes: 5 additions & 45 deletions lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,44 +127,24 @@ interface Namespace {
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
* var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
* var ca = new Complex64( 2.0, 2.0 );
*
* ns.caxpy( 2, ca, cx, 2, cy, 2 );
*
* var z = cy.get( 0 );
* // returns <Complex64>
*
* var re = realf( z );
* // returns -1.0
*
* var im = imagf( z );
* // returns 7.0
* // cy => <Complex64Array>[ -1.0, 7.0, 1.0, 1.0, -1.0, 23.0, 1.0, 1.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
* var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
* var ca = new Complex64( 2.0, 2.0 );
*
* ns.caxpy.ndarray( 3, ca, cx, 1, 1, cy, 1, 1 );
*
* var z = cy.get( 3 );
* // returns <Complex64>
*
* var re = realf( z );
* // returns -1.0
*
* var im = imagf( z );
* // returns 31.0
* // cy => <Complex64Array>[ 1.0, 1.0, -1.0, 15.0, -1.0, 23.0, -1.0, 31.0 ]
*/
caxpy: typeof caxpy;

Expand Down Expand Up @@ -210,42 +190,22 @@ interface Namespace {
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var ca = new Complex64( 2.0, 2.0 );
*
* ns.cscal( 3, ca, cx, 1 );
*
* var z = cx.get( 0 );
* // returns <Complex64>
*
* var re = realf( z );
* // returns -2.0
*
* var im = imagf( z );
* // returns 6.0
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var ca = new Complex64( 2.0, 2.0 );
*
* ns.cscal.ndarray( 2, ca, cx, 1, 0 );
*
* var z = cx.get( 0 );
* // returns <Complex64>
*
* var re = realf( z );
* // returns -2.0
*
* var im = imagf( z );
* // returns 6.0
* ns.cscal.ndarray( 3, ca, cx, 1, 0 );
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
*/
cscal: typeof cscal;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2147,7 +2147,7 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns sum
*
* @example
Expand Down
33 changes: 1 addition & 32 deletions lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import cumaxabs = require( '@stdlib/stats/base/cumaxabs' );
import cumin = require( '@stdlib/stats/base/cumin' );
import cuminabs = require( '@stdlib/stats/base/cuminabs' );
import dcumin = require( '@stdlib/stats/base/dcumin' );
import dcuminabs = require( '@stdlib/stats/strided/dcuminabs' );
import dists = require( '@stdlib/stats/base/dists' );
import dmaxabs = require( '@stdlib/stats/base/dmaxabs' );
import dmaxabssorted = require( '@stdlib/stats/base/dmaxabssorted' );
Expand Down Expand Up @@ -374,36 +373,6 @@ interface Namespace {
*/
dcumin: typeof dcumin;

/**
* Computes the cumulative minimum absolute value of double-precision floating-point strided array elements.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - `x` stride length
* @param y - output array
* @param strideY - `y` stride length
* @returns output array
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
* var y = new Float64Array( x.length );
*
* ns.dcuminabs( x.length, x, 1, y, 1 );
* // y => <Float64Array>[ 1.0, 1.0, 1.0 ]
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
* var y = new Float64Array( x.length );
*
* ns.dcuminabs.ndarray( x.length, x, 1, 0, y, 1, 0 );
* // y => <Float64Array>[ 1.0, 1.0, 1.0 ]
*/
dcuminabs: typeof dcuminabs;

/**
* Base (i.e., lower-level) probability distributions.
*/
Expand Down Expand Up @@ -5474,7 +5443,7 @@ interface Namespace {
* @param N - number of indexed elements
* @param correction - degrees of freedom adjustment
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns standard deviation
*
* @example
Expand Down

0 comments on commit ad8bb6b

Please sign in to comment.