Skip to content

Commit dcc971a

Browse files
kgrytekgryte
committed
docs: update examples and use accessor functions
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 16ce439 commit dcc971a

6 files changed

Lines changed: 96 additions & 95 deletions

File tree

‎lib/node_modules/@stdlib/ndarray/base/fliplr/README.md‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Returns a view of an input ndarray in which the order of elements along the last
4646

4747
```javascript
4848
var ndarray = require( '@stdlib/ndarray/ctor' );
49+
var getShape = require( '@stdlib/ndarray/shape' );
4950
var ndarray2array = require( '@stdlib/ndarray/to-array' );
5051

5152
var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
@@ -54,22 +55,16 @@ var strides = [ 2, 1 ];
5455
var offset = 0;
5556

5657
var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
57-
// returns <ndarray>
58+
// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
5859

59-
var sh = x.shape;
60+
var sh = getShape( x );
6061
// returns [ 3, 2 ]
6162

62-
var arr = ndarray2array( x );
63-
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
64-
6563
var y = fliplr( x, false );
66-
// returns <ndarray>
64+
// returns <ndarray>[ [ 2.0, 1.0 ], [ 4.0, 3.0 ], [ 6.0, 5.0 ] ]
6765

68-
sh = y.shape;
66+
sh = getShape( y );
6967
// returns [ 3, 2 ]
70-
71-
arr = ndarray2array( y );
72-
// returns [ [ 2.0, 1.0 ], [ 4.0, 3.0 ], [ 6.0, 5.0 ] ]
7368
```
7469

7570
The function accepts the following arguments:

‎lib/node_modules/@stdlib/ndarray/base/fliplr/docs/repl.txt‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,14 @@
2424
Examples
2525
--------
2626
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] )
27-
<ndarray>
28-
> x.shape
27+
<ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
28+
> {{alias:@stdlib/ndarray/shape}}( x )
2929
[ 2, 2 ]
3030
> var y = {{alias}}( x, false )
31-
<ndarray>
32-
> y.shape
31+
<ndarray>[ [ 2, 1 ], [ 4, 3 ] ]
32+
> {{alias:@stdlib/ndarray/shape}}( y )
3333
[ 2, 2 ]
34-
> {{alias:@stdlib/ndarray/to-array}}( y )
35-
[ [ 2, 1 ], [ 4, 3 ] ]
34+
3635

3736
See Also
3837
--------

‎lib/node_modules/@stdlib/ndarray/base/fliplr/docs/types/index.d.ts‎

Lines changed: 39 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import { typedndarray, genericndarray, float64ndarray, float32ndarray, int32ndar
3232
* @example
3333
* var typedarray = require( '@stdlib/array/typed' );
3434
* var ndarray = require( '@stdlib/ndarray/ctor' );
35+
* var getShape = require( '@stdlib/ndarray/shape' );
3536
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
3637
*
3738
* var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float64' );
@@ -42,7 +43,7 @@ import { typedndarray, genericndarray, float64ndarray, float32ndarray, int32ndar
4243
* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
4344
* // returns <ndarray>
4445
*
45-
* var sh = x.shape;
46+
* var sh = getShape( x );
4647
* // returns [ 3, 2 ]
4748
*
4849
* var arr = ndarray2array( x );
@@ -51,7 +52,7 @@ import { typedndarray, genericndarray, float64ndarray, float32ndarray, int32ndar
5152
* var y = fliplr( x, false );
5253
* // returns <ndarray>
5354
*
54-
* sh = y.shape;
55+
* sh = getShape( y );
5556
* // returns [ 3, 2 ]
5657
*
5758
* arr = ndarray2array( y );
@@ -69,6 +70,7 @@ declare function fliplr( x: float64ndarray, writable: boolean ): float64ndarray;
6970
* @example
7071
* var typedarray = require( '@stdlib/array/typed' );
7172
* var ndarray = require( '@stdlib/ndarray/ctor' );
73+
* var getShape = require( '@stdlib/ndarray/shape' );
7274
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
7375
*
7476
* var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float32' );
@@ -79,7 +81,7 @@ declare function fliplr( x: float64ndarray, writable: boolean ): float64ndarray;
7981
* var x = ndarray( 'float32', buffer, shape, strides, offset, 'row-major' );
8082
* // returns <ndarray>
8183
*
82-
* var sh = x.shape;
84+
* var sh = getShape( x );
8385
* // returns [ 3, 2 ]
8486
*
8587
* var arr = ndarray2array( x );
@@ -88,7 +90,7 @@ declare function fliplr( x: float64ndarray, writable: boolean ): float64ndarray;
8890
* var y = fliplr( x, false );
8991
* // returns <ndarray>
9092
*
91-
* sh = y.shape;
93+
* sh = getShape( y );
9294
* // returns [ 3, 2 ]
9395
*
9496
* arr = ndarray2array( y );
@@ -106,6 +108,7 @@ declare function fliplr( x: float32ndarray, writable: boolean ): float32ndarray;
106108
* @example
107109
* var typedarray = require( '@stdlib/array/typed' );
108110
* var ndarray = require( '@stdlib/ndarray/ctor' );
111+
* var getShape = require( '@stdlib/ndarray/shape' );
109112
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
110113
*
111114
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'int32' );
@@ -116,7 +119,7 @@ declare function fliplr( x: float32ndarray, writable: boolean ): float32ndarray;
116119
* var x = ndarray( 'int32', buffer, shape, strides, offset, 'row-major' );
117120
* // returns <ndarray>
118121
*
119-
* var sh = x.shape;
122+
* var sh = getShape( x );
120123
* // returns [ 3, 2 ]
121124
*
122125
* var arr = ndarray2array( x );
@@ -125,7 +128,7 @@ declare function fliplr( x: float32ndarray, writable: boolean ): float32ndarray;
125128
* var y = fliplr( x, false );
126129
* // returns <ndarray>
127130
*
128-
* sh = y.shape;
131+
* sh = getShape( y );
129132
* // returns [ 3, 2 ]
130133
*
131134
* arr = ndarray2array( y );
@@ -143,6 +146,7 @@ declare function fliplr( x: int32ndarray, writable: boolean ): int32ndarray;
143146
* @example
144147
* var typedarray = require( '@stdlib/array/typed' );
145148
* var ndarray = require( '@stdlib/ndarray/ctor' );
149+
* var getShape = require( '@stdlib/ndarray/shape' );
146150
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
147151
*
148152
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'int16' );
@@ -153,7 +157,7 @@ declare function fliplr( x: int32ndarray, writable: boolean ): int32ndarray;
153157
* var x = ndarray( 'int16', buffer, shape, strides, offset, 'row-major' );
154158
* // returns <ndarray>
155159
*
156-
* var sh = x.shape;
160+
* var sh = getShape( x );
157161
* // returns [ 3, 2 ]
158162
*
159163
* var arr = ndarray2array( x );
@@ -162,7 +166,7 @@ declare function fliplr( x: int32ndarray, writable: boolean ): int32ndarray;
162166
* var y = fliplr( x, false );
163167
* // returns <ndarray>
164168
*
165-
* sh = y.shape;
169+
* sh = getShape( y );
166170
* // returns [ 3, 2 ]
167171
*
168172
* arr = ndarray2array( y );
@@ -180,6 +184,7 @@ declare function fliplr( x: int16ndarray, writable: boolean ): int16ndarray;
180184
* @example
181185
* var typedarray = require( '@stdlib/array/typed' );
182186
* var ndarray = require( '@stdlib/ndarray/ctor' );
187+
* var getShape = require( '@stdlib/ndarray/shape' );
183188
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
184189
*
185190
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'int8' );
@@ -190,7 +195,7 @@ declare function fliplr( x: int16ndarray, writable: boolean ): int16ndarray;
190195
* var x = ndarray( 'int8', buffer, shape, strides, offset, 'row-major' );
191196
* // returns <ndarray>
192197
*
193-
* var sh = x.shape;
198+
* var sh = getShape( x );
194199
* // returns [ 3, 2 ]
195200
*
196201
* var arr = ndarray2array( x );
@@ -199,7 +204,7 @@ declare function fliplr( x: int16ndarray, writable: boolean ): int16ndarray;
199204
* var y = fliplr( x, false );
200205
* // returns <ndarray>
201206
*
202-
* sh = y.shape;
207+
* sh = getShape( y );
203208
* // returns [ 3, 2 ]
204209
*
205210
* arr = ndarray2array( y );
@@ -217,6 +222,7 @@ declare function fliplr( x: int8ndarray, writable: boolean ): int8ndarray;
217222
* @example
218223
* var typedarray = require( '@stdlib/array/typed' );
219224
* var ndarray = require( '@stdlib/ndarray/ctor' );
225+
* var getShape = require( '@stdlib/ndarray/shape' );
220226
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
221227
*
222228
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint32' );
@@ -227,7 +233,7 @@ declare function fliplr( x: int8ndarray, writable: boolean ): int8ndarray;
227233
* var x = ndarray( 'uint32', buffer, shape, strides, offset, 'row-major' );
228234
* // returns <ndarray>
229235
*
230-
* var sh = x.shape;
236+
* var sh = getShape( x );
231237
* // returns [ 3, 2 ]
232238
*
233239
* var arr = ndarray2array( x );
@@ -236,7 +242,7 @@ declare function fliplr( x: int8ndarray, writable: boolean ): int8ndarray;
236242
* var y = fliplr( x, false );
237243
* // returns <ndarray>
238244
*
239-
* sh = y.shape;
245+
* sh = getShape( y );
240246
* // returns [ 3, 2 ]
241247
*
242248
* arr = ndarray2array( y );
@@ -254,6 +260,7 @@ declare function fliplr( x: uint32ndarray, writable: boolean ): uint32ndarray;
254260
* @example
255261
* var typedarray = require( '@stdlib/array/typed' );
256262
* var ndarray = require( '@stdlib/ndarray/ctor' );
263+
* var getShape = require( '@stdlib/ndarray/shape' );
257264
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
258265
*
259266
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint16' );
@@ -264,7 +271,7 @@ declare function fliplr( x: uint32ndarray, writable: boolean ): uint32ndarray;
264271
* var x = ndarray( 'uint16', buffer, shape, strides, offset, 'row-major' );
265272
* // returns <ndarray>
266273
*
267-
* var sh = x.shape;
274+
* var sh = getShape( x );
268275
* // returns [ 3, 2 ]
269276
*
270277
* var arr = ndarray2array( x );
@@ -273,7 +280,7 @@ declare function fliplr( x: uint32ndarray, writable: boolean ): uint32ndarray;
273280
* var y = fliplr( x, false );
274281
* // returns <ndarray>
275282
*
276-
* sh = y.shape;
283+
* sh = getShape( y );
277284
* // returns [ 3, 2 ]
278285
*
279286
* arr = ndarray2array( y );
@@ -291,6 +298,7 @@ declare function fliplr( x: uint16ndarray, writable: boolean ): uint16ndarray;
291298
* @example
292299
* var typedarray = require( '@stdlib/array/typed' );
293300
* var ndarray = require( '@stdlib/ndarray/ctor' );
301+
* var getShape = require( '@stdlib/ndarray/shape' );
294302
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
295303
*
296304
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint8' );
@@ -301,7 +309,7 @@ declare function fliplr( x: uint16ndarray, writable: boolean ): uint16ndarray;
301309
* var x = ndarray( 'uint8', buffer, shape, strides, offset, 'row-major' );
302310
* // returns <ndarray>
303311
*
304-
* var sh = x.shape;
312+
* var sh = getShape( x );
305313
* // returns [ 3, 2 ]
306314
*
307315
* var arr = ndarray2array( x );
@@ -310,7 +318,7 @@ declare function fliplr( x: uint16ndarray, writable: boolean ): uint16ndarray;
310318
* var y = fliplr( x, false );
311319
* // returns <ndarray>
312320
*
313-
* sh = y.shape;
321+
* sh = getShape( y );
314322
* // returns [ 3, 2 ]
315323
*
316324
* arr = ndarray2array( y );
@@ -328,6 +336,7 @@ declare function fliplr( x: uint8ndarray, writable: boolean ): uint8ndarray;
328336
* @example
329337
* var typedarray = require( '@stdlib/array/typed' );
330338
* var ndarray = require( '@stdlib/ndarray/ctor' );
339+
* var getShape = require( '@stdlib/ndarray/shape' );
331340
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
332341
*
333342
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint8c' );
@@ -338,7 +347,7 @@ declare function fliplr( x: uint8ndarray, writable: boolean ): uint8ndarray;
338347
* var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' );
339348
* // returns <ndarray>
340349
*
341-
* var sh = x.shape;
350+
* var sh = getShape( x );
342351
* // returns [ 3, 2 ]
343352
*
344353
* var arr = ndarray2array( x );
@@ -347,7 +356,7 @@ declare function fliplr( x: uint8ndarray, writable: boolean ): uint8ndarray;
347356
* var y = fliplr( x, false );
348357
* // returns <ndarray>
349358
*
350-
* sh = y.shape;
359+
* sh = getShape( y );
351360
* // returns [ 3, 2 ]
352361
*
353362
* arr = ndarray2array( y );
@@ -365,6 +374,7 @@ declare function fliplr( x: uint8cndarray, writable: boolean ): uint8cndarray;
365374
* @example
366375
* var typedarray = require( '@stdlib/array/typed' );
367376
* var ndarray = require( '@stdlib/ndarray/ctor' );
377+
* var getShape = require( '@stdlib/ndarray/shape' );
368378
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
369379
*
370380
* var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ], 'complex128' );
@@ -375,13 +385,13 @@ declare function fliplr( x: uint8cndarray, writable: boolean ): uint8cndarray;
375385
* var x = ndarray( 'complex128', buffer, shape, strides, offset, 'row-major' );
376386
* // returns <ndarray>
377387
*
378-
* var sh = x.shape;
388+
* var sh = getShape( x );
379389
* // returns [ 3, 2 ]
380390
*
381391
* var y = fliplr( x, false );
382392
* // returns <ndarray>
383393
*
384-
* sh = y.shape;
394+
* sh = getShape( y );
385395
* // returns [ 3, 2 ]
386396
*/
387397
declare function fliplr( x: complex128ndarray, writable: boolean ): complex128ndarray;
@@ -396,6 +406,7 @@ declare function fliplr( x: complex128ndarray, writable: boolean ): complex128nd
396406
* @example
397407
* var typedarray = require( '@stdlib/array/typed' );
398408
* var ndarray = require( '@stdlib/ndarray/ctor' );
409+
* var getShape = require( '@stdlib/ndarray/shape' );
399410
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
400411
*
401412
* var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ], 'complex64' );
@@ -406,13 +417,13 @@ declare function fliplr( x: complex128ndarray, writable: boolean ): complex128nd
406417
* var x = ndarray( 'complex64', buffer, shape, strides, offset, 'row-major' );
407418
* // returns <ndarray>
408419
*
409-
* var sh = x.shape;
420+
* var sh = getShape( x );
410421
* // returns [ 3, 2 ]
411422
*
412423
* var y = fliplr( x, false );
413424
* // returns <ndarray>
414425
*
415-
* sh = y.shape;
426+
* sh = getShape( y );
416427
* // returns [ 3, 2 ]
417428
*/
418429
declare function fliplr( x: complex64ndarray, writable: boolean ): complex64ndarray;
@@ -427,6 +438,7 @@ declare function fliplr( x: complex64ndarray, writable: boolean ): complex64ndar
427438
* @example
428439
* var typedarray = require( '@stdlib/array/typed' );
429440
* var ndarray = require( '@stdlib/ndarray/ctor' );
441+
* var getShape = require( '@stdlib/ndarray/shape' );
430442
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
431443
*
432444
* var buffer = [ 1, 2, 3, 4, 5, 6 ];
@@ -437,7 +449,7 @@ declare function fliplr( x: complex64ndarray, writable: boolean ): complex64ndar
437449
* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
438450
* // returns <ndarray>
439451
*
440-
* var sh = x.shape;
452+
* var sh = getShape( x );
441453
* // returns [ 3, 2 ]
442454
*
443455
* var arr = ndarray2array( x );
@@ -446,7 +458,7 @@ declare function fliplr( x: complex64ndarray, writable: boolean ): complex64ndar
446458
* var y = fliplr( x, false );
447459
* // returns <ndarray>
448460
*
449-
* sh = y.shape;
461+
* sh = getShape( y );
450462
* // returns [ 3, 2 ]
451463
*
452464
* arr = ndarray2array( y );
@@ -464,6 +476,7 @@ declare function fliplr<T = unknown>( x: genericndarray<T>, writable: boolean ):
464476
* @example
465477
* var typedarray = require( '@stdlib/array/typed' );
466478
* var ndarray = require( '@stdlib/ndarray/ctor' );
479+
* var getShape = require( '@stdlib/ndarray/shape' );
467480
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
468481
*
469482
* var buffer = [ 1, 2, 3, 4, 5, 6 ];
@@ -474,7 +487,7 @@ declare function fliplr<T = unknown>( x: genericndarray<T>, writable: boolean ):
474487
* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
475488
* // returns <ndarray>
476489
*
477-
* var sh = x.shape;
490+
* var sh = getShape( x );
478491
* // returns [ 3, 2 ]
479492
*
480493
* var arr = ndarray2array( x );
@@ -483,7 +496,7 @@ declare function fliplr<T = unknown>( x: genericndarray<T>, writable: boolean ):
483496
* var y = fliplr( x, false );
484497
* // returns <ndarray>
485498
*
486-
* sh = y.shape;
499+
* sh = getShape( y );
487500
* // returns [ 3, 2 ]
488501
*
489502
* arr = ndarray2array( y );

0 commit comments

Comments
 (0)