@@ -158,6 +158,53 @@ var MAX_DIMS = UNARY.length - 1;
158
158
*
159
159
* var arr = ndarray2array( y.data, y.shape, y.strides, y.offset, y.order );
160
160
* // returns [ [ true, false, true ] ]
161
+ *
162
+ * @example
163
+ * var Float64Array = require( '@stdlib/array/float64' );
164
+ * var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
165
+ * var every = require( '@stdlib/ndarray/base/every' );
166
+ *
167
+ * // Create data buffers:
168
+ * 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 ] );
169
+ * var ybuf = [ false ];
170
+ *
171
+ * // Define the array shapes:
172
+ * var xsh = [ 1, 3, 2, 2 ];
173
+ * var ysh = [];
174
+ *
175
+ * // Define the array strides:
176
+ * var sx = [ 12, 4, 2, 1 ];
177
+ * var sy = [ 0 ];
178
+ *
179
+ * // Define the index offsets:
180
+ * var ox = 0;
181
+ * var oy = 0;
182
+ *
183
+ * // Create an input ndarray-like object:
184
+ * var x = {
185
+ * 'dtype': 'float64',
186
+ * 'data': xbuf,
187
+ * 'shape': xsh,
188
+ * 'strides': sx,
189
+ * 'offset': ox,
190
+ * 'order': 'row-major'
191
+ * };
192
+ *
193
+ * // Create an output ndarray-like object:
194
+ * var y = {
195
+ * 'dtype': 'generic',
196
+ * 'data': ybuf,
197
+ * 'shape': ysh,
198
+ * 'strides': sy,
199
+ * 'offset': oy,
200
+ * 'order': 'row-major'
201
+ * };
202
+ *
203
+ * // Perform a reduction:
204
+ * unaryReduceSubarray( every, [ x, y ], [ 0, 1, 2, 3 ] );
205
+ *
206
+ * var v = y.data;
207
+ * // returns [ true ]
161
208
*/
162
209
function unaryReduceSubarray ( fcn , arrays , dims , options ) { // eslint-disable-line max-statements
163
210
var views ;
0 commit comments