Skip to content

Commit dc2c9b6

Browse files
committed
docs: fix example
--- 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 5f6e350 commit dc2c9b6

File tree

1 file changed

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

1 file changed

+6
-5
lines changed

lib/node_modules/@stdlib/blas/ext/index-of/lib/index.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,18 @@
2525
*
2626
* @example
2727
* var Float64Array = require( '@stdlib/array/float64' );
28+
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
2829
* var ndarray = require( '@stdlib/ndarray/ctor' );
2930
* var indexOf = require( '@stdlib/blas/ext/index-of' );
3031
*
3132
* // Create a data buffer:
3233
* var xbuf = new Float64Array( [ 1.0, 2.0, -3.0, 4.0, -5.0, 6.0 ] );
3334
*
3435
* // Define the shape of the input array:
35-
* var sh = [ 3, 1, 2 ];
36+
* var sh = [ 2, 3 ];
3637
*
3738
* // Define the array strides:
38-
* var sx = [ 2, 2, 1 ];
39+
* var sx = [ 3, 1 ];
3940
*
4041
* // Define the index offset:
4142
* var ox = 0;
@@ -44,11 +45,11 @@
4445
* var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
4546
*
4647
* // Perform operation:
47-
* var out = indexOf( x, 4.0 );
48+
* var out = indexOf( x, -5.0 );
4849
* // returns <ndarray>
4950
*
50-
* var idx = out.get();
51-
* // returns 3
51+
* var arr = ndarray2array( out );
52+
* // returns [ -1, 1 ]
5253
*/
5354

5455
// MODULES //

0 commit comments

Comments
 (0)