Skip to content

Commit eece266

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: na - 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 e990142 commit eece266

File tree

4 files changed

+39
-58
lines changed

4 files changed

+39
-58
lines changed

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

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,9 @@ Computes the cumulative sum along one or more [ndarray][@stdlib/ndarray/ctor] di
3636

3737
```javascript
3838
var ndarray2array = require( '@stdlib/ndarray/to-array' );
39-
var ndarray = require( '@stdlib/ndarray/ctor' );
39+
var array = require( '@stdlib/ndarray/array' );
4040

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

4443
var y = cusum( x );
4544
// returns <ndarray>
@@ -63,10 +62,9 @@ By default, the function uses the additive identity when computing the cumulativ
6362

6463
```javascript
6564
var ndarray2array = require( '@stdlib/ndarray/to-array' );
66-
var ndarray = require( '@stdlib/ndarray/ctor' );
65+
var array = require( '@stdlib/ndarray/array' );
6766

68-
var xbuf = [ -1.0, 2.0, -3.0 ];
69-
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
67+
var x = array( [ -1.0, 2.0, -3.0 ] );
7068

7169
var y = cusum( x, 10.0 );
7270
// returns <ndarray>
@@ -79,17 +77,22 @@ By default, the function performs the operation over all elements in a provided
7977

8078
```javascript
8179
var ndarray2array = require( '@stdlib/ndarray/to-array' );
82-
var ndarray = require( '@stdlib/ndarray/ctor' );
80+
var array = require( '@stdlib/ndarray/array' );
8381

84-
var xbuf = [ -1.0, 2.0, -3.0, 4.0 ];
85-
var x = new ndarray( 'generic', xbuf, [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
82+
var x = array( [ -1.0, 2.0, -3.0, 4.0 ], {
83+
'shape': [ 2, 2 ],
84+
'order': 'row-major'
85+
});
86+
87+
var v = ndarray2array( x );
88+
// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
8689

8790
var y = cusum( x, {
8891
'dims': [ 0 ]
8992
});
9093
// returns <ndarray>
9194

92-
var v = ndarray2array( y );
95+
v = ndarray2array( y );
9396
// returns [ [ -1.0, 2.0 ], [ -4.0, 6.0 ] ]
9497

9598
y = cusum( x, {
@@ -114,10 +117,11 @@ By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [da
114117
```javascript
115118
var ndarray2array = require( '@stdlib/ndarray/to-array' );
116119
var dtype = require( '@stdlib/ndarray/dtype' );
117-
var ndarray = require( '@stdlib/ndarray/ctor' );
120+
var array = require( '@stdlib/ndarray/array' );
118121

119-
var xbuf = [ -1.0, 2.0, -3.0 ];
120-
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
122+
var x = array( [ -1.0, 2.0, -3.0 ], {
123+
'dtype': 'generic'
124+
});
121125

122126
var y = cusum( x, {
123127
'dtype': 'float64'
@@ -134,13 +138,11 @@ Computes the cumulative sum along one or more [ndarray][@stdlib/ndarray/ctor] di
134138

135139
```javascript
136140
var ndarray2array = require( '@stdlib/ndarray/to-array' );
137-
var ndarray = require( '@stdlib/ndarray/ctor' );
141+
var array = require( '@stdlib/ndarray/array' );
142+
var zerosLike = require( '@stdlib/ndarray/zeros-like' );
138143

139-
var xbuf = [ -1.0, 2.0, -3.0 ];
140-
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
141-
142-
var ybuf = [ 0.0, 0.0, 0.0 ];
143-
var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
144+
var x = array( [ -1.0, 2.0, -3.0 ] );
145+
var y = zerosLike( x );
144146

145147
var out = cusum.assign( x, y );
146148
// returns <ndarray>
@@ -186,7 +188,7 @@ The method accepts the following options:
186188

187189
```javascript
188190
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
189-
var dtype = require( '@stdlib/ndarray/dtype' );
191+
var getDType = require( '@stdlib/ndarray/dtype' );
190192
var ndarray2array = require( '@stdlib/ndarray/to-array' );
191193
var ndarray = require( '@stdlib/ndarray/ctor' );
192194
var cusum = require( '@stdlib/blas/ext/cusum' );
@@ -206,7 +208,7 @@ var y = cusum( x, 100.0, {
206208
});
207209

208210
// Resolve the output array data type:
209-
var dt = dtype( y );
211+
var dt = getDType( y );
210212
console.log( dt );
211213

212214
// Print the results:

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

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,7 @@
3737

3838
Examples
3939
--------
40-
> var buf = [ -1.0, 2.0, -3.0, -4.0 ];
41-
> var dt = 'generic';
42-
> var sh = [ buf.length ];
43-
> var sx = [ 1 ];
44-
> var ox = 0;
45-
> var ord = 'row-major';
46-
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, buf, sh, sx, ox, ord );
40+
> var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
4741
> var y = {{alias}}( x );
4842
> {{alias:@stdlib/ndarray/to-array}}( y )
4943
[ -1.0, 1.0, -2.0, -6.0 ]
@@ -88,13 +82,7 @@
8882

8983
Examples
9084
--------
91-
> var buf = [ -1.0, 2.0, -3.0, -4.0 ];
92-
> var dt = 'generic';
93-
> var sh = [ buf.length ];
94-
> var sx = [ 1 ];
95-
> var ox = 0;
96-
> var ord = 'row-major';
97-
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, buf, sh, sx, ox, ord );
85+
> var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
9886
> var out = {{alias:@stdlib/ndarray/zeros-like}}( x );
9987
> var y = {{alias}}.assign( x, out )
10088
<ndarray>

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

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,9 @@ interface Unary {
7171
*
7272
* @example
7373
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
74-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
74+
* var array = require( '@stdlib/ndarray/array' );
7575
*
76-
* var xbuf = [ -1.0, 2.0, -3.0 ];
77-
* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
76+
* var x = array( [ -1.0, 2.0, -3.0 ] );
7877
*
7978
* var y = cusum( x );
8079
* // returns <ndarray>
@@ -94,10 +93,9 @@ interface Unary {
9493
*
9594
* @example
9695
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
97-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
96+
* var array = require( '@stdlib/ndarray/array' );
9897
*
99-
* var xbuf = [ -1.0, 2.0, -3.0 ];
100-
* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
98+
* var x = array( [ -1.0, 2.0, -3.0 ] );
10199
*
102100
* var y = cusum( x, 10.0 );
103101
* // returns <ndarray>
@@ -118,11 +116,9 @@ interface Unary {
118116
* @example
119117
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
120118
* var zerosLike = require( '@stdlib/ndarray/zeros-like' );
121-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
122-
*
123-
* var xbuf = [ -1.0, 2.0, -3.0 ];
124-
* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
119+
* var array = require( '@stdlib/ndarray/array' );
125120
*
121+
* var x = array( [ -1.0, 2.0, -3.0 ] );
126122
* var y = zerosLike( x );
127123
*
128124
* var out = cusum.assign( x, y );
@@ -148,11 +144,9 @@ interface Unary {
148144
* @example
149145
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
150146
* var zerosLike = require( '@stdlib/ndarray/zeros-like' );
151-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
152-
*
153-
* var xbuf = [ -1.0, 2.0, -3.0 ];
154-
* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
147+
* var array = require( '@stdlib/ndarray/array' );
155148
*
149+
* var x = array( [ -1.0, 2.0, -3.0 ] );
156150
* var y = zerosLike( x );
157151
*
158152
* var out = cusum.assign( x, 10.0, y );
@@ -176,10 +170,9 @@ interface Unary {
176170
*
177171
* @example
178172
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
179-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
173+
* var array = require( '@stdlib/ndarray/array' );
180174
*
181-
* var xbuf = [ -1.0, 2.0, -3.0 ];
182-
* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
175+
* var x = array( [ -1.0, 2.0, -3.0 ] );
183176
*
184177
* var y = cusum( x );
185178
* // returns <ndarray>
@@ -190,11 +183,9 @@ interface Unary {
190183
* @example
191184
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
192185
* var zerosLike = require( '@stdlib/ndarray/zeros-like' );
193-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
194-
*
195-
* var xbuf = [ -1.0, 2.0, -3.0 ];
196-
* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
186+
* var array = require( '@stdlib/ndarray/array' );
197187
*
188+
* var x = array( [ -1.0, 2.0, -3.0 ] );
198189
* var y = zerosLike( x );
199190
*
200191
* var out = cusum.assign( x, y );

‎lib/node_modules/@stdlib/blas/ext/cusum/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 cusum = require( './../lib' );
@@ -39,7 +39,7 @@ var y = cusum( x, 100.0, {
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:

0 commit comments

Comments
 (0)