Skip to content

Commit e0ef8c0

Browse files
kgrytekgryte
committed
docs: update examples
--- 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: passed - 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: na - task: lint_license_headers status: passed ---
1 parent eece266 commit e0ef8c0

File tree

6 files changed

+51
-61
lines changed

6 files changed

+51
-61
lines changed

‎lib/node_modules/@stdlib/blas/ext/sum/README.md

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,9 @@ var sum = require( '@stdlib/blas/ext/sum' );
3535
Computes the sum along one or more [ndarray][@stdlib/ndarray/ctor] dimensions.
3636

3737
```javascript
38-
var ndarray = require( '@stdlib/ndarray/ctor' );
38+
var array = require( '@stdlib/ndarray/array' );
3939

40-
var xbuf = [ -1.0, 2.0, -3.0 ];
41-
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
40+
var x = array( [ -1.0, 2.0, -3.0 ] );
4241

4342
var y = sum( x );
4443
// returns <ndarray>
@@ -62,17 +61,22 @@ By default, the function performs a reduction over all elements in a provided in
6261

6362
```javascript
6463
var ndarray2array = require( '@stdlib/ndarray/to-array' );
65-
var ndarray = require( '@stdlib/ndarray/ctor' );
64+
var array = require( '@stdlib/ndarray/array' );
65+
66+
var x = array( [ -1.0, 2.0, -3.0, 4.0 ], {
67+
'shape': [ 2, 2 ],
68+
'order': 'row-major'
69+
});
6670

67-
var xbuf = [ -1.0, 2.0, -3.0, 4.0 ];
68-
var x = new ndarray( 'generic', xbuf, [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
71+
var v = ndarray2array( x );
72+
// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
6973

7074
var y = sum( x, {
7175
'dims': [ 0 ]
7276
});
7377
// returns <ndarray>
7478

75-
var v = ndarray2array( y );
79+
v = ndarray2array( y );
7680
// returns [ -4.0, 6.0 ]
7781

7882
y = sum( x, {
@@ -96,18 +100,23 @@ By default, the function excludes reduced dimensions from the output [ndarray][@
96100

97101
```javascript
98102
var ndarray2array = require( '@stdlib/ndarray/to-array' );
99-
var ndarray = require( '@stdlib/ndarray/ctor' );
103+
var array = require( '@stdlib/ndarray/array' );
104+
105+
var x = array( [ -1.0, 2.0, -3.0, 4.0 ], {
106+
'shape': [ 2, 2 ],
107+
'order': 'row-major'
108+
});
100109

101-
var xbuf = [ -1.0, 2.0, -3.0, 4.0 ];
102-
var x = new ndarray( 'generic', xbuf, [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
110+
var v = ndarray2array( x );
111+
// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
103112

104113
var y = sum( x, {
105114
'dims': [ 0 ],
106115
'keepdims': true
107116
});
108117
// returns <ndarray>
109118

110-
var v = ndarray2array( y );
119+
v = ndarray2array( y );
111120
// returns [ [ -4.0, 6.0 ] ]
112121

113122
y = sum( x, {
@@ -132,18 +141,19 @@ v = ndarray2array( y );
132141
By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] determined by the function's output data type [policy][@stdlib/ndarray/output-dtype-policies]. To override the default behavior, set the `dtype` option.
133142

134143
```javascript
135-
var dtype = require( '@stdlib/ndarray/dtype' );
136-
var ndarray = require( '@stdlib/ndarray/ctor' );
144+
var getDType = require( '@stdlib/ndarray/dtype' );
145+
var array = require( '@stdlib/ndarray/array' );
137146

138-
var xbuf = [ -1.0, 2.0, -3.0 ];
139-
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
147+
var x = array( [ -1.0, 2.0, -3.0 ], {
148+
'dtype': 'generic'
149+
});
140150

141151
var y = sum( x, {
142152
'dtype': 'float64'
143153
});
144154
// returns <ndarray>
145155

146-
var dt = dtype( y );
156+
var dt = getDType( y );
147157
// returns 'float64'
148158
```
149159

@@ -152,13 +162,11 @@ var dt = dtype( y );
152162
Computes the sum along one or more [ndarray][@stdlib/ndarray/ctor] dimensions and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor].
153163

154164
```javascript
155-
var ndarray = require( '@stdlib/ndarray/ctor' );
156-
157-
var xbuf = [ -1.0, 2.0, -3.0 ];
158-
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
165+
var array = require( '@stdlib/ndarray/array' );
166+
var zeros = require( '@stdlib/ndarray/zeros' );
159167

160-
var ybuf = [ 0.0 ];
161-
var y = new ndarray( 'generic', ybuf, [], [ 0 ], 0, 'row-major' );
168+
var x = array( [ -1.0, 2.0, -3.0 ] );
169+
var y = zeros( [] );
162170

163171
var out = sum.assign( x, y );
164172
// returns <ndarray>
@@ -204,7 +212,7 @@ The method accepts the following options:
204212

205213
```javascript
206214
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
207-
var dtype = require( '@stdlib/ndarray/dtype' );
215+
var getDType = require( '@stdlib/ndarray/dtype' );
208216
var ndarray2array = require( '@stdlib/ndarray/to-array' );
209217
var ndarray = require( '@stdlib/ndarray/ctor' );
210218
var sum = require( '@stdlib/blas/ext/sum' );
@@ -224,7 +232,7 @@ var y = sum( x, {
224232
});
225233

226234
// Resolve the output array data type:
227-
var dt = dtype( y );
235+
var dt = getDType( y );
228236
console.log( dt );
229237

230238
// Print the results:

‎lib/node_modules/@stdlib/blas/ext/sum/docs/repl.txt

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,7 @@
2929

3030
Examples
3131
--------
32-
> var buf = [ -1.0, 2.0, -3.0, -4.0 ];
33-
> var dt = 'generic';
34-
> var sh = [ buf.length ];
35-
> var sx = [ 1 ];
36-
> var ox = 0;
37-
> var ord = 'row-major';
38-
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, buf, sh, sx, ox, ord );
32+
> var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
3933
> var y = {{alias}}( x );
4034
> var v = y.get()
4135
-6.0
@@ -68,14 +62,8 @@
6862

6963
Examples
7064
--------
71-
> var buf = [ -1.0, 2.0, -3.0, -4.0 ];
72-
> var dt = 'generic';
73-
> var sh = [ buf.length ];
74-
> var sx = [ 1 ];
75-
> var ox = 0;
76-
> var ord = 'row-major';
77-
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, buf, sh, sx, ox, ord );
78-
> var out = {{alias:@stdlib/ndarray/zeros}}( [], { 'dtype': dt } );
65+
> var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
66+
> var out = {{alias:@stdlib/ndarray/zeros}}( [] );
7967
> var y = {{alias}}.assign( x, out )
8068
<ndarray>
8169
> var bool = ( out === y )

‎lib/node_modules/@stdlib/blas/ext/sum/docs/types/index.d.ts

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,9 @@ interface Unary {
7070
* @returns output ndarray
7171
*
7272
* @example
73-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
73+
* var array = require( '@stdlib/ndarray/array' );
7474
*
75-
* var xbuf = [ -1.0, 2.0, -3.0 ];
76-
* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
75+
* var x = array( [ -1.0, 2.0, -3.0 ] );
7776
*
7877
* var y = sum( x );
7978
* // returns <ndarray>
@@ -92,13 +91,11 @@ interface Unary {
9291
* @returns output ndarray
9392
*
9493
* @example
95-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
94+
* var array = require( '@stdlib/ndarray/array' );
95+
* var zeros = require( '@stdlib/ndarray/zeros' );
9696
*
97-
* var xbuf = [ -1.0, 2.0, -3.0 ];
98-
* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
99-
*
100-
* var ybuf = [ 0.0 ];
101-
* var y = new ndarray( 'generic', ybuf, [], [ 0 ], 0, 'row-major' );
97+
* var x = array( [ -1.0, 2.0, -3.0 ] );
98+
* var y = zeros( [] );
10299
*
103100
* var out = sum.assign( x, y );
104101
* // returns <ndarray>
@@ -120,10 +117,9 @@ interface Unary {
120117
* @returns output ndarray
121118
*
122119
* @example
123-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
120+
* var array = require( '@stdlib/ndarray/array' );
124121
*
125-
* var xbuf = [ -1.0, 2.0, -3.0 ];
126-
* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
122+
* var x = array( [ -1.0, 2.0, -3.0 ] );
127123
*
128124
* var y = sum( x );
129125
* // returns <ndarray>
@@ -132,13 +128,11 @@ interface Unary {
132128
* // returns -2.0
133129
*
134130
* @example
135-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
136-
*
137-
* var xbuf = [ -1.0, 2.0, -3.0 ];
138-
* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
131+
* var array = require( '@stdlib/ndarray/array' );
132+
* var zeros = require( '@stdlib/ndarray/zeros' );
139133
*
140-
* var ybuf = [ 0.0 ];
141-
* var y = new ndarray( 'generic', ybuf, [], [ 0 ], 0, 'row-major' );
134+
* var x = array( [ -1.0, 2.0, -3.0 ] );
135+
* var y = zeros( [] );
142136
*
143137
* var out = sum.assign( x, y );
144138
* // returns <ndarray>

‎lib/node_modules/@stdlib/blas/ext/sum/examples/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
22-
var dtype = require( '@stdlib/ndarray/dtype' );
22+
var getDType = require( '@stdlib/ndarray/dtype' );
2323
var ndarray2array = require( '@stdlib/ndarray/to-array' );
2424
var ndarray = require( '@stdlib/ndarray/ctor' );
2525
var sum = require( './../lib' );
@@ -39,7 +39,7 @@ var y = sum( x, {
3939
});
4040

4141
// Resolve the output array data type:
42-
var dt = dtype( y );
42+
var dt = getDType( y );
4343
console.log( dt );
4444

4545
// Print the results:

‎lib/node_modules/@stdlib/blas/ext/sum/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* var sum = require( '@stdlib/blas/ext/sum' );
3030
*
3131
* // Create a data buffer:
32-
* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
32+
* var xbuf = new Float64Array( [ 0.0, 2.0, 3.0, 0.0, 0.0, 6.0, 7.0, 0.0, 0.0, 10.0, 11.0, 0.0 ] );
3333
*
3434
* // Define the shape of the input array:
3535
* var sh = [ 3, 1, 2 ];

‎lib/node_modules/@stdlib/blas/ext/sum/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ var table = {
7474
* var ndarray = require( '@stdlib/ndarray/ctor' );
7575
*
7676
* // Create a data buffer:
77-
* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
77+
* var xbuf = new Float64Array( [ 0.0, 2.0, 3.0, 0.0, 0.0, 6.0, 7.0, 0.0, 0.0, 10.0, 11.0, 0.0 ] );
7878
*
7979
* // Define the shape of the input array:
8080
* var sh = [ 3, 1, 2 ];

0 commit comments

Comments
 (0)