Skip to content

Commit 6485a76

Browse files
kgrytekgryte
committed
docs: update examples
1 parent dea5a9b commit 6485a76

File tree

3 files changed

+97
-99
lines changed

3 files changed

+97
-99
lines changed

‎lib/node_modules/@stdlib/strided/base/read-dataview/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
117117
var view = new DataView( x.buffer );
118118

119119
var y = new Float64Array( x.length );
120-
var out = readDataView.ndarray( y.length, view, 8, 0, y, 1, 0, true );
120+
var out = readDataView.ndarray( x.length, view, 8, 0, y, 1, 0, true );
121121
// e.g., returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
122122

123123
var bool = ( out === y );

‎lib/node_modules/@stdlib/strided/base/read-dataview/docs/types/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ interface Routine {
4545
* var view = new DataView( x.buffer );
4646
*
4747
* var y = new Float64Array( x.length );
48-
* var out = readDataView( y.length, view, 8, y, 1, true );
48+
* var out = readDataView( x.length, view, 8, y, 1, true );
4949
* // e.g., returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
5050
*
5151
* var bool = ( out === y );
@@ -74,7 +74,7 @@ interface Routine {
7474
* var view = new DataView( x.buffer );
7575
*
7676
* var y = new Float64Array( x.length );
77-
* var out = readDataView.ndarray( y.length, view, 8, 0, y, 1, 0, true );
77+
* var out = readDataView.ndarray( x.length, view, 8, 0, y, 1, 0, true );
7878
* // e.g., returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
7979
*
8080
* var bool = ( out === y );
@@ -102,7 +102,7 @@ interface Routine {
102102
* var view = new DataView( x.buffer );
103103
*
104104
* var y = new Float64Array( x.length );
105-
* var out = readDataView( y.length, view, 8, y, 1, true );
105+
* var out = readDataView( x.length, view, 8, y, 1, true );
106106
* // e.g., returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
107107
*
108108
* var bool = ( out === y );
@@ -116,7 +116,7 @@ interface Routine {
116116
* var view = new DataView( x.buffer );
117117
*
118118
* var y = new Float64Array( x.length );
119-
* var out = readDataView.ndarray( y.length, view, 8, 0, y, 1, 0, true );
119+
* var out = readDataView.ndarray( x.length, view, 8, 0, y, 1, 0, true );
120120
* // e.g., returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
121121
*
122122
* var bool = ( out === y );

‎lib/node_modules/@stdlib/strided/base/read-dataview/docs/types/test.ts

Lines changed: 92 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import readDataView = require( './index' );
2626
const x = new DataView( new ArrayBuffer( 100 ) );
2727
const y = new Float64Array( 10 );
2828

29-
readDataView( y.length, x, 1, y, 1, true ); // $ExpectType Float64Array
29+
readDataView( x.length, x, 1, y, 1, true ); // $ExpectType Float64Array
3030
}
3131

3232
// The compiler throws an error if the function is provided a first argument which is not a number...
@@ -64,57 +64,56 @@ import readDataView = require( './index' );
6464
const x = new DataView( new ArrayBuffer( 100 ) );
6565
const y = new Float64Array( 10 );
6666

67-
readDataView( y.length, x, '10', y, 1, true ); // $ExpectError
68-
readDataView( y.length, x, true, y, 1, true ); // $ExpectError
69-
readDataView( y.length, x, false, y, 1, true ); // $ExpectError
70-
readDataView( y.length, x, null, y, 1, true ); // $ExpectError
71-
readDataView( y.length, x, undefined, y, 1, true ); // $ExpectError
72-
readDataView( y.length, x, [], y, 1, true ); // $ExpectError
73-
readDataView( y.length, x, {}, y, 1, true ); // $ExpectError
74-
readDataView( y.length, x, ( x: number ): number => x, y, 1, true ); // $ExpectError
67+
readDataView( x.length, x, '10', y, 1, true ); // $ExpectError
68+
readDataView( x.length, x, true, y, 1, true ); // $ExpectError
69+
readDataView( x.length, x, false, y, 1, true ); // $ExpectError
70+
readDataView( x.length, x, null, y, 1, true ); // $ExpectError
71+
readDataView( x.length, x, undefined, y, 1, true ); // $ExpectError
72+
readDataView( x.length, x, [], y, 1, true ); // $ExpectError
73+
readDataView( x.length, x, {}, y, 1, true ); // $ExpectError
74+
readDataView( x.length, x, ( x: number ): number => x, y, 1, true ); // $ExpectError
7575
}
7676

7777
// The compiler throws an error if the function is provided a fourth argument which is not a collection...
7878
{
7979
const x = new DataView( new ArrayBuffer( 100 ) );
80-
const y = new Float64Array( 10 );
8180

82-
readDataView( y.length, x, 1, 10, 1, true ); // $ExpectError
83-
readDataView( y.length, x, 1, true, 1, true ); // $ExpectError
84-
readDataView( y.length, x, 1, false, 1, true ); // $ExpectError
85-
readDataView( y.length, x, 1, null, 1, true ); // $ExpectError
86-
readDataView( y.length, x, 1, undefined, 1, true ); // $ExpectError
87-
readDataView( y.length, x, 1, {}, 1, true ); // $ExpectError
88-
readDataView( y.length, x, 1, ( x: number ): number => x, 1, true ); // $ExpectError
81+
readDataView( x.length, x, 1, 10, 1, true ); // $ExpectError
82+
readDataView( x.length, x, 1, true, 1, true ); // $ExpectError
83+
readDataView( x.length, x, 1, false, 1, true ); // $ExpectError
84+
readDataView( x.length, x, 1, null, 1, true ); // $ExpectError
85+
readDataView( x.length, x, 1, undefined, 1, true ); // $ExpectError
86+
readDataView( x.length, x, 1, {}, 1, true ); // $ExpectError
87+
readDataView( x.length, x, 1, ( x: number ): number => x, 1, true ); // $ExpectError
8988
}
9089

9190
// The compiler throws an error if the function is provided a fifth argument which is not a number...
9291
{
9392
const x = new DataView( new ArrayBuffer( 100 ) );
9493
const y = new Float64Array( 10 );
9594

96-
readDataView( y.length, x, 1, y, '10', true ); // $ExpectError
97-
readDataView( y.length, x, 1, y, true, true ); // $ExpectError
98-
readDataView( y.length, x, 1, y, false, true ); // $ExpectError
99-
readDataView( y.length, x, 1, y, null, true ); // $ExpectError
100-
readDataView( y.length, x, 1, y, undefined, true ); // $ExpectError
101-
readDataView( y.length, x, 1, y, [], true ); // $ExpectError
102-
readDataView( y.length, x, 1, y, {}, true ); // $ExpectError
103-
readDataView( y.length, x, 1, y, ( x: number ): number => x, true ); // $ExpectError
95+
readDataView( x.length, x, 1, y, '10', true ); // $ExpectError
96+
readDataView( x.length, x, 1, y, true, true ); // $ExpectError
97+
readDataView( x.length, x, 1, y, false, true ); // $ExpectError
98+
readDataView( x.length, x, 1, y, null, true ); // $ExpectError
99+
readDataView( x.length, x, 1, y, undefined, true ); // $ExpectError
100+
readDataView( x.length, x, 1, y, [], true ); // $ExpectError
101+
readDataView( x.length, x, 1, y, {}, true ); // $ExpectError
102+
readDataView( x.length, x, 1, y, ( x: number ): number => x, true ); // $ExpectError
104103
}
105104

106105
// The compiler throws an error if the function is provided a sixth argument which is not a boolean...
107106
{
108107
const x = new DataView( new ArrayBuffer( 100 ) );
109108
const y = new Float64Array( 10 );
110109

111-
readDataView( y.length, x, 1, y, 1, '10' ); // $ExpectError
112-
readDataView( y.length, x, 1, y, 1, 0 ); // $ExpectError
113-
readDataView( y.length, x, 1, y, 1, null ); // $ExpectError
114-
readDataView( y.length, x, 1, y, 1, undefined ); // $ExpectError
115-
readDataView( y.length, x, 1, y, 1, [] ); // $ExpectError
116-
readDataView( y.length, x, 1, y, 1, {} ); // $ExpectError
117-
readDataView( y.length, x, 1, y, 1, ( x: number ): number => x ); // $ExpectError
110+
readDataView( x.length, x, 1, y, 1, '10' ); // $ExpectError
111+
readDataView( x.length, x, 1, y, 1, 0 ); // $ExpectError
112+
readDataView( x.length, x, 1, y, 1, null ); // $ExpectError
113+
readDataView( x.length, x, 1, y, 1, undefined ); // $ExpectError
114+
readDataView( x.length, x, 1, y, 1, [] ); // $ExpectError
115+
readDataView( x.length, x, 1, y, 1, {} ); // $ExpectError
116+
readDataView( x.length, x, 1, y, 1, ( x: number ): number => x ); // $ExpectError
118117
}
119118

120119
// The compiler throws an error if the function is provided an unsupported number of arguments...
@@ -123,20 +122,20 @@ import readDataView = require( './index' );
123122
const y = new Float64Array( 10 );
124123

125124
readDataView(); // $ExpectError
126-
readDataView( y.length ); // $ExpectError
127-
readDataView( y.length, x ); // $ExpectError
128-
readDataView( y.length, x, 1 ); // $ExpectError
129-
readDataView( y.length, x, 1, y ); // $ExpectError
130-
readDataView( y.length, x, 1, y, 1 ); // $ExpectError
131-
readDataView( y.length, x, 1, y, 1, true, 10 ); // $ExpectError
125+
readDataView( x.length ); // $ExpectError
126+
readDataView( x.length, x ); // $ExpectError
127+
readDataView( x.length, x, 1 ); // $ExpectError
128+
readDataView( x.length, x, 1, y ); // $ExpectError
129+
readDataView( x.length, x, 1, y, 1 ); // $ExpectError
130+
readDataView( x.length, x, 1, y, 1, true, 10 ); // $ExpectError
132131
}
133132

134133
// Attached to main export is an `ndarray` method which returns a collection...
135134
{
136135
const x = new DataView( new ArrayBuffer( 100 ) );
137136
const y = new Float64Array( 10 );
138137

139-
readDataView.ndarray( y.length, x, 1, 0, y, 1, 0, true ); // $ExpectType Float64Array
138+
readDataView.ndarray( x.length, x, 1, 0, y, 1, 0, true ); // $ExpectType Float64Array
140139
}
141140

142141
// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...
@@ -174,87 +173,86 @@ import readDataView = require( './index' );
174173
const x = new DataView( new ArrayBuffer( 100 ) );
175174
const y = new Float64Array( 10 );
176175

177-
readDataView.ndarray( y.length, x, '10', 0, y, 1, 0, true ); // $ExpectError
178-
readDataView.ndarray( y.length, x, true, 0, y, 1, 0, true ); // $ExpectError
179-
readDataView.ndarray( y.length, x, false, 0, y, 1, 0, true ); // $ExpectError
180-
readDataView.ndarray( y.length, x, null, 0, y, 1, 0, true ); // $ExpectError
181-
readDataView.ndarray( y.length, x, undefined, 0, y, 1, 0, true ); // $ExpectError
182-
readDataView.ndarray( y.length, x, [], 0, y, 1, 0, true ); // $ExpectError
183-
readDataView.ndarray( y.length, x, {}, 0, y, 1, 0, true ); // $ExpectError
184-
readDataView.ndarray( y.length, x, ( x: number ): number => x, 0, y, 1, 0, true ); // $ExpectError
176+
readDataView.ndarray( x.length, x, '10', 0, y, 1, 0, true ); // $ExpectError
177+
readDataView.ndarray( x.length, x, true, 0, y, 1, 0, true ); // $ExpectError
178+
readDataView.ndarray( x.length, x, false, 0, y, 1, 0, true ); // $ExpectError
179+
readDataView.ndarray( x.length, x, null, 0, y, 1, 0, true ); // $ExpectError
180+
readDataView.ndarray( x.length, x, undefined, 0, y, 1, 0, true ); // $ExpectError
181+
readDataView.ndarray( x.length, x, [], 0, y, 1, 0, true ); // $ExpectError
182+
readDataView.ndarray( x.length, x, {}, 0, y, 1, 0, true ); // $ExpectError
183+
readDataView.ndarray( x.length, x, ( x: number ): number => x, 0, y, 1, 0, true ); // $ExpectError
185184
}
186185

187186
// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number...
188187
{
189188
const x = new DataView( new ArrayBuffer( 100 ) );
190189
const y = new Float64Array( 10 );
191190

192-
readDataView.ndarray( y.length, x, 1, '10', y, 1, 0, true ); // $ExpectError
193-
readDataView.ndarray( y.length, x, 1, true, y, 1, 0, true ); // $ExpectError
194-
readDataView.ndarray( y.length, x, 1, false, y, 1, 0, true ); // $ExpectError
195-
readDataView.ndarray( y.length, x, 1, null, y, 1, 0, true ); // $ExpectError
196-
readDataView.ndarray( y.length, x, 1, undefined, y, 1, 0, true ); // $ExpectError
197-
readDataView.ndarray( y.length, x, 1, [], y, 1, 0, true ); // $ExpectError
198-
readDataView.ndarray( y.length, x, 1, {}, y, 1, 0, true ); // $ExpectError
199-
readDataView.ndarray( y.length, x, 1, ( x: number ): number => x, y, 1, 0, true ); // $ExpectError
191+
readDataView.ndarray( x.length, x, 1, '10', y, 1, 0, true ); // $ExpectError
192+
readDataView.ndarray( x.length, x, 1, true, y, 1, 0, true ); // $ExpectError
193+
readDataView.ndarray( x.length, x, 1, false, y, 1, 0, true ); // $ExpectError
194+
readDataView.ndarray( x.length, x, 1, null, y, 1, 0, true ); // $ExpectError
195+
readDataView.ndarray( x.length, x, 1, undefined, y, 1, 0, true ); // $ExpectError
196+
readDataView.ndarray( x.length, x, 1, [], y, 1, 0, true ); // $ExpectError
197+
readDataView.ndarray( x.length, x, 1, {}, y, 1, 0, true ); // $ExpectError
198+
readDataView.ndarray( x.length, x, 1, ( x: number ): number => x, y, 1, 0, true ); // $ExpectError
200199
}
201200

202201
// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a collection...
203202
{
204203
const x = new DataView( new ArrayBuffer( 100 ) );
205-
const y = new Float64Array( 10 );
206204

207-
readDataView.ndarray( y.length, x, 1, 0, 10, 1, 0, true ); // $ExpectError
208-
readDataView.ndarray( y.length, x, 1, 0, true, 1, 0, true ); // $ExpectError
209-
readDataView.ndarray( y.length, x, 1, 0, false, 1, 0, true ); // $ExpectError
210-
readDataView.ndarray( y.length, x, 1, 0, null, 1, 0, true ); // $ExpectError
211-
readDataView.ndarray( y.length, x, 1, 0, undefined, 1, 0, true ); // $ExpectError
212-
readDataView.ndarray( y.length, x, 1, 0, {}, 1, 0, true ); // $ExpectError
213-
readDataView.ndarray( y.length, x, 1, 0, ( x: number ): number => x, 1, 0, true ); // $ExpectError
205+
readDataView.ndarray( x.length, x, 1, 0, 10, 1, 0, true ); // $ExpectError
206+
readDataView.ndarray( x.length, x, 1, 0, true, 1, 0, true ); // $ExpectError
207+
readDataView.ndarray( x.length, x, 1, 0, false, 1, 0, true ); // $ExpectError
208+
readDataView.ndarray( x.length, x, 1, 0, null, 1, 0, true ); // $ExpectError
209+
readDataView.ndarray( x.length, x, 1, 0, undefined, 1, 0, true ); // $ExpectError
210+
readDataView.ndarray( x.length, x, 1, 0, {}, 1, 0, true ); // $ExpectError
211+
readDataView.ndarray( x.length, x, 1, 0, ( x: number ): number => x, 1, 0, true ); // $ExpectError
214212
}
215213

216214
// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number...
217215
{
218216
const x = new DataView( new ArrayBuffer( 100 ) );
219217
const y = new Float64Array( 10 );
220218

221-
readDataView.ndarray( y.length, x, 1, 0, y, '10', 0, true ); // $ExpectError
222-
readDataView.ndarray( y.length, x, 1, 0, y, true, 0, true ); // $ExpectError
223-
readDataView.ndarray( y.length, x, 1, 0, y, false, 0, true ); // $ExpectError
224-
readDataView.ndarray( y.length, x, 1, 0, y, null, 0, true ); // $ExpectError
225-
readDataView.ndarray( y.length, x, 1, 0, y, undefined, 0, true ); // $ExpectError
226-
readDataView.ndarray( y.length, x, 1, 0, y, [], 0, true ); // $ExpectError
227-
readDataView.ndarray( y.length, x, 1, 0, y, {}, 0, true ); // $ExpectError
228-
readDataView.ndarray( y.length, x, 1, 0, y, ( x: number ): number => x, 0, true ); // $ExpectError
219+
readDataView.ndarray( x.length, x, 1, 0, y, '10', 0, true ); // $ExpectError
220+
readDataView.ndarray( x.length, x, 1, 0, y, true, 0, true ); // $ExpectError
221+
readDataView.ndarray( x.length, x, 1, 0, y, false, 0, true ); // $ExpectError
222+
readDataView.ndarray( x.length, x, 1, 0, y, null, 0, true ); // $ExpectError
223+
readDataView.ndarray( x.length, x, 1, 0, y, undefined, 0, true ); // $ExpectError
224+
readDataView.ndarray( x.length, x, 1, 0, y, [], 0, true ); // $ExpectError
225+
readDataView.ndarray( x.length, x, 1, 0, y, {}, 0, true ); // $ExpectError
226+
readDataView.ndarray( x.length, x, 1, 0, y, ( x: number ): number => x, 0, true ); // $ExpectError
229227
}
230228

231229
// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number...
232230
{
233231
const x = new DataView( new ArrayBuffer( 100 ) );
234232
const y = new Float64Array( 10 );
235233

236-
readDataView.ndarray( y.length, x, 1, 0, y, 1, '10', true ); // $ExpectError
237-
readDataView.ndarray( y.length, x, 1, 0, y, 1, true, true ); // $ExpectError
238-
readDataView.ndarray( y.length, x, 1, 0, y, 1, false, true ); // $ExpectError
239-
readDataView.ndarray( y.length, x, 1, 0, y, 1, null, true ); // $ExpectError
240-
readDataView.ndarray( y.length, x, 1, 0, y, 1, undefined, true ); // $ExpectError
241-
readDataView.ndarray( y.length, x, 1, 0, y, 1, [], true ); // $ExpectError
242-
readDataView.ndarray( y.length, x, 1, 0, y, 1, {}, true ); // $ExpectError
243-
readDataView.ndarray( y.length, x, 1, 0, y, 1, ( x: number ): number => x, true ); // $ExpectError
234+
readDataView.ndarray( x.length, x, 1, 0, y, 1, '10', true ); // $ExpectError
235+
readDataView.ndarray( x.length, x, 1, 0, y, 1, true, true ); // $ExpectError
236+
readDataView.ndarray( x.length, x, 1, 0, y, 1, false, true ); // $ExpectError
237+
readDataView.ndarray( x.length, x, 1, 0, y, 1, null, true ); // $ExpectError
238+
readDataView.ndarray( x.length, x, 1, 0, y, 1, undefined, true ); // $ExpectError
239+
readDataView.ndarray( x.length, x, 1, 0, y, 1, [], true ); // $ExpectError
240+
readDataView.ndarray( x.length, x, 1, 0, y, 1, {}, true ); // $ExpectError
241+
readDataView.ndarray( x.length, x, 1, 0, y, 1, ( x: number ): number => x, true ); // $ExpectError
244242
}
245243

246244
// The compiler throws an error if the `ndarray` method is provided an eighth argument which is not a boolean...
247245
{
248246
const x = new DataView( new ArrayBuffer( 100 ) );
249247
const y = new Float64Array( 10 );
250248

251-
readDataView.ndarray( y.length, x, 1, 0, y, 1, 0, '10' ); // $ExpectError
252-
readDataView.ndarray( y.length, x, 1, 0, y, 1, 0, 0 ); // $ExpectError
253-
readDataView.ndarray( y.length, x, 1, 0, y, 1, 0, null ); // $ExpectError
254-
readDataView.ndarray( y.length, x, 1, 0, y, 1, 0, undefined ); // $ExpectError
255-
readDataView.ndarray( y.length, x, 1, 0, y, 1, 0, [] ); // $ExpectError
256-
readDataView.ndarray( y.length, x, 1, 0, y, 1, 0, {} ); // $ExpectError
257-
readDataView.ndarray( y.length, x, 1, 0, y, 1, 0, ( x: number ): number => x ); // $ExpectError
249+
readDataView.ndarray( x.length, x, 1, 0, y, 1, 0, '10' ); // $ExpectError
250+
readDataView.ndarray( x.length, x, 1, 0, y, 1, 0, 0 ); // $ExpectError
251+
readDataView.ndarray( x.length, x, 1, 0, y, 1, 0, null ); // $ExpectError
252+
readDataView.ndarray( x.length, x, 1, 0, y, 1, 0, undefined ); // $ExpectError
253+
readDataView.ndarray( x.length, x, 1, 0, y, 1, 0, [] ); // $ExpectError
254+
readDataView.ndarray( x.length, x, 1, 0, y, 1, 0, {} ); // $ExpectError
255+
readDataView.ndarray( x.length, x, 1, 0, y, 1, 0, ( x: number ): number => x ); // $ExpectError
258256
}
259257

260258
// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments...
@@ -263,12 +261,12 @@ import readDataView = require( './index' );
263261
const y = new Float64Array( 10 );
264262

265263
readDataView.ndarray(); // $ExpectError
266-
readDataView.ndarray( y.length ); // $ExpectError
267-
readDataView.ndarray( y.length, x ); // $ExpectError
268-
readDataView.ndarray( y.length, x, 1 ); // $ExpectError
269-
readDataView.ndarray( y.length, x, 1, 0 ); // $ExpectError
270-
readDataView.ndarray( y.length, x, 1, 0, y ); // $ExpectError
271-
readDataView.ndarray( y.length, x, 1, 0, y, 1 ); // $ExpectError
272-
readDataView.ndarray( y.length, x, 1, 0, y, 1, 0 ); // $ExpectError
273-
readDataView.ndarray( y.length, x, 1, 0, y, 1, 0, true, 10 ); // $ExpectError
264+
readDataView.ndarray( x.length ); // $ExpectError
265+
readDataView.ndarray( x.length, x ); // $ExpectError
266+
readDataView.ndarray( x.length, x, 1 ); // $ExpectError
267+
readDataView.ndarray( x.length, x, 1, 0 ); // $ExpectError
268+
readDataView.ndarray( x.length, x, 1, 0, y ); // $ExpectError
269+
readDataView.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError
270+
readDataView.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectError
271+
readDataView.ndarray( x.length, x, 1, 0, y, 1, 0, true, 10 ); // $ExpectError
274272
}

0 commit comments

Comments
 (0)