Skip to content

Commit b544a52

Browse files
kgrytekgryte
committed
fix: update import path for Collection type definition and refactor to use generics
Ref: bde4671
1 parent 4dc4968 commit b544a52

File tree

2 files changed

+19
-19
lines changed
  • lib/node_modules/@stdlib/strided/base/binary-addon-dispatch/docs/types

2 files changed

+19
-19
lines changed

‎lib/node_modules/@stdlib/strided/base/binary-addon-dispatch/docs/types/index.d.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
/// <reference types="@stdlib/types"/>
2222

23-
import { Collection } from '@stdlib/types/object';
23+
import { Collection } from '@stdlib/types/array';
2424

2525
/**
2626
* Add-on function.
@@ -41,7 +41,7 @@ import { Collection } from '@stdlib/types/object';
4141
* // Call into native add-on...
4242
* }
4343
*/
44-
type AddonFcn = ( N: number, dtypeX: number, x: Collection, strideX: number, dtypeY: number, y: Collection, strideY: number, dtypeZ: number, z: Collection, strideZ: number ) => any; // tslint:disable-line:max-line-length
44+
type AddonFcn<T, U, V, W> = ( N: number, dtypeX: number, x: Collection<T>, strideX: number, dtypeY: number, y: Collection<U>, strideY: number, dtypeZ: number, z: Collection<V>, strideZ: number ) => W;
4545

4646
/**
4747
* Fallback function.
@@ -62,7 +62,7 @@ type AddonFcn = ( N: number, dtypeX: number, x: Collection, strideX: number, dty
6262
* // Fallback JavaScript implementation...
6363
* }
6464
*/
65-
type FallbackFcn = ( N: number, dtypeX: any, x: Collection, strideX: number, dtypeY: any, y: Collection, strideY: number, dtypeZ: any, z: Collection, strideZ: number ) => any; // tslint:disable-line:max-line-length
65+
type FallbackFcn<T, U, V, W> = ( N: number, dtypeX: any, x: Collection<T>, strideX: number, dtypeY: any, y: Collection<U>, strideY: number, dtypeZ: any, z: Collection<V>, strideZ: number ) => W;
6666

6767
/**
6868
* Fallback function supporting alternative indexing semantics.
@@ -86,7 +86,7 @@ type FallbackFcn = ( N: number, dtypeX: any, x: Collection, strideX: number, dty
8686
* // Fallback JavaScript implementation...
8787
* }
8888
*/
89-
type FallbackFcnWithOffsets = ( N: number, dtypeX: any, x: Collection, strideX: number, offsetX: number, dtypeY: any, y: Collection, strideY: number, offsetY: number, dtypeZ: any, z: Collection, strideZ: number, offsetZ: number ) => any; // tslint:disable-line:max-line-length
89+
type FallbackFcnWithOffsets<T, U, V, W> = ( N: number, dtypeX: any, x: Collection<T>, strideX: number, offsetX: number, dtypeY: any, y: Collection<U>, strideY: number, offsetY: number, dtypeZ: any, z: Collection<V>, strideZ: number, offsetZ: number ) => W;
9090

9191
/**
9292
* Dispatches to a native add-on.
@@ -103,7 +103,7 @@ type FallbackFcnWithOffsets = ( N: number, dtypeX: any, x: Collection, strideX:
103103
* @param strideZ - `z` stride length
104104
* @returns `z`
105105
*/
106-
type Dispatcher = ( N: number, dtypeX: any, x: Collection, strideX: number, dtypeY: any, y: Collection, strideY: number, dtypeZ: any, z: Collection, strideZ: number ) => Collection; // tslint:disable-line:max-line-length
106+
type Dispatcher<T, U, V> = ( N: number, dtypeX: any, x: Collection<T>, strideX: number, dtypeY: any, y: Collection<U>, strideY: number, dtypeZ: any, z: Collection<V>, strideZ: number ) => Collection<V>;
107107

108108
/**
109109
* Dispatches to a native add-on.
@@ -123,7 +123,7 @@ type Dispatcher = ( N: number, dtypeX: any, x: Collection, strideX: number, dtyp
123123
* @param offsetZ - starting `z` index
124124
* @returns `z`
125125
*/
126-
type DispatcherWithOffsets = ( N: number, dtypeX: any, x: Collection, strideX: number, offsetX: number, dtypeY: any, y: Collection, strideY: number, offsetY: number, dtypeZ: any, z: Collection, strideZ: number, offsetZ: number ) => Collection; // tslint:disable-line:max-line-length
126+
type DispatcherWithOffsets<T, U, V> = ( N: number, dtypeX: any, x: Collection<T>, strideX: number, offsetX: number, dtypeY: any, y: Collection<U>, strideY: number, offsetY: number, dtypeZ: any, z: Collection<V>, strideZ: number, offsetZ: number ) => Collection<V>;
127127

128128
/**
129129
* Interface for creating a native add-on dispatcher.
@@ -153,7 +153,7 @@ interface Dispatch {
153153
* // Invoke the dispatch function with strided array arguments:
154154
* f( 2, 'generic', [ 1, 2 ], 1, 'generic', [ 3, 4 ], 1, 'generic', [ 0, 0 ], 1 );
155155
*/
156-
( addon: AddonFcn, fallback: FallbackFcn ): Dispatcher;
156+
<T = unknown, U = unknown, V = unknown, W = unknown>( addon: AddonFcn<T, U, V, W>, fallback: FallbackFcn<T, U, V, W> ): Dispatcher<T, U, V>;
157157

158158
/**
159159
* Returns a function which dispatches to a native add-on applying a binary function to two input strided arrays using alternative indexing semantics.
@@ -179,7 +179,7 @@ interface Dispatch {
179179
* // Invoke the dispatch function with strided array arguments:
180180
* f( 2, 'generic', [ 1, 2 ], 1, 0, 'generic', [ 3, 4 ], 1, 0, 'generic', [ 0, 0 ], 1, 0 );
181181
*/
182-
ndarray( addon: AddonFcn, fallback: FallbackFcnWithOffsets ): DispatcherWithOffsets; // tslint:disable-line:max-line-length
182+
ndarray<T = unknown, U = unknown, V = unknown, W = unknown>( addon: AddonFcn<T, U, V, W>, fallback: FallbackFcnWithOffsets<T, U, V, W> ): DispatcherWithOffsets<T, U, V>;
183183
}
184184

185185
/**

‎lib/node_modules/@stdlib/strided/base/binary-addon-dispatch/docs/types/test.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
/// <reference types="@stdlib/types"/>
2020

21-
import { Collection } from '@stdlib/types/object';
21+
import { Collection } from '@stdlib/types/array';
2222
import dispatch = require( './index' );
2323

2424

@@ -38,13 +38,13 @@ import dispatch = require( './index' );
3838
* @param z - output array
3939
* @param strideZ - `z` stride length
4040
*/
41-
function addon( N: number, dtypeX: number, x: Collection, strideX: number, dtypeY: number, y: Collection, strideY: number, dtypeZ: number, z: Collection, strideZ: number ): void { // tslint:disable-line:max-line-length
41+
function addon( N: number, dtypeX: number, x: Collection<number>, strideX: number, dtypeY: number, y: Collection<number>, strideY: number, dtypeZ: number, z: Collection<number>, strideZ: number ): void {
4242
let i;
4343
if ( dtypeX !== dtypeY || dtypeY !== dtypeZ ) {
4444
throw new Error( 'beep' );
4545
}
4646
for ( i = 0; i < N; i += 1 ) {
47-
z[ i * strideZ ] = x[ i * strideX ] + y[ i * strideY ]; // tslint:disable-line:restrict-plus-operands no-unsafe-any
47+
z[ i * strideZ ] = x[ i * strideX ] + y[ i * strideY ];
4848
}
4949
}
5050

@@ -62,13 +62,13 @@ function addon( N: number, dtypeX: number, x: Collection, strideX: number, dtype
6262
* @param z - output array
6363
* @param strideZ - `z` stride length
6464
*/
65-
function fallback( N: number, dtypeX: any, x: Collection, strideX: number, dtypeY: any, y: Collection, strideY: number, dtypeZ: number, z: Collection, strideZ: number ): void { // tslint:disable-line:max-line-length
65+
function fallback( N: number, dtypeX: any, x: Collection<number>, strideX: number, dtypeY: any, y: Collection<number>, strideY: number, dtypeZ: number, z: Collection<number>, strideZ: number ): void {
6666
let i;
6767
if ( dtypeX !== dtypeY || dtypeY !== dtypeZ ) {
6868
throw new Error( 'beep' );
6969
}
7070
for ( i = 0; i < N; i += 1 ) {
71-
z[ i * strideZ ] = x[ i * strideX ] + y[ i * strideY ]; // tslint:disable-line:restrict-plus-operands no-unsafe-any
71+
z[ i * strideZ ] = x[ i * strideX ] + y[ i * strideY ];
7272
}
7373
}
7474

@@ -89,13 +89,13 @@ function fallback( N: number, dtypeX: any, x: Collection, strideX: number, dtype
8989
* @param strideZ - `z` stride length
9090
* @param offsetZ - starting `z` index
9191
*/
92-
function fallbackWithOffsets( N: number, dtypeX: any, x: Collection, strideX: number, offsetX: number, dtypeY: any, y: Collection, strideY: number, offsetY: number, dtypeZ: any, z: Collection, strideZ: number, offsetZ: number ): void { // tslint:disable-line:max-line-length
92+
function fallbackWithOffsets( N: number, dtypeX: any, x: Collection<number>, strideX: number, offsetX: number, dtypeY: any, y: Collection<number>, strideY: number, offsetY: number, dtypeZ: any, z: Collection<number>, strideZ: number, offsetZ: number ): void {
9393
let i;
9494
if ( dtypeX !== dtypeY || dtypeY !== dtypeZ ) {
9595
throw new Error( 'beep' );
9696
}
9797
for ( i = 0; i < N; i += 1 ) {
98-
z[ offsetZ + ( i * strideZ ) ] = x[ offsetX + ( i * strideX ) ] + y[ offsetY + ( i * strideY ) ]; // tslint:disable-line:max-line-length restrict-plus-operands no-unsafe-any
98+
z[ offsetZ + ( i * strideZ ) ] = x[ offsetX + ( i * strideX ) ] + y[ offsetY + ( i * strideY ) ];
9999
}
100100
}
101101

@@ -104,7 +104,7 @@ function fallbackWithOffsets( N: number, dtypeX: any, x: Collection, strideX: nu
104104

105105
// The function returns a dispatch function...
106106
{
107-
dispatch( addon, fallback ); // $ExpectType Dispatcher
107+
dispatch( addon, fallback ); // $ExpectType Dispatcher<number, number, number>
108108
}
109109

110110
// The compiler throws an error if not provided a first argument which is an add-on function...
@@ -141,7 +141,7 @@ function fallbackWithOffsets( N: number, dtypeX: any, x: Collection, strideX: nu
141141

142142
const f = dispatch( addon, fallback );
143143

144-
f( x.length, 'float64', x, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectType Collection
144+
f( x.length, 'float64', x, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectType Collection<number>
145145
}
146146

147147
// The compiler throws an error if the returned function is not provided a first argument which is a number...
@@ -263,7 +263,7 @@ function fallbackWithOffsets( N: number, dtypeX: any, x: Collection, strideX: nu
263263

264264
// Attached to the main export is an `ndarray` method which returns a dispatch function...
265265
{
266-
dispatch.ndarray( addon, fallbackWithOffsets ); // $ExpectType DispatcherWithOffsets
266+
dispatch.ndarray( addon, fallbackWithOffsets ); // $ExpectType DispatcherWithOffsets<number, number, number>
267267
}
268268

269269
// The compiler throws an error if the `ndarray` method is not provided a first argument which is an add-on function...
@@ -300,7 +300,7 @@ function fallbackWithOffsets( N: number, dtypeX: any, x: Collection, strideX: nu
300300

301301
const f = dispatch.ndarray( addon, fallbackWithOffsets );
302302

303-
f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectType Collection
303+
f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectType Collection<number>
304304
}
305305

306306
// The compiler throws an error if the returned function is not provided a first argument which is a number...

0 commit comments

Comments
 (0)