Skip to content

Commit 17bb1f4

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent d843552 commit 17bb1f4

File tree

11 files changed

+92
-119
lines changed

11 files changed

+92
-119
lines changed

‎CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,8 @@ A total of 17 issues were closed in this release:
421421

422422
<details>
423423

424+
- [`e0ef8c0`](https://github.com/stdlib-js/stdlib/commit/e0ef8c087391aed873416ff772da92ef34eabee8) - **docs:** update examples _(by Athan Reines)_
425+
- [`eece266`](https://github.com/stdlib-js/stdlib/commit/eece266922d61be79ec4a518122770d6e5a45c35) - **docs:** update examples _(by Athan Reines)_
424426
- [`6c79b2f`](https://github.com/stdlib-js/stdlib/commit/6c79b2f8296fbc8ac2de470e6ff7ae446102c60f) - **docs:** update note _(by Athan Reines)_
425427
- [`74fd8e4`](https://github.com/stdlib-js/stdlib/commit/74fd8e4917e02ca9186c9da4cfd676321ba7998f) - **docs:** update note _(by Athan Reines)_
426428
- [`475dc22`](https://github.com/stdlib-js/stdlib/commit/475dc227d741fcb816fc101523cc94975230e2d9) - **docs:** update note _(by Athan Reines)_

‎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:

‎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>

‎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 );

‎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:

‎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:

0 commit comments

Comments
 (0)