Skip to content

Commit 5c65581

Browse files
committed
chore: use correct function name and docs
--- 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 2efac32 commit 5c65581

File tree

1 file changed

+5
-6
lines changed
  • lib/node_modules/@stdlib/blas/ext/base/ndarray/glast-index-of/lib

1 file changed

+5
-6
lines changed

lib/node_modules/@stdlib/blas/ext/base/ndarray/glast-index-of/lib/main.js

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,16 @@ var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
3131
// MAIN //
3232

3333
/**
34-
* Returns the first index of a search element in a one-dimensional ndarray.
34+
* Returns the last index of a search element in a one-dimensional ndarray.
3535
*
3636
* @param {ArrayLikeObject<Object>} arrays - array-like object containing a one-dimensional input ndarray, a zero-dimensional ndarray containing the search element, and a zero-dimensional ndarray containing the index from which to begin searching
3737
* @returns {integer} index
3838
*
3939
* @example
4040
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
4141
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
42-
* var gindexOf = require( '@stdlib/blas/ext/base/ndarray/gindex-of' );
4342
*
44-
* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
43+
* var xbuf = [ 1.0, 2.0, 4.0, 2.0 ];
4544
* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
4645
*
4746
* var searchElement = scalar2ndarray( 2.0, {
@@ -52,10 +51,10 @@ var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
5251
* 'dtype': 'generic'
5352
* });
5453
*
55-
* var v = gindexOf( [ x, searchElement, fromIndex ] );
54+
* var v = glastIndexOf( [ x, searchElement, fromIndex ] );
5655
* // returns 3
5756
*/
58-
function gindexOf( arrays ) {
57+
function glastIndexOf( arrays ) {
5958
var searchElement;
6059
var fromIndex;
6160
var stride;
@@ -91,4 +90,4 @@ function gindexOf( arrays ) {
9190

9291
// EXPORTS //
9392

94-
module.exports = gindexOf;
93+
module.exports = glastIndexOf;

0 commit comments

Comments
 (0)