Skip to content

Commit 9a5bb14

Browse files
committed
chore: clean-up
--- 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: passed - task: lint_repl_help status: skipped - 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: passed - 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 a4fe7bf commit 9a5bb14

File tree

11 files changed

+140
-140
lines changed

11 files changed

+140
-140
lines changed

lib/node_modules/@stdlib/ndarray/base/binary-reduce-strided1d-dispatch-factory/README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# binaryStrided1dDispatchFactory
2222

23-
> Create a function for performing binary reduction on two input ndarrays.
23+
> Create a function for performing reduction on two input ndarrays.
2424
2525
<section class="usage">
2626

@@ -34,7 +34,7 @@ var binaryStrided1dDispatchFactory = require( '@stdlib/ndarray/base/binary-reduc
3434

3535
#### binaryStrided1dDispatchFactory( table, idtypes, odtypes, policies )
3636

37-
Returns a function for performing binary reduction on two input ndarrays.
37+
Returns a function for performing reduction on two input ndarrays.
3838

3939
<!-- eslint-disable id-length -->
4040

@@ -47,23 +47,23 @@ var table = {
4747

4848
var dtypes = [ 'float64', 'float32', 'generic' ];
4949
var policies = {
50-
'output': 'same',
51-
'casting': 'none'
50+
'output': 'promoted',
51+
'casting': 'promoted'
5252
};
5353

5454
var binary = binaryStrided1dDispatchFactory( table, [ dtypes, dtypes ], dtypes, policies );
5555
```
5656

5757
The function has the following parameters:
5858

59-
- **table**: strided binary reduction function dispatch table. Must have the following properties:
59+
- **table**: strided reduction function dispatch table. Must have the following properties:
6060

61-
- **default**: default strided binary reduction function which should be invoked when provided ndarrays have data types which do not have a corresponding specialized implementation.
61+
- **default**: default strided reduction function which should be invoked when provided ndarrays have data types which do not have a corresponding specialized implementation.
6262

6363
A dispatch table may have the following additional properties:
6464

65-
- **types**: one-dimensional list of ndarray data types describing specialized input ndarray argument signatures. Only the input ndarray argument data types should be specified. Output ndarray and additional input ndarray argument data types should be omitted and are not considered during dispatch. The length of `types` must equal twice the number of strided functions specified by `fcns` (i.e., for every pair of input ndarray data types, there must be a corresponding strided binary reduction function in `fcns`).
66-
- **fcns**: list of strided binary reduction functions which are specific to specialized input ndarray argument signatures.
65+
- **types**: one-dimensional list of ndarray data types describing specialized input ndarray argument signatures. Only the input ndarray argument data types should be specified. Output ndarray and additional input ndarray argument data types should be omitted and are not considered during dispatch. The length of `types` must be twice the number of strided functions specified by `fcns` (i.e., for every pair of input ndarray data types, there must be a corresponding strided reduction function in `fcns`).
66+
- **fcns**: list of strided reduction functions which are specific to specialized input ndarray argument signatures.
6767

6868
- **idtypes**: list containing lists of supported input data types for each input ndarray argument.
6969

@@ -76,7 +76,7 @@ The function has the following parameters:
7676

7777
#### binary( x, y\[, ...args]\[, options] )
7878

79-
Performs a binary reduction on two provided input ndarrays.
79+
Performs a reduction on two input ndarrays.
8080

8181
<!-- eslint-disable id-length -->
8282

@@ -90,8 +90,8 @@ var table = {
9090

9191
var dtypes = [ 'float64', 'float32', 'generic' ];
9292
var policies = {
93-
'output': 'same',
94-
'casting': 'none'
93+
'output': 'promoted',
94+
'casting': 'promoted'
9595
};
9696

9797
var binary = binaryStrided1dDispatchFactory( table, [ dtypes, dtypes ], dtypes, policies );
@@ -118,8 +118,8 @@ The function has the following parameters:
118118

119119
The function accepts the following options:
120120

121-
- **dims**: list of dimensions over which to perform a binary reduction.
122-
- **dtype**: output ndarray data type. Setting this option, overrides the output data type policy.
121+
- **dims**: list of dimensions over which to perform a reduction.
122+
- **dtype**: output ndarray data type. Setting this option overrides the output data type policy.
123123
- **keepdims**: boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions. Default: `false`.
124124

125125
By default, the function returns an ndarray having a data type determined by the output data type policy. To override the default behavior, set the `dtype` option.
@@ -137,8 +137,8 @@ var table = {
137137

138138
var dtypes = [ 'float64', 'float32', 'generic' ];
139139
var policies = {
140-
'output': 'same',
141-
'casting': 'none'
140+
'output': 'promoted',
141+
'casting': 'promoted'
142142
};
143143

144144
var binary = binaryStrided1dDispatchFactory( table, [ dtypes, dtypes ], dtypes, policies );
@@ -160,7 +160,7 @@ var dt = getDType( z );
160160

161161
#### binary.assign( x, y\[, ...args], out\[, options] )
162162

163-
Performs a binary reduction on two provided input ndarrays and assigns results to a provided output ndarray.
163+
Performs a reduction on two input ndarrays and assigns results to a provided output ndarray.
164164

165165
<!-- eslint-disable id-length -->
166166

@@ -172,8 +172,8 @@ var ndarray = require( '@stdlib/ndarray/base/ctor' );
172172
var idt = dtypes( 'real_and_generic' );
173173
var odt = idt;
174174
var policies = {
175-
'output': 'same',
176-
'casting': 'none'
175+
'output': 'promoted',
176+
'casting': 'promoted'
177177
};
178178

179179
var table = {
@@ -210,7 +210,7 @@ The method has the following parameters:
210210

211211
The method accepts the following options:
212212

213-
- **dims**: list of dimensions over which to perform a binary reduction.
213+
- **dims**: list of dimensions over which to perform a reduction.
214214

215215
</section>
216216

@@ -220,7 +220,7 @@ The method accepts the following options:
220220

221221
## Notes
222222

223-
- A strided binary reduction function should have the following signature:
223+
- A strided reduction function should have the following signature:
224224

225225
```text
226226
f( arrays )
@@ -261,15 +261,15 @@ var odt = dtypes( 'real_and_generic' );
261261
262262
// Define dispatch policies:
263263
var policies = {
264-
'output': 'same',
265-
'casting': 'none'
264+
'output': 'promoted',
265+
'casting': 'promoted'
266266
};
267267
268268
// Define a dispatch table:
269269
var table = {
270270
'types': [
271-
'float64', 'float64', // first and second input
272-
'float32', 'float32' // first and second input
271+
'float64', 'float64', // input data types
272+
'float32', 'float32' // input data types
273273
],
274274
'fcns': [
275275
ddot,
@@ -278,7 +278,7 @@ var table = {
278278
'default': base
279279
};
280280
281-
// Create an interface for performing a binary reduction:
281+
// Create an interface for performing a reduction:
282282
var dot = binaryStrided1dDispatchFactory( table, [ idt, idt ], odt, policies );
283283
284284
// Generate arrays of random numbers:
@@ -293,7 +293,7 @@ var ybuf = uniform( 100, -1.0, 1.0, {
293293
var x = new ndarray( 'generic', xbuf, [ 10, 10 ], [ 10, 1 ], 0, 'row-major' );
294294
var y = new ndarray( 'generic', ybuf, [ 10, 10 ], [ 10, 1 ], 0, 'row-major' );
295295
296-
// Perform a binary reduction:
296+
// Perform a reduction:
297297
var z = dot( x, y, {
298298
'dims': [ 0 ]
299299
});

lib/node_modules/@stdlib/ndarray/base/binary-reduce-strided1d-dispatch-factory/benchmark/benchmark.assign.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ function createBenchmark( len ) {
5555
};
5656
dt = dtypes( 'real_floating_point' );
5757
policies = {
58-
'output': 'same',
59-
'casting': 'none'
58+
'output': 'promoted',
59+
'casting': 'promoted'
6060
};
6161
binary = factory( table, [ dt, dt ], dt, policies );
6262

lib/node_modules/@stdlib/ndarray/base/binary-reduce-strided1d-dispatch-factory/benchmark/benchmark.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ bench( pkg+'::factory', function benchmark( b ) {
4343
'float32'
4444
];
4545
policies = {
46-
'output': 'same',
47-
'casting': 'none'
46+
'output': 'promoted',
47+
'casting': 'promoted'
4848
};
4949

5050
b.tic();

lib/node_modules/@stdlib/ndarray/base/binary-reduce-strided1d-dispatch-factory/benchmark/benchmark.length.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ function createBenchmark( len ) {
5353
};
5454
dt = dtypes( 'real_floating_point' );
5555
policies = {
56-
'output': 'same',
57-
'casting': 'none'
56+
'output': 'promoted',
57+
'casting': 'promoted'
5858
};
5959
binary = factory( table, [ dt, dt ], dt, policies );
6060

lib/node_modules/@stdlib/ndarray/base/binary-reduce-strided1d-dispatch-factory/docs/repl.txt

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11

22
{{alias}}( table, idtypes, odtypes, policies )
3-
Returns function for performing binary reduction on two input ndarrays.
3+
Returns function for performing reduction on two input ndarrays.
44

55
Parameters
66
----------
77
table: Object
8-
Dispatch table containing strided binary reduction functions. The table
9-
object must have the following property:
8+
Dispatch table containing strided reduction functions. The table object
9+
must have the following property:
1010

11-
- default: default strided binary reduction function to invoke when
12-
provided ndarrays have data types which do not have a corresponding
13-
specialized implementation.
11+
- default: default strided reduction function to invoke when provided
12+
ndarrays have data types which do not have a corresponding specialized
13+
implementation.
1414

1515
The table may having the following additional properties:
1616

1717
- types: one-dimensional list of ndarray data types describing
1818
specialized input ndarray argument signatures.
19-
- fcns: list of strided binary reduction functions which are specific
20-
to specialized input ndarray argument signatures.
19+
- fcns: list of strided reduction functions which are specific to
20+
specialized input ndarray argument signatures.
2121

22-
A strided binary reduction function should have the following signature:
22+
A strided reduction function should have the following signature:
2323

2424
f( arrays )
2525

@@ -29,8 +29,8 @@
2929
additional ndarray arguments.
3030

3131
idtypes: Array<Array<string>>
32-
List containing lists of supported input array data types for each
33-
input ndarray argument.
32+
List containing lists of supported input array data types for each input
33+
ndarray argument.
3434

3535
odtypes: Array<string>
3636
List of supported output array data types.
@@ -44,18 +44,18 @@
4444
Returns
4545
-------
4646
fcn: Function
47-
Function for performing binary reduction on ndarrays.
47+
Function for performing reduction on ndarrays.
4848

4949
Examples
5050
--------
5151
> var dt = [ 'float64', 'float32', 'generic' ];
52-
> var p = { 'output': 'same', 'casting': 'none' };
52+
> var p = { 'output': 'promoted', 'casting': 'promoted' };
5353
> var t = { 'default': {{alias:@stdlib/blas/base/ndarray/gdot}} };
5454
> var f = {{alias}}( t, [ dt, dt ], dt, p );
5555

5656

5757
fcn( x, y[, ...args][, options] )
58-
Performs a binary reduction on two provided input ndarrays.
58+
Performs a reduction on two input ndarrays.
5959

6060
Parameters
6161
----------
@@ -76,9 +76,9 @@ fcn( x, y[, ...args][, options] )
7676
type policy.
7777

7878
options.dims: Array<integer> (optional)
79-
List of dimensions over which to perform a binary reduction. If not
80-
provided, the function performs a binary reduction over all elements in
81-
the two provided input ndarrays.
79+
List of dimensions over which to perform a reduction. If not provided,
80+
the function performs a reduction over all elements in the input
81+
ndarrays.
8282

8383
options.keepdims: boolean (optional)
8484
Boolean indicating whether the reduced dimensions should be included in
@@ -92,7 +92,7 @@ fcn( x, y[, ...args][, options] )
9292
Examples
9393
--------
9494
> var dts = [ 'float64', 'float32', 'generic' ];
95-
> var p = { 'output': 'same', 'casting': 'none' };
95+
> var p = { 'output': 'promoted', 'casting': 'promoted' };
9696
> var t = { 'default': {{alias:@stdlib/blas/base/ndarray/gdot}} };
9797
> var f = {{alias}}( t, [ dts, dts ], dts, p );
9898
> var xbuf = [ -1.0, 2.0, -3.0, -4.0 ];
@@ -110,8 +110,8 @@ fcn( x, y[, ...args][, options] )
110110

111111

112112
fcn.assign( x, y[, ...args], out[, options] )
113-
Performs a binary reduction on two provided input ndarrays and assigns
114-
results to a provided output ndarray.
113+
Performs a reduction on two input ndarrays and assigns results to a provided
114+
output ndarray.
115115

116116
Parameters
117117
----------
@@ -131,9 +131,9 @@ fcn.assign( x, y[, ...args], out[, options] )
131131
Function options.
132132

133133
options.dims: Array<integer> (optional)
134-
List of dimensions over which to perform a binary reduction. If not
135-
provided, the function performs a binary reduction over all elements
136-
in the two provided input ndarrays.
134+
List of dimensions over which to perform a reduction. If not provided,
135+
the function performs a reduction over all elements in the input
136+
ndarrays.
137137

138138
Returns
139139
-------
@@ -143,7 +143,7 @@ fcn.assign( x, y[, ...args], out[, options] )
143143
Examples
144144
--------
145145
> var dts = [ 'float64', 'float32', 'generic' ];
146-
> var p = { 'output': 'same', 'casting': 'none' };
146+
> var p = { 'output': 'promoted', 'casting': 'promoted' };
147147
> var t = { 'default': {{alias:@stdlib/blas/base/ndarray/gdot}} };
148148
> var f = {{alias}}( t, [ dts, dts ], dts, p );
149149
> var xbuf = [ -1.0, 2.0, -3.0, -4.0 ];

0 commit comments

Comments
 (0)