Skip to content

Commit 1207752

Browse files
committed
docs: apply suggestions from code review
--- 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: na - 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 335515c commit 1207752

7 files changed

Lines changed: 33 additions & 98 deletions

File tree

lib/node_modules/@stdlib/blas/ext/zero-to/README.md

Lines changed: 7 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,8 @@ var zeroTo = require( '@stdlib/blas/ext/zero-to' );
3535
Returns a new [ndarray][@stdlib/ndarray/ctor] filled with linearly spaced numeric elements which increment by `1` starting from zero along one or more [ndarray][@stdlib/ndarray/ctor] dimensions.
3636

3737
```javascript
38-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
39-
40-
var x = zeroTo( [ 3 ] );
41-
// returns <ndarray>
42-
43-
var arr = ndarray2array( x );
44-
// returns [ 0.0, 1.0, 2.0 ]
38+
var x = zeroTo( [ 2, 3 ] );
39+
// returns <ndarray>[ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
4540
```
4641

4742
The function has the following parameters:
@@ -60,50 +55,36 @@ The function accepts the following options:
6055
By default, the function generates values along the last dimension of an output [ndarray][@stdlib/ndarray/ctor]. To perform the operation over specific dimensions, provide a `dims` option.
6156

6257
```javascript
63-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
64-
6558
var x = zeroTo( [ 2, 2 ], {
6659
'dims': [ 0, 1 ]
6760
});
68-
// returns <ndarray>
69-
70-
var arr = ndarray2array( x );
71-
// returns [ [ 0.0, 1.0 ], [ 2.0, 3.0 ] ]
61+
// returns <ndarray>[ [ 0.0, 1.0 ], [ 2.0, 3.0 ] ]
7262
```
7363

7464
To specify the output [ndarray][@stdlib/ndarray/ctor] [data type][@stdlib/ndarray/dtypes], provide a `dtype` option.
7565

7666
```javascript
77-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
78-
7967
var x = zeroTo( [ 3 ], {
8068
'dtype': 'float32'
8169
});
82-
// returns <ndarray>
83-
84-
var arr = ndarray2array( x );
85-
// returns [ 0.0, 1.0, 2.0 ]
70+
// returns <ndarray>[ 0.0, 1.0, 2.0 ]
8671
```
8772

8873
#### zeroTo.assign( x\[, options] )
8974

9075
Fills an [ndarray][@stdlib/ndarray/ctor] with linearly spaced numeric elements which increment by `1` starting from zero along one or more [ndarray][@stdlib/ndarray/ctor] dimensions.
9176

9277
```javascript
93-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
9478
var zeros = require( '@stdlib/ndarray/zeros' );
9579

96-
var x = zeros( [ 3 ] );
97-
// returns <ndarray>
80+
var x = zeros( [ 2, 3 ] );
81+
// returns <ndarray>[ [ 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0 ] ]
9882

9983
var out = zeroTo.assign( x );
100-
// returns <ndarray>
84+
// returns <ndarray>[ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
10185

10286
var bool = ( x === out );
10387
// returns true
104-
105-
var arr = ndarray2array( out );
106-
// returns [ 0.0, 1.0, 2.0 ]
10788
```
10889

10990
The function has the following parameters:

lib/node_modules/@stdlib/blas/ext/zero-to/docs/repl.txt

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,8 @@
5353

5454
Examples
5555
--------
56-
> var out = {{alias}}( [ 3 ] );
57-
> {{alias:@stdlib/ndarray/to-array}}( out )
58-
[ 0.0, 1.0, 2.0 ]
56+
> var out = {{alias}}( [ 2, 3 ] )
57+
<ndarray>[ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
5958

6059

6160
{{alias}}.assign( x[, options] )
@@ -84,10 +83,9 @@
8483

8584
Examples
8685
--------
87-
> var x = {{alias:@stdlib/ndarray/zeros}}( [ 3 ] );
88-
> var out = {{alias}}.assign( x );
89-
> {{alias:@stdlib/ndarray/to-array}}( out )
90-
[ 0.0, 1.0, 2.0 ]
86+
> var x = {{alias:@stdlib/ndarray/zeros}}( [ 2, 3 ] );
87+
> var out = {{alias}}.assign( x )
88+
<ndarray>[ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
9189
> var bool = ( out === x )
9290
true
9391

lib/node_modules/@stdlib/blas/ext/zero-to/docs/types/index.d.ts

Lines changed: 10 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,8 @@ interface ZeroTo {
7575
* @returns output ndarray
7676
*
7777
* @example
78-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
79-
*
80-
* var out = zeroTo( [ 3 ] );
81-
* // returns <ndarray>
82-
*
83-
* var arr = ndarray2array( out );
84-
* // returns [ 0.0, 1.0, 2.0 ]
78+
* var out = zeroTo( [ 2, 3 ] );
79+
* // returns <ndarray>[ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
8580
*/
8681
( shape: number | ArrayLike<number>, options?: Options ): OutputArray;
8782

@@ -98,19 +93,15 @@ interface ZeroTo {
9893
*
9994
* @example
10095
* var zeros = require( '@stdlib/ndarray/zeros' );
101-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
10296
*
103-
* var x = zeros( [ 3 ] );
104-
* // returns <ndarray>
97+
* var x = zeros( [ 2, 3 ] );
98+
* // returns <ndarray>[ [ 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0 ] ]
10599
*
106100
* var out = zeroTo.assign( x );
107-
* // returns <ndarray>
101+
* // returns <ndarray>[ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
108102
*
109103
* var bool = ( out === x );
110104
* // returns true
111-
*
112-
* var arr = ndarray2array( out );
113-
* // returns [ 0.0, 1.0, 2.0 ]
114105
*/
115106
assign<T extends OutputArray = OutputArray>( x: T, options?: BaseOptions ): T;
116107
}
@@ -123,29 +114,20 @@ interface ZeroTo {
123114
* @returns output ndarray
124115
*
125116
* @example
126-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
127-
*
128-
* var out = zeroTo( [ 3 ] );
129-
* // returns <ndarray>
130-
*
131-
* var arr = ndarray2array( out );
132-
* // returns [ 0.0, 1.0, 2.0 ]
117+
* var out = zeroTo( [ 2, 3 ] );
118+
* // returns <ndarray>[ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
133119
*
134120
* @example
135121
* var zeros = require( '@stdlib/ndarray/zeros' );
136-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
137122
*
138-
* var x = zeros( [ 3 ] );
139-
* // returns <ndarray>
123+
* var x = zeros( [ 2, 3 ] );
124+
* // returns <ndarray>[ [ 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0 ] ]
140125
*
141126
* var out = zeroTo.assign( x );
142-
* // returns <ndarray>
127+
* // returns <ndarray>[ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
143128
*
144129
* var bool = ( out === x );
145130
* // returns true
146-
*
147-
* var arr = ndarray2array( out );
148-
* // returns [ 0.0, 1.0, 2.0 ]
149131
*/
150132
declare const zeroTo: ZeroTo;
151133

lib/node_modules/@stdlib/blas/ext/zero-to/lib/assign.js

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,19 +54,15 @@ var base = require( './base.js' );
5454
*
5555
* @example
5656
* var zeros = require( '@stdlib/ndarray/zeros' );
57-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
5857
*
59-
* var x = zeros( [ 3 ] );
60-
* // returns <ndarray>
58+
* var x = zeros( [ 2, 3 ] );
59+
* // returns <ndarray>[ [ 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0 ] ]
6160
*
6261
* var out = assign( x );
63-
* // returns <ndarray>
62+
* // returns <ndarray>[ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
6463
*
6564
* var bool = ( out === x );
6665
* // returns true
67-
*
68-
* var arr = ndarray2array( out );
69-
* // returns [ 0.0, 1.0, 2.0 ]
7066
*/
7167
function assign( x ) {
7268
var options;

lib/node_modules/@stdlib/blas/ext/zero-to/lib/base.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,13 @@ var options = {
7171
* @returns {ndarray} output ndarray
7272
*
7373
* @example
74-
* var array = require( '@stdlib/ndarray/array' );
74+
* var zeros = require( '@stdlib/ndarray/zeros' );
7575
*
76-
* var x = array( [ 0.0, 0.0, 0.0 ] );
77-
* // returns <ndarray>[ 0.0, 0.0, 0.0 ]
76+
* var x = zeros( [ 2, 3 ] );
77+
* // returns <ndarray>[ [ 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0 ] ]
7878
*
7979
* var y = zeroTo( x );
80-
* // returns <ndarray>[ 0.0, 1.0, 2.0 ]
80+
* // returns <ndarray>[ [ 0.0, 1.0, 2.0 ], [ 3.0, 4.0, 5.0 ] ]
8181
*/
8282
var zeroTo = factory( table, [], DTYPES.odtypes, options );
8383

lib/node_modules/@stdlib/blas/ext/zero-to/lib/index.js

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,31 +24,23 @@
2424
* @module @stdlib/blas/ext/zero-to
2525
*
2626
* @example
27-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
2827
* var zeroTo = require( '@stdlib/blas/ext/zero-to' );
2928
*
3029
* var out = zeroTo( [ 2, 3 ] );
31-
* // returns <ndarray>
32-
*
33-
* var arr = ndarray2array( out );
34-
* // returns [ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
30+
* // returns <ndarray>[ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
3531
*
3632
* @example
3733
* var zeros = require( '@stdlib/ndarray/zeros' );
38-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
3934
* var zeroTo = require( '@stdlib/blas/ext/zero-to' );
4035
*
4136
* var x = zeros( [ 2, 3 ] );
42-
* // returns <ndarray>
37+
* // returns <ndarray>[ [ 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0 ] ]
4338
*
4439
* var out = zeroTo.assign( x );
45-
* // returns <ndarray>
40+
* // returns <ndarray>[ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
4641
*
4742
* var bool = ( out === x );
4843
* // returns true
49-
*
50-
* var arr = ndarray2array( out );
51-
* // returns [ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
5244
*/
5345

5446
// MODULES //

lib/node_modules/@stdlib/blas/ext/zero-to/lib/main.js

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -58,22 +58,8 @@ var base = require( './base.js' );
5858
* @returns {ndarray} output ndarray
5959
*
6060
* @example
61-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
62-
*
63-
* var out = zeroTo( [ 3 ] );
64-
* // returns <ndarray>
65-
*
66-
* var arr = ndarray2array( out );
67-
* // returns [ 0.0, 1.0, 2.0 ]
68-
*
69-
* @example
70-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
71-
*
7261
* var out = zeroTo( [ 2, 3 ] );
73-
* // returns <ndarray>
74-
*
75-
* var arr = ndarray2array( out );
76-
* // returns [ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
62+
* // returns <ndarray>[ [ 0.0, 1.0, 2.0 ], [ 0.0, 1.0, 2.0 ] ]
7763
*/
7864
function zeroTo( shape ) {
7965
var options;

0 commit comments

Comments
 (0)