Skip to content

Commit fdf2934

Browse files
kgrytekgryte
committed
docs: update dtype type and use accessor functions
--- 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: passed - 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: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 7475400 commit fdf2934

55 files changed

Lines changed: 533 additions & 520 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎lib/node_modules/@stdlib/ndarray/base/map/docs/types/index.d.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ type Callback<T, U, V, ThisArg> = Nullary<V, ThisArg> | Unary<T, V, ThisArg> | B
7777
*
7878
* @example
7979
* var Float64Array = require( '@stdlib/array/float64' );
80+
* var getData = require( '@stdlib/ndarray/data-buffer' );
8081
* var ndarray = require( '@stdlib/ndarray/ctor' );
8182
*
8283
* function scale( x ) {
@@ -105,7 +106,7 @@ type Callback<T, U, V, ThisArg> = Nullary<V, ThisArg> | Unary<T, V, ThisArg> | B
105106
* // Apply function:
106107
* map( [ x, y ], scale );
107108
*
108-
* console.log( y.data );
109+
* console.log( getData( y ) );
109110
* // => <Float64Array>[ 20.0, 30.0, 60.0, 70.0, 100.0, 110.0 ]
110111
*/
111112
declare function map<T = unknown, U extends typedndarray<T> = typedndarray<T>, V = unknown, ThisArg = unknown>( arrays: [ U, typedndarray<V> ], fcn: Callback<T, U, V, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, V, ThisArg>> ): void;

‎lib/node_modules/@stdlib/ndarray/base/map/lib/0d.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@
2626
* @private
2727
* @param {Object} x - object containing ndarray meta data
2828
* @param {ndarrayLike} x.ref - reference to the original ndarray-like object
29-
* @param {string} x.dtype - data type
29+
* @param {*} x.dtype - data type
3030
* @param {Collection} x.data - data buffer
3131
* @param {NonNegativeIntegerArray} x.shape - dimensions
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)
3535
* @param {Object} y - object containing output ndarray meta data
36-
* @param {string} y.dtype - data type
36+
* @param {*} y.dtype - data type
3737
* @param {Collection} y.data - data buffer
3838
* @param {NonNegativeIntegerArray} y.shape - dimensions
3939
* @param {IntegerArray} y.strides - stride lengths

‎lib/node_modules/@stdlib/ndarray/base/map/lib/0d_accessors.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@
2626
* @private
2727
* @param {Object} x - object containing ndarray meta data
2828
* @param {ndarrayLike} x.ref - reference to the original ndarray-like object
29-
* @param {string} x.dtype - data type
29+
* @param {*} x.dtype - data type
3030
* @param {Collection} x.data - data buffer
3131
* @param {NonNegativeIntegerArray} x.shape - dimensions
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)
3535
* @param {Array<Function>} x.accessors - data buffer accessors
3636
* @param {Object} y - object containing output ndarray meta data
37-
* @param {string} y.dtype - data type
37+
* @param {*} y.dtype - data type
3838
* @param {Collection} y.data - data buffer
3939
* @param {NonNegativeIntegerArray} y.shape - dimensions
4040
* @param {IntegerArray} y.strides - stride lengths

‎lib/node_modules/@stdlib/ndarray/base/map/lib/10d.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,14 @@ var take = require( '@stdlib/array/base/take-indexed' );
3535
* @private
3636
* @param {Object} x - object containing ndarray meta data
3737
* @param {ndarrayLike} x.ref - reference to the original ndarray-like object
38-
* @param {string} x.dtype - data type
38+
* @param {*} x.dtype - data type
3939
* @param {Collection} x.data - data buffer
4040
* @param {NonNegativeIntegerArray} x.shape - dimensions
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)
4444
* @param {Object} y - object containing output ndarray meta data
45-
* @param {string} y.dtype - data type
45+
* @param {*} y.dtype - data type
4646
* @param {Collection} y.data - data buffer
4747
* @param {NonNegativeIntegerArray} y.shape - dimensions
4848
* @param {IntegerArray} y.strides - stride lengths

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ var take = require( '@stdlib/array/base/take-indexed' );
3535
* @private
3636
* @param {Object} x - object containing ndarray meta data
3737
* @param {ndarrayLike} x.ref - reference to the original ndarray-like object
38-
* @param {string} x.dtype - data type
38+
* @param {*} x.dtype - data type
3939
* @param {Collection} x.data - data buffer
4040
* @param {NonNegativeIntegerArray} x.shape - dimensions
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)
4444
* @param {Array<Function>} x.accessors - data buffer accessors
4545
* @param {Object} y - object containing output ndarray meta data
46-
* @param {string} y.dtype - data type
46+
* @param {*} y.dtype - data type
4747
* @param {Collection} y.data - data buffer
4848
* @param {NonNegativeIntegerArray} y.shape - dimensions
4949
* @param {IntegerArray} y.strides - stride lengths

‎lib/node_modules/@stdlib/ndarray/base/map/lib/10d_blocked.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ var reverse = require( '@stdlib/array/base/reverse' );
3636
* @private
3737
* @param {Object} x - object containing ndarray meta data
3838
* @param {ndarrayLike} x.ref - reference to the original ndarray-like object
39-
* @param {string} x.dtype - data type
39+
* @param {*} x.dtype - data type
4040
* @param {Collection} x.data - data buffer
4141
* @param {NonNegativeIntegerArray} x.shape - dimensions
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)
4545
* @param {Object} y - object containing output ndarray meta data
46-
* @param {string} y.dtype - data type
46+
* @param {*} y.dtype - data type
4747
* @param {Collection} y.data - data buffer
4848
* @param {NonNegativeIntegerArray} y.shape - dimensions
4949
* @param {IntegerArray} y.strides - stride lengths

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ var reverse = require( '@stdlib/array/base/reverse' );
3636
* @private
3737
* @param {Object} x - object containing ndarray meta data
3838
* @param {ndarrayLike} x.ref - reference to the original ndarray-like object
39-
* @param {string} x.dtype - data type
39+
* @param {*} x.dtype - data type
4040
* @param {Collection} x.data - data buffer
4141
* @param {NonNegativeIntegerArray} x.shape - dimensions
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)
4545
* @param {Array<Function>} x.accessors - data buffer accessors
4646
* @param {Object} y - object containing output ndarray meta data
47-
* @param {string} y.dtype - data type
47+
* @param {*} y.dtype - data type
4848
* @param {Collection} y.data - data buffer
4949
* @param {NonNegativeIntegerArray} y.shape - dimensions
5050
* @param {IntegerArray} y.strides - stride lengths

‎lib/node_modules/@stdlib/ndarray/base/map/lib/1d.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@
2626
* @private
2727
* @param {Object} x - object containing ndarray meta data
2828
* @param {ndarrayLike} x.ref - reference to the original ndarray-like object
29-
* @param {string} x.dtype - data type
29+
* @param {*} x.dtype - data type
3030
* @param {Collection} x.data - data buffer
3131
* @param {NonNegativeIntegerArray} x.shape - dimensions
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)
3535
* @param {Object} y - object containing output ndarray meta data
36-
* @param {string} y.dtype - data type
36+
* @param {*} y.dtype - data type
3737
* @param {Collection} y.data - data buffer
3838
* @param {NonNegativeIntegerArray} y.shape - dimensions
3939
* @param {IntegerArray} y.strides - stride lengths

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@
2626
* @private
2727
* @param {Object} x - object containing ndarray meta data
2828
* @param {ndarrayLike} x.ref - reference to the original ndarray-like object
29-
* @param {string} x.dtype - data type
29+
* @param {*} x.dtype - data type
3030
* @param {Collection} x.data - data buffer
3131
* @param {NonNegativeIntegerArray} x.shape - dimensions
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)
3535
* @param {Array<Function>} x.accessors - data buffer accessors
3636
* @param {Object} y - object containing output ndarray meta data
37-
* @param {string} y.dtype - data type
37+
* @param {*} y.dtype - data type
3838
* @param {Collection} y.data - data buffer
3939
* @param {NonNegativeIntegerArray} y.shape - dimensions
4040
* @param {IntegerArray} y.strides - stride lengths

‎lib/node_modules/@stdlib/ndarray/base/map/lib/2d.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ var take = require( '@stdlib/array/base/take-indexed' );
3333
* @private
3434
* @param {Object} x - object containing ndarray meta data
3535
* @param {ndarrayLike} x.ref - reference to the original ndarray-like object
36-
* @param {string} x.dtype - data type
36+
* @param {*} x.dtype - data type
3737
* @param {Collection} x.data - data buffer
3838
* @param {NonNegativeIntegerArray} x.shape - dimensions
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)
4242
* @param {Object} y - object containing output ndarray meta data
43-
* @param {string} y.dtype - data type
43+
* @param {*} y.dtype - data type
4444
* @param {Collection} y.data - data buffer
4545
* @param {NonNegativeIntegerArray} y.shape - dimensions
4646
* @param {IntegerArray} y.strides - stride lengths

0 commit comments

Comments
 (0)