Skip to content

Commit 0aa9591

Browse files
committed
refactor: docs description
--- 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: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 7f470c3 commit 0aa9591

29 files changed

+140
-140
lines changed

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d/README.md

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

2121
# nullaryStrided1d
2222

23-
> Apply a one-dimensional strided array function to a list of specified dimensions in an input ndarray.
23+
> Apply a one-dimensional strided array function to a list of specified dimensions in an ndarray.
2424
2525
<section class="intro">
2626

@@ -38,7 +38,7 @@ var nullaryStrided1d = require( '@stdlib/ndarray/base/nullary-strided1d' );
3838

3939
#### nullaryStrided1d( fcn, arrays, dims\[, options] )
4040

41-
Applies a one-dimensional strided array function to a list of specified dimensions in an input ndarray.
41+
Applies a one-dimensional strided array function to a list of specified dimensions in an ndarray.
4242

4343
<!-- eslint-disable max-len -->
4444

@@ -69,7 +69,7 @@ var sx = [ 12, 4, 2, 1 ];
6969
// Define the index offsets:
7070
var ox = 0;
7171

72-
// Create an input ndarray-like object:
72+
// Create an ndarray-like object:
7373
var x = {
7474
'dtype': 'generic',
7575
'data': xbuf,
@@ -98,8 +98,8 @@ var arr = ndarray2array( x.data, x.shape, x.strides, x.offset, x.order );
9898

9999
The function accepts the following arguments:
100100

101-
- **fcn**: function which will be applied to a one-dimensional input subarray.
102-
- **arrays**: array-like object containing one input ndarray followed by any additional ndarray arguments.
101+
- **fcn**: function which will be applied to a one-dimensional subarray.
102+
- **arrays**: array-like object containing a target ndarray followed by any additional ndarray arguments.
103103
- **dims**: list of dimensions to which to apply a strided array function.
104104
- **options**: function options which are passed through to `fcn` (_optional_).
105105

@@ -122,7 +122,7 @@ Each provided ndarray should be an object with the following properties:
122122

123123
## Notes
124124

125-
- Any additional ndarray arguments are expected to have the same dimensions as the loop dimensions of the input ndarray. When calling the strided array function, any additional ndarray arguments are provided as zero-dimensional ndarray-like objects.
125+
- Any additional ndarray arguments are expected to have the same dimensions as the loop dimensions of the target ndarray. When calling the strided array function, any additional ndarray arguments are provided as zero-dimensional ndarray-like objects.
126126

127127
- The strided array function is expected to have the following signature:
128128

@@ -132,10 +132,10 @@ Each provided ndarray should be an object with the following properties:
132132
133133
where
134134
135-
- **arrays**: array containing a one-dimensional subarray of the input ndarray and any additional ndarray arguments as zero-dimensional ndarrays.
135+
- **arrays**: array containing a one-dimensional subarray of the target ndarray and any additional ndarray arguments as zero-dimensional ndarrays.
136136
- **options**: function options (_optional_).
137137
138-
- The function iterates over ndarray elements according to the memory layout of the input ndarray.
138+
- The function iterates over ndarray elements according to the memory layout of the target ndarray.
139139
140140
- For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before performing an operation in order to achieve better performance.
141141

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d/docs/repl.txt

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

22
{{alias}}( fcn, arrays, dims[, options] )
33
Applies a one-dimensional strided array function to a list of specified
4-
dimensions in an input ndarray.
4+
dimensions in an ndarray.
55

66
Each provided "ndarray" should be an object with the following properties:
77

@@ -14,27 +14,27 @@
1414
(Fortran-style).
1515

1616
Any additional ndarray arguments are expected to have the same dimensions as
17-
the loop dimensions of the input ndarray. When calling the strided array
17+
the loop dimensions of the provided ndarray. When calling the strided array
1818
function, any additional ndarray arguments are provided as zero-dimensional
1919
ndarray-like objects.
2020

2121
Parameters
2222
----------
2323
fcn: Function
24-
Function which will be applied to a one-dimensional input subarray. The
24+
Function which will be applied to a one-dimensional subarray. The
2525
function should have the following signature:
2626

2727
fcn( arrays[, options] )
2828

2929
where
3030

31-
- arrays: array containing a one-dimensional subarray of the input
31+
- arrays: array containing a one-dimensional subarray of the provided
3232
ndarray and any additional ndarray arguments as zero-dimensional
3333
ndarrays.
3434
- options: function options.
3535

3636
arrays: ArrayLikeObject<ndarray>
37-
Array-like object containing an input ndarray followed by any additional
37+
Array-like object containing an ndarray followed by any additional
3838
ndarray arguments.
3939

4040
dims: Array<integer>

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d/lib/0d.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@
2121
// MAIN //
2222

2323
/**
24-
* Applies a one-dimensional strided array function to a list of specified dimensions in an input ndarray.
24+
* Applies a one-dimensional strided array function to a list of specified dimensions in an ndarray.
2525
*
2626
* @private
2727
* @param {Function} fcn - wrapper for a one-dimensional strided array function
2828
* @param {Array<Object>} arrays - ndarrays
29-
* @param {Object} strategyX - strategy for marshaling data to and from an input ndarray view
29+
* @param {Object} strategyX - strategy for marshaling data to and from an ndarray view
3030
* @param {Options} opts - function options
3131
* @returns {void}
3232
*
@@ -57,7 +57,7 @@
5757
* // Define the index offsets:
5858
* var ox = 0;
5959
*
60-
* // Create an input ndarray-like object:
60+
* // Create an ndarray-like object:
6161
* var x = {
6262
* 'dtype': 'generic',
6363
* 'data': xbuf,
@@ -77,7 +77,7 @@
7777
* 'order': 'row-major'
7878
* };
7979
*
80-
* // Define an input strategy:
80+
* // Define a strategy:
8181
* function strategy( x ) {
8282
* return {
8383
* 'dtype': x.dtype,

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d/lib/10d.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,16 @@ var offsets = require( './offsets.js' );
3131
// MAIN //
3232

3333
/**
34-
* Applies a one-dimensional strided array function to a list of specified dimensions in an input ndarray.
34+
* Applies a one-dimensional strided array function to a list of specified dimensions in an ndarray.
3535
*
3636
* @private
3737
* @param {Function} fcn - wrapper for a one-dimensional strided array reduction function
3838
* @param {Array<Object>} arrays - ndarrays
3939
* @param {Array<Object>} views - initialized ndarray-like objects representing sub-array views
4040
* @param {NonNegativeIntegerArray} shape - loop dimensions
41-
* @param {IntegerArray} stridesX - loop dimension strides for the input ndarray
41+
* @param {IntegerArray} stridesX - loop dimension strides for the ndarray
4242
* @param {boolean} isRowMajor - boolean indicating if provided arrays are in row-major order
43-
* @param {Object} strategyX - strategy for marshaling data to and from an input ndarray view
43+
* @param {Object} strategyX - strategy for marshaling data to and from an ndarray view
4444
* @param {Options} opts - function options
4545
* @returns {void}
4646
*
@@ -71,7 +71,7 @@ var offsets = require( './offsets.js' );
7171
* // Define the index offsets:
7272
* var ox = 0;
7373
*
74-
* // Create an input ndarray-like object:
74+
* // Create an ndarray-like object:
7575
* var x = {
7676
* 'dtype': 'generic',
7777
* 'data': xbuf,
@@ -111,7 +111,7 @@ var offsets = require( './offsets.js' );
111111
* }
112112
* ];
113113
*
114-
* // Define an input strategy:
114+
* // Define a strategy:
115115
* function strategy( x ) {
116116
* return {
117117
* 'dtype': x.dtype,

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d/lib/10d_blocked.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ var offsets = require( './offsets.js' );
3535
// MAIN //
3636

3737
/**
38-
* Applies a one-dimensional strided array function to a list of specified dimensions in an input ndarray via loop blocking.
38+
* Applies a one-dimensional strided array function to a list of specified dimensions in an ndarray via loop blocking.
3939
*
4040
* @private
4141
* @param {Function} fcn - wrapper for a one-dimensional strided array reduction function
4242
* @param {Array<Object>} arrays - ndarrays
4343
* @param {Array<Object>} views - initialized ndarray-like objects representing sub-array views
4444
* @param {NonNegativeIntegerArray} shape - loop dimensions
45-
* @param {IntegerArray} stridesX - loop dimension strides for the input ndarray
46-
* @param {Object} strategyX - strategy for marshaling data to and from an input ndarray view
45+
* @param {IntegerArray} stridesX - loop dimension strides for the ndarray
46+
* @param {Object} strategyX - strategy for marshaling data to and from an ndarray view
4747
* @param {Options} opts - function options
4848
* @returns {void}
4949
*
@@ -74,7 +74,7 @@ var offsets = require( './offsets.js' );
7474
* // Define the index offsets:
7575
* var ox = 0;
7676
*
77-
* // Create an input ndarray-like object:
77+
* // Create an ndarray-like object:
7878
* var x = {
7979
* 'dtype': 'generic',
8080
* 'data': xbuf,
@@ -114,7 +114,7 @@ var offsets = require( './offsets.js' );
114114
* }
115115
* ];
116116
*
117-
* // Define an input strategy:
117+
* // Define a strategy:
118118
* function strategy( x ) {
119119
* return {
120120
* 'dtype': x.dtype,

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d/lib/1d.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ var offsets = require( './offsets.js' );
2929
// MAIN //
3030

3131
/**
32-
* Applies a one-dimensional strided array function to a list of specified dimensions in an input ndarray.
32+
* Applies a one-dimensional strided array function to a list of specified dimensions in an ndarray.
3333
*
3434
* @private
3535
* @param {Function} fcn - wrapper for a one-dimensional strided array function
3636
* @param {Array<Object>} arrays - ndarrays
3737
* @param {Array<Object>} views - initialized ndarray-like objects representing sub-array views
3838
* @param {NonNegativeIntegerArray} shape - loop dimensions
39-
* @param {IntegerArray} stridesX - loop dimension strides for the input ndarray
40-
* @param {Object} strategyX - strategy for marshaling data to and from an input ndarray view
39+
* @param {IntegerArray} stridesX - loop dimension strides for the ndarray
40+
* @param {Object} strategyX - strategy for marshaling data to and from an ndarray view
4141
* @param {Options} opts - function options
4242
* @returns {void}
4343
*
@@ -68,7 +68,7 @@ var offsets = require( './offsets.js' );
6868
* // Define the index offsets:
6969
* var ox = 0;
7070
*
71-
* // Create an input ndarray-like object:
71+
* // Create an ndarray-like object:
7272
* var x = {
7373
* 'dtype': 'generic',
7474
* 'data': xbuf,
@@ -108,7 +108,7 @@ var offsets = require( './offsets.js' );
108108
* }
109109
* ];
110110
*
111-
* // Define an input strategy:
111+
* // Define a strategy:
112112
* function strategy( x ) {
113113
* return {
114114
* 'dtype': x.dtype,

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d/lib/2d.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@ var offsets = require( './offsets.js' );
2929
// MAIN //
3030

3131
/**
32-
* Applies a one-dimensional strided array function to a list of specified dimensions in an input ndarray.
32+
* Applies a one-dimensional strided array function to a list of specified dimensions in an ndarray.
3333
*
3434
* @private
3535
* @param {Function} fcn - wrapper for a one-dimensional strided array function
3636
* @param {Array<Object>} arrays - ndarrays
3737
* @param {Array<Object>} views - initialized ndarray-like objects representing sub-array views
3838
* @param {NonNegativeIntegerArray} shape - loop dimensions
39-
* @param {IntegerArray} stridesX - loop dimension strides for the input ndarray
39+
* @param {IntegerArray} stridesX - loop dimension strides for the ndarray
4040
* @param {boolean} isRowMajor - boolean indicating if provided arrays are in row-major order
41-
* @param {Object} strategyX - strategy for marshaling data to and from an input ndarray view
41+
* @param {Object} strategyX - strategy for marshaling data to and from an ndarray view
4242
* @param {Options} opts - function options
4343
* @returns {void}
4444
*
@@ -69,7 +69,7 @@ var offsets = require( './offsets.js' );
6969
* // Define the index offsets:
7070
* var ox = 0;
7171
*
72-
* // Create an input ndarray-like object:
72+
* // Create an ndarray-like object:
7373
* var x = {
7474
* 'dtype': 'generic',
7575
* 'data': xbuf,
@@ -109,7 +109,7 @@ var offsets = require( './offsets.js' );
109109
* }
110110
* ];
111111
*
112-
* // Define an input strategy:
112+
* // Define a strategy:
113113
* function strategy( x ) {
114114
* return {
115115
* 'dtype': x.dtype,

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d/lib/2d_blocked.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ var offsets = require( './offsets.js' );
3333
// MAIN //
3434

3535
/**
36-
* Applies a one-dimensional strided array function to a list of specified dimensions in an input ndarray via loop-blocking.
36+
* Applies a one-dimensional strided array function to a list of specified dimensions in an ndarray via loop-blocking.
3737
*
3838
* @private
3939
* @param {Function} fcn - wrapper for a one-dimensional strided array function
4040
* @param {Array<Object>} arrays - ndarrays
4141
* @param {Array<Object>} views - initialized ndarray-like objects representing sub-array views
4242
* @param {NonNegativeIntegerArray} shape - loop dimensions
43-
* @param {IntegerArray} stridesX - loop dimension strides for the input ndarray
44-
* @param {Object} strategyX - strategy for marshaling data to and from an input ndarray view
43+
* @param {IntegerArray} stridesX - loop dimension strides for the ndarray
44+
* @param {Object} strategyX - strategy for marshaling data to and from an ndarray view
4545
* @param {Options} opts - function options
4646
* @returns {void}
4747
*
@@ -72,7 +72,7 @@ var offsets = require( './offsets.js' );
7272
* // Define the index offsets:
7373
* var ox = 0;
7474
*
75-
* // Create an input ndarray-like object:
75+
* // Create an ndarray-like object:
7676
* var x = {
7777
* 'dtype': 'generic',
7878
* 'data': xbuf,
@@ -112,7 +112,7 @@ var offsets = require( './offsets.js' );
112112
* }
113113
* ];
114114
*
115-
* // Define an input strategy:
115+
* // Define a strategy:
116116
* function strategy( x ) {
117117
* return {
118118
* 'dtype': x.dtype,

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d/lib/3d.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@ var offsets = require( './offsets.js' );
2929
// MAIN //
3030

3131
/**
32-
* Applies a one-dimensional strided array function to a list of specified dimensions in an input ndarray.
32+
* Applies a one-dimensional strided array function to a list of specified dimensions in an ndarray.
3333
*
3434
* @private
3535
* @param {Function} fcn - wrapper for a one-dimensional strided array reduction function
3636
* @param {Array<Object>} arrays - ndarrays
3737
* @param {Array<Object>} views - initialized ndarray-like objects representing sub-array views
3838
* @param {NonNegativeIntegerArray} shape - loop dimensions
39-
* @param {IntegerArray} stridesX - loop dimension strides for the input ndarray
39+
* @param {IntegerArray} stridesX - loop dimension strides for the ndarray
4040
* @param {boolean} isRowMajor - boolean indicating if provided arrays are in row-major order
41-
* @param {Object} strategyX - strategy for marshaling data to and from an input ndarray view
41+
* @param {Object} strategyX - strategy for marshaling data to and from an ndarray view
4242
* @param {Options} opts - function options
4343
* @returns {void}
4444
*
@@ -69,7 +69,7 @@ var offsets = require( './offsets.js' );
6969
* // Define the index offsets:
7070
* var ox = 0;
7171
*
72-
* // Create an input ndarray-like object:
72+
* // Create an ndarray-like object:
7373
* var x = {
7474
* 'dtype': 'generic',
7575
* 'data': xbuf,
@@ -109,7 +109,7 @@ var offsets = require( './offsets.js' );
109109
* }
110110
* ];
111111
*
112-
* // Define an input strategy:
112+
* // Define a strategy:
113113
* function strategy( x ) {
114114
* return {
115115
* 'dtype': x.dtype,

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d/lib/3d_blocked.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ var offsets = require( './offsets.js' );
3535
// MAIN //
3636

3737
/**
38-
* Applies a one-dimensional strided array function to a list of specified dimensions in an input ndarray via loop blocking.
38+
* Applies a one-dimensional strided array function to a list of specified dimensions in an ndarray via loop blocking.
3939
*
4040
* @private
4141
* @param {Function} fcn - wrapper for a one-dimensional strided array reduction function
4242
* @param {Array<Object>} arrays - ndarrays
4343
* @param {Array<Object>} views - initialized ndarray-like objects representing sub-array views
4444
* @param {NonNegativeIntegerArray} shape - loop dimensions
45-
* @param {IntegerArray} stridesX - loop dimension strides for the input ndarray
46-
* @param {Object} strategyX - strategy for marshaling data to and from an input ndarray view
45+
* @param {IntegerArray} stridesX - loop dimension strides for the ndarray
46+
* @param {Object} strategyX - strategy for marshaling data to and from an ndarray view
4747
* @param {Options} opts - function options
4848
* @returns {void}
4949
*
@@ -74,7 +74,7 @@ var offsets = require( './offsets.js' );
7474
* // Define the index offsets:
7575
* var ox = 0;
7676
*
77-
* // Create an input ndarray-like object:
77+
* // Create an ndarray-like object:
7878
* var x = {
7979
* 'dtype': 'generic',
8080
* 'data': xbuf,
@@ -114,7 +114,7 @@ var offsets = require( './offsets.js' );
114114
* }
115115
* ];
116116
*
117-
* // Define an input strategy:
117+
* // Define a strategy:
118118
* function strategy( x ) {
119119
* return {
120120
* 'dtype': x.dtype,

0 commit comments

Comments
 (0)