Skip to content

Commit 4bb0678

Browse files
stdlib-botstdlib-bot
authored
feat: update blas/ext/base TypeScript declarations
PR-URL: #11419 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent a135b0c commit 4bb0678

File tree

1 file changed

+75
-17
lines changed
  • lib/node_modules/@stdlib/blas/ext/base/docs/types

1 file changed

+75
-17
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts‎

Lines changed: 75 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ import gnansumkbn2 = require( '@stdlib/blas/ext/base/gnansumkbn2' );
118118
import gnansumors = require( '@stdlib/blas/ext/base/gnansumors' );
119119
import gnansumpw = require( '@stdlib/blas/ext/base/gnansumpw' );
120120
import goneTo = require( '@stdlib/blas/ext/base/gone-to' );
121+
import greplicate = require( '@stdlib/blas/ext/base/greplicate' );
121122
import grev = require( '@stdlib/blas/ext/base/grev' );
122123
import gsort = require( '@stdlib/blas/ext/base/gsort' );
123124
import gsort2hp = require( '@stdlib/blas/ext/base/gsort2hp' );
@@ -131,6 +132,7 @@ import gsumkbn = require( '@stdlib/blas/ext/base/gsumkbn' );
131132
import gsumkbn2 = require( '@stdlib/blas/ext/base/gsumkbn2' );
132133
import gsumors = require( '@stdlib/blas/ext/base/gsumors' );
133134
import gsumpw = require( '@stdlib/blas/ext/base/gsumpw' );
135+
import gvander = require( '@stdlib/blas/ext/base/gvander' );
134136
import gzeroTo = require( '@stdlib/blas/ext/base/gzero-to' );
135137
import ndarray = require( '@stdlib/blas/ext/base/ndarray' );
136138
import sapx = require( '@stdlib/blas/ext/base/sapx' );
@@ -241,8 +243,8 @@ interface Namespace {
241243
* @returns row index
242244
*
243245
* @example
244-
* var Complex64Array = require( `@stdlib/array/complex64` );
245-
* var Uint8Array = require( `@stdlib/array/uint8` );
246+
* var Complex64Array = require( '@stdlib/array/complex64' );
247+
* var Uint8Array = require( '@stdlib/array/uint8' );
246248
*
247249
* var A = new Complex64Array( [ 1.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, 0.0, 0.0 ] );
248250
* var x = new Complex64Array( [ 2.0, 0.0, 4.0, 0.0 ] );
@@ -252,8 +254,8 @@ interface Namespace {
252254
* // returns 1
253255
*
254256
* @example
255-
* var Complex64Array = require( `@stdlib/array/complex64` );
256-
* var Uint8Array = require( `@stdlib/array/uint8` );
257+
* var Complex64Array = require( '@stdlib/array/complex64' );
258+
* var Uint8Array = require( '@stdlib/array/uint8' );
257259
*
258260
* var A = new Complex64Array( [ 1.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, 0.0, 0.0 ] );
259261
* var x = new Complex64Array( [ 2.0, 0.0, 4.0, 0.0 ] );
@@ -816,8 +818,8 @@ interface Namespace {
816818
* @returns row index
817819
*
818820
* @example
819-
* var Float64Array = require( `@stdlib/array/float64` );
820-
* var Uint8Array = require( `@stdlib/array/uint8` );
821+
* var Float64Array = require( '@stdlib/array/float64' );
822+
* var Uint8Array = require( '@stdlib/array/uint8' );
821823
*
822824
* var A = new Float64Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] );
823825
* var x = new Float64Array( [ 2.0, 4.0 ] );
@@ -827,8 +829,8 @@ interface Namespace {
827829
* // returns 1
828830
*
829831
* @example
830-
* var Float64Array = require( `@stdlib/array/float64` );
831-
* var Uint8Array = require( `@stdlib/array/uint8` );
832+
* var Float64Array = require( '@stdlib/array/float64' );
833+
* var Uint8Array = require( '@stdlib/array/uint8' );
832834
*
833835
* var A = new Float64Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] );
834836
* var x = new Float64Array( [ 2.0, 4.0 ] );
@@ -2965,6 +2967,33 @@ interface Namespace {
29652967
*/
29662968
goneTo: typeof goneTo;
29672969

2970+
/**
2971+
* Replicates each strided array element a specified number of times.
2972+
*
2973+
* @param N - number of indexed elements
2974+
* @param k - number of times to replicate each element
2975+
* @param x - input array
2976+
* @param strideX - stride length for `x`
2977+
* @param out - output array
2978+
* @param strideOut - stride length for `out`
2979+
* @returns output array
2980+
*
2981+
* @example
2982+
* var x = [ 1.0, 2.0, 3.0 ];
2983+
* var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
2984+
*
2985+
* ns.greplicate( x.length, 2, x, 1, out, 1 );
2986+
* // out => [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ]
2987+
*
2988+
* @example
2989+
* var x = [ 1.0, 2.0, 3.0 ];
2990+
* var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
2991+
*
2992+
* ns.greplicate.ndarray( x.length, 2, x, 1, 0, out, 1, 0 );
2993+
* // out => [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ]
2994+
*/
2995+
greplicate: typeof greplicate;
2996+
29682997
/**
29692998
* Reverses a strided array in-place.
29702999
*
@@ -3300,6 +3329,35 @@ interface Namespace {
33003329
*/
33013330
gsumpw: typeof gsumpw;
33023331

3332+
/**
3333+
* Generates a Vandermonde matrix.
3334+
*
3335+
* @param order - storage layout
3336+
* @param mode - mode indicating whether to generate increasing or decreasing powers
3337+
* @param M - number of rows in `out`
3338+
* @param N - number of columns in `out`
3339+
* @param x - input array
3340+
* @param strideX - stride length for `x`
3341+
* @param out - output matrix
3342+
* @param ldo - stride between successive contiguous vectors of the matrix `out` (a.k.a., leading dimension of the matrix `out`)
3343+
* @returns output matrix
3344+
*
3345+
* @example
3346+
* var x = [ 1.0, 2.0, 3.0 ];
3347+
* var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
3348+
*
3349+
* ns.gvander( 'row-major', 1, 3, 3, x, 1, out, 3 );
3350+
* // out => [ 1.0, 1.0, 1.0, 1.0, 2.0, 4.0, 1.0, 3.0, 9.0 ]
3351+
*
3352+
* @example
3353+
* var x = [ 1.0, 2.0, 3.0 ];
3354+
* var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
3355+
*
3356+
* ns.gvander.ndarray( 1, 3, 3, x, 1, 0, out, 3, 1, 0 );
3357+
* // out => [ 1.0, 1.0, 1.0, 1.0, 2.0, 4.0, 1.0, 3.0, 9.0 ]
3358+
*/
3359+
gvander: typeof gvander;
3360+
33033361
/**
33043362
* Fills a strided array with linearly spaced numeric elements which increment by `1` starting from zero.
33053363
*
@@ -3933,8 +3991,8 @@ interface Namespace {
39333991
* @returns row index
39343992
*
39353993
* @example
3936-
* var Float32Array = require( `@stdlib/array/float32` );
3937-
* var Uint8Array = require( `@stdlib/array/uint8` );
3994+
* var Float32Array = require( '@stdlib/array/float32' );
3995+
* var Uint8Array = require( '@stdlib/array/uint8' );
39383996
*
39393997
* var A = new Float32Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] );
39403998
* var x = new Float32Array( [ 2.0, 4.0 ] );
@@ -3944,8 +4002,8 @@ interface Namespace {
39444002
* // returns 1
39454003
*
39464004
* @example
3947-
* var Float32Array = require( `@stdlib/array/float32` );
3948-
* var Uint8Array = require( `@stdlib/array/uint8` );
4005+
* var Float32Array = require( '@stdlib/array/float32' );
4006+
* var Uint8Array = require( '@stdlib/array/uint8' );
39494007
*
39504008
* var A = new Float32Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] );
39514009
* var x = new Float32Array( [ 2.0, 4.0 ] );
@@ -4343,7 +4401,7 @@ interface Namespace {
43434401
* @param N - number of indexed elements
43444402
* @param order - sort order
43454403
* @param x - input array
4346-
* @param stride - stride length
4404+
* @param strideX - stride length
43474405
* @returns input array
43484406
*
43494407
* @example
@@ -4625,8 +4683,8 @@ interface Namespace {
46254683
* @returns row index
46264684
*
46274685
* @example
4628-
* var Complex128Array = require( `@stdlib/array/complex128` );
4629-
* var Uint8Array = require( `@stdlib/array/uint8` );
4686+
* var Complex128Array = require( '@stdlib/array/complex128' );
4687+
* var Uint8Array = require( '@stdlib/array/uint8' );
46304688
*
46314689
* var A = new Complex128Array( [ 1.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, 0.0, 0.0 ] );
46324690
* var x = new Complex128Array( [ 2.0, 0.0, 4.0, 0.0 ] );
@@ -4636,8 +4694,8 @@ interface Namespace {
46364694
* // returns 1
46374695
*
46384696
* @example
4639-
* var Complex128Array = require( `@stdlib/array/complex128` );
4640-
* var Uint8Array = require( `@stdlib/array/uint8` );
4697+
* var Complex128Array = require( '@stdlib/array/complex128' );
4698+
* var Uint8Array = require( '@stdlib/array/uint8' );
46414699
*
46424700
* var A = new Complex128Array( [ 1.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, 0.0, 0.0 ] );
46434701
* var x = new Complex128Array( [ 2.0, 0.0, 4.0, 0.0 ] );

0 commit comments

Comments
 (0)