Skip to content

Commit 0ce2da2

Browse files
authored
docs: improve doctests for ndarray instances in ndarray/slice-from
PR-URL: #16236 Reviewed-by: Athan Reines <[email protected]> Ref: #9329
1 parent ffc1400 commit 0ce2da2

5 files changed

Lines changed: 62 additions & 284 deletions

File tree

‎lib/node_modules/@stdlib/ndarray/slice-from/README.md‎

Lines changed: 9 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -46,30 +46,23 @@ Returns a **read-only** shifted view of an input [ndarray][@stdlib/ndarray/ctor]
4646

4747
```javascript
4848
var ndarray = require( '@stdlib/ndarray/ctor' );
49-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
5049

5150
var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
5251
var shape = [ 3, 2 ];
5352
var strides = [ 2, 1 ];
5453
var offset = 0;
5554

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

5958
var sh = x.shape;
6059
// returns [ 3, 2 ]
6160

62-
var arr = ndarray2array( x );
63-
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
64-
6561
var y = sliceFrom( x, 1, null );
66-
// returns <ndarray>
62+
// returns <ndarray>[ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
6763

6864
sh = y.shape;
6965
// returns [ 2, 2 ]
70-
71-
arr = ndarray2array( y );
72-
// returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
7366
```
7467

7568
The function accepts the following arguments:
@@ -87,41 +80,31 @@ The following example demonstrates each invocation style returning equivalent re
8780

8881
```javascript
8982
var ndarray = require( '@stdlib/ndarray/ctor' );
90-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
9183

9284
var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
9385
var shape = [ 3, 2 ];
9486
var strides = [ 2, 1 ];
9587
var offset = 0;
9688

9789
var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
98-
// returns <ndarray>
90+
// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
9991

10092
var sh = x.shape;
10193
// returns [ 3, 2 ]
10294

103-
var arr = ndarray2array( x );
104-
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
105-
10695
// 1. Using an array of index arguments:
10796
var y = sliceFrom( x, [ 1, null ] );
108-
// returns <ndarray>
97+
// returns <ndarray>[ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
10998

11099
sh = y.shape;
111100
// returns [ 2, 2 ]
112101

113-
arr = ndarray2array( y );
114-
// returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
115-
116102
// 2. Providing separate arguments:
117103
y = sliceFrom( x, 1, null );
118-
// returns <ndarray>
104+
// returns <ndarray>[ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
119105

120106
sh = y.shape;
121107
// returns [ 2, 2 ]
122-
123-
arr = ndarray2array( y );
124-
// returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
125108
```
126109

127110
The function supports the following `options`:
@@ -132,32 +115,25 @@ By default, the function throws an error when provided an index argument which e
132115

133116
```javascript
134117
var ndarray = require( '@stdlib/ndarray/ctor' );
135-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
136118

137119
var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
138120
var shape = [ 3, 2 ];
139121
var strides = [ 2, 1 ];
140122
var offset = 0;
141123

142124
var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
143-
// returns <ndarray>
125+
// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
144126

145127
var sh = x.shape;
146128
// returns [ 3, 2 ]
147129

148-
var arr = ndarray2array( x );
149-
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
150-
151130
var y = sliceFrom( x, null, 20, {
152131
'strict': false
153132
});
154133
// returns <ndarray>
155134

156135
sh = y.shape;
157136
// returns [ 3, 0 ]
158-
159-
arr = ndarray2array( y );
160-
// returns []
161137
```
162138

163139
</section>
@@ -187,7 +163,6 @@ arr = ndarray2array( y );
187163

188164
```javascript
189165
var array = require( '@stdlib/ndarray/array' );
190-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
191166
var zeroTo = require( '@stdlib/array/base/zero-to' );
192167
var sliceFrom = require( '@stdlib/ndarray/slice-from' );
193168

@@ -201,24 +176,15 @@ var x = array( buf, {
201176

202177
// Get the last two rows of each matrix:
203178
var y1 = sliceFrom( x, null, 1, null );
204-
// returns <ndarray>
205-
206-
var a1 = ndarray2array( y1 );
207-
// returns [ [ [ 3, 4, 5 ], [ 6, 7, 8 ] ], [ [ 12, 13, 14 ], [ 15, 16, 17 ] ], [ [ 21, 22, 23 ], [ 24, 25, 26 ] ] ]
179+
// returns <ndarray>[ [ [ 3, 4, 5 ], [ 6, 7, 8 ] ], [ [ 12, 13, 14 ], [ 15, 16, 17 ] ], [ [ 21, 22, 23 ], [ 24, 25, 26 ] ] ]
208180

209181
// Get the last two rows and columns of each matrix:
210182
var y2 = sliceFrom( x, null, 1, 1 );
211-
// returns <ndarray>
212-
213-
var a2 = ndarray2array( y2 );
214-
// returns [ [ [ 4, 5 ], [ 7, 8 ] ], [ [ 13, 14 ], [ 16, 17 ] ], [ [ 22, 23 ], [ 25, 26 ] ] ]
183+
// returns <ndarray>[ [ [ 4, 5 ], [ 7, 8 ] ], [ [ 13, 14 ], [ 16, 17 ] ], [ [ 22, 23 ], [ 25, 26 ] ] ]
215184

216185
// Get the last two 2x2 matrices:
217186
var y3 = sliceFrom( x, 1, 1, 1 );
218-
// returns <ndarray>
219-
220-
var a3 = ndarray2array( y3 );
221-
// returns [ [ [ 13, 14 ], [ 16, 17 ] ], [ [ 22, 23 ], [ 25, 26 ] ] ]
187+
// returns <ndarray>[ [ [ 13, 14 ], [ 16, 17 ] ], [ [ 22, 23 ], [ 25, 26 ] ] ]
222188
```
223189

224190
</section>

‎lib/node_modules/@stdlib/ndarray/slice-from/docs/repl.txt‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,9 @@
5050
> x.shape
5151
[ 2, 2 ]
5252
> var y = {{alias}}( x, 0, 1 )
53-
<ndarray>
53+
<ndarray>[ [ 2 ], [ 4 ] ]
5454
> y.shape
5555
[ 2, 1 ]
56-
> {{alias:@stdlib/ndarray/to-array}}( y )
57-
[ [ 2 ], [ 4 ] ]
5856

5957
See Also
6058
--------

0 commit comments

Comments
 (0)