Skip to content

Commit 0fb7df7

Browse files
committed
docs: document expected properties for accessor kernels
--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - 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 529687d commit 0fb7df7

20 files changed

+40
-0
lines changed

lib/node_modules/@stdlib/ndarray/base/map/lib/10d_accessors.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,15 @@ var take = require( '@stdlib/array/base/take-indexed' );
4141
* @param {IntegerArray} x.strides - stride lengths
4242
* @param {NonNegativeInteger} x.offset - index offset
4343
* @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
44+
* @param {Array<Function>} x.accessors - data buffer accessors
4445
* @param {Object} y - object containing output ndarray meta data
4546
* @param {string} y.dtype - data type
4647
* @param {Collection} y.data - data buffer
4748
* @param {NonNegativeIntegerArray} y.shape - dimensions
4849
* @param {IntegerArray} y.strides - stride lengths
4950
* @param {NonNegativeInteger} y.offset - index offset
5051
* @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
52+
* @param {Array<Function>} y.accessors - data buffer accessors
5153
* @param {boolean} isRowMajor - boolean indicating if provided arrays are in row-major order
5254
* @param {Callback} fcn - callback function
5355
* @param {*} thisArg - callback execution context

lib/node_modules/@stdlib/ndarray/base/map/lib/10d_blocked_accessors.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,15 @@ var reverse = require( '@stdlib/array/base/reverse' );
4242
* @param {IntegerArray} x.strides - stride lengths
4343
* @param {NonNegativeInteger} x.offset - index offset
4444
* @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
45+
* @param {Array<Function>} x.accessors - data buffer accessors
4546
* @param {Object} y - object containing output ndarray meta data
4647
* @param {string} y.dtype - data type
4748
* @param {Collection} y.data - data buffer
4849
* @param {NonNegativeIntegerArray} y.shape - dimensions
4950
* @param {IntegerArray} y.strides - stride lengths
5051
* @param {NonNegativeInteger} y.offset - index offset
5152
* @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
53+
* @param {Array<Function>} y.accessors - data buffer accessors
5254
* @param {Callback} fcn - callback function
5355
* @param {*} thisArg - callback execution context
5456
* @returns {void}

lib/node_modules/@stdlib/ndarray/base/map/lib/1d_accessors.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,15 @@
3232
* @param {IntegerArray} x.strides - stride lengths
3333
* @param {NonNegativeInteger} x.offset - index offset
3434
* @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
35+
* @param {Array<Function>} x.accessors - data buffer accessors
3536
* @param {Object} y - object containing output ndarray meta data
3637
* @param {string} y.dtype - data type
3738
* @param {Collection} y.data - data buffer
3839
* @param {NonNegativeIntegerArray} y.shape - dimensions
3940
* @param {IntegerArray} y.strides - stride lengths
4041
* @param {NonNegativeInteger} y.offset - index offset
4142
* @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
43+
* @param {Array<Function>} y.accessors - data buffer accessors
4244
* @param {Callback} fcn - callback function
4345
* @param {*} thisArg - callback execution context
4446
* @returns {void}

lib/node_modules/@stdlib/ndarray/base/map/lib/2d_accessors.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,15 @@ var take = require( '@stdlib/array/base/take-indexed' );
3939
* @param {IntegerArray} x.strides - stride lengths
4040
* @param {NonNegativeInteger} x.offset - index offset
4141
* @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
42+
* @param {Array<Function>} x.accessors - data buffer accessors
4243
* @param {Object} y - object containing output ndarray meta data
4344
* @param {string} y.dtype - data type
4445
* @param {Collection} y.data - data buffer
4546
* @param {NonNegativeIntegerArray} y.shape - dimensions
4647
* @param {IntegerArray} y.strides - stride lengths
4748
* @param {NonNegativeInteger} y.offset - index offset
4849
* @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
50+
* @param {Array<Function>} y.accessors - data buffer accessors
4951
* @param {boolean} isRowMajor - boolean indicating if provided arrays are in row-major order
5052
* @param {Callback} fcn - callback function
5153
* @param {*} thisArg - callback execution context

lib/node_modules/@stdlib/ndarray/base/map/lib/2d_blocked_accessors.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,15 @@ var reverse = require( '@stdlib/array/base/reverse' );
4040
* @param {IntegerArray} x.strides - stride lengths
4141
* @param {NonNegativeInteger} x.offset - index offset
4242
* @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
43+
* @param {Array<Function>} x.accessors - data buffer accessors
4344
* @param {Object} y - object containing output ndarray meta data
4445
* @param {string} y.dtype - data type
4546
* @param {Collection} y.data - data buffer
4647
* @param {NonNegativeIntegerArray} y.shape - dimensions
4748
* @param {IntegerArray} y.strides - stride lengths
4849
* @param {NonNegativeInteger} y.offset - index offset
4950
* @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
51+
* @param {Array<Function>} y.accessors - data buffer accessors
5052
* @param {Callback} fcn - callback function
5153
* @param {*} thisArg - callback execution context
5254
* @returns {void}

lib/node_modules/@stdlib/ndarray/base/map/lib/3d_accessors.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,15 @@ var take = require( '@stdlib/array/base/take-indexed' );
3939
* @param {IntegerArray} x.strides - stride lengths
4040
* @param {NonNegativeInteger} x.offset - index offset
4141
* @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
42+
* @param {Array<Function>} x.accessors - data buffer accessors
4243
* @param {Object} y - object containing output ndarray meta data
4344
* @param {string} y.dtype - data type
4445
* @param {Collection} y.data - data buffer
4546
* @param {NonNegativeIntegerArray} y.shape - dimensions
4647
* @param {IntegerArray} y.strides - stride lengths
4748
* @param {NonNegativeInteger} y.offset - index offset
4849
* @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
50+
* @param {Array<Function>} y.accessors - data buffer accessors
4951
* @param {boolean} isRowMajor - boolean indicating if provided arrays are in row-major order
5052
* @param {Callback} fcn - callback function
5153
* @param {*} thisArg - callback execution context

lib/node_modules/@stdlib/ndarray/base/map/lib/3d_blocked_accessors.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,15 @@ var reverse = require( '@stdlib/array/base/reverse' );
4242
* @param {IntegerArray} x.strides - stride lengths
4343
* @param {NonNegativeInteger} x.offset - index offset
4444
* @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
45+
* @param {Array<Function>} x.accessors - data buffer accessors
4546
* @param {Object} y - object containing output ndarray meta data
4647
* @param {string} y.dtype - data type
4748
* @param {Collection} y.data - data buffer
4849
* @param {NonNegativeIntegerArray} y.shape - dimensions
4950
* @param {IntegerArray} y.strides - stride lengths
5051
* @param {NonNegativeInteger} y.offset - index offset
5152
* @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
53+
* @param {Array<Function>} y.accessors - data buffer accessors
5254
* @param {Callback} fcn - callback function
5355
* @param {*} thisArg - callback execution context
5456
* @returns {void}

lib/node_modules/@stdlib/ndarray/base/map/lib/4d_accessors.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,15 @@ var take = require( '@stdlib/array/base/take-indexed' );
3939
* @param {IntegerArray} x.strides - stride lengths
4040
* @param {NonNegativeInteger} x.offset - index offset
4141
* @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
42+
* @param {Array<Function>} x.accessors - data buffer accessors
4243
* @param {Object} y - object containing output ndarray meta data
4344
* @param {string} y.dtype - data type
4445
* @param {Collection} y.data - data buffer
4546
* @param {NonNegativeIntegerArray} y.shape - dimensions
4647
* @param {IntegerArray} y.strides - stride lengths
4748
* @param {NonNegativeInteger} y.offset - index offset
4849
* @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
50+
* @param {Array<Function>} y.accessors - data buffer accessors
4951
* @param {boolean} isRowMajor - boolean indicating if provided arrays are in row-major order
5052
* @param {Callback} fcn - callback function
5153
* @param {*} thisArg - callback execution context

lib/node_modules/@stdlib/ndarray/base/map/lib/4d_blocked_accessors.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,15 @@ var reverse = require( '@stdlib/array/base/reverse' );
4242
* @param {IntegerArray} x.strides - stride lengths
4343
* @param {NonNegativeInteger} x.offset - index offset
4444
* @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
45+
* @param {Array<Function>} x.accessors - data buffer accessors
4546
* @param {Object} y - object containing output ndarray meta data
4647
* @param {string} y.dtype - data type
4748
* @param {Collection} y.data - data buffer
4849
* @param {NonNegativeIntegerArray} y.shape - dimensions
4950
* @param {IntegerArray} y.strides - stride lengths
5051
* @param {NonNegativeInteger} y.offset - index offset
5152
* @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
53+
* @param {Array<Function>} y.accessors - data buffer accessors
5254
* @param {Callback} fcn - callback function
5355
* @param {*} thisArg - callback execution context
5456
* @returns {void}

lib/node_modules/@stdlib/ndarray/base/map/lib/5d_accessors.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,15 @@ var take = require( '@stdlib/array/base/take-indexed' );
3939
* @param {IntegerArray} x.strides - stride lengths
4040
* @param {NonNegativeInteger} x.offset - index offset
4141
* @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
42+
* @param {Array<Function>} x.accessors - data buffer accessors
4243
* @param {Object} y - object containing output ndarray meta data
4344
* @param {string} y.dtype - data type
4445
* @param {Collection} y.data - data buffer
4546
* @param {NonNegativeIntegerArray} y.shape - dimensions
4647
* @param {IntegerArray} y.strides - stride lengths
4748
* @param {NonNegativeInteger} y.offset - index offset
4849
* @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
50+
* @param {Array<Function>} y.accessors - data buffer accessors
4951
* @param {boolean} isRowMajor - boolean indicating if provided arrays are in row-major order
5052
* @param {Callback} fcn - callback function
5153
* @param {*} thisArg - callback execution context

0 commit comments

Comments
 (0)