Skip to content

Commit 6ce1c71

Browse files
committed
docs: update examples
--- 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 384bc19 commit 6ce1c71

File tree

1 file changed

+28
-14
lines changed
  • lib/node_modules/@stdlib/ndarray/vector/ctor/lib

1 file changed

+28
-14
lines changed

lib/node_modules/@stdlib/ndarray/vector/ctor/lib/index.js

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,93 +24,107 @@
2424
* @module @stdlib/ndarray/vector/ctor
2525
*
2626
* @example
27+
* var getDType = require( '@stdlib/ndarray/dtype' );
28+
* var numel = require( '@stdlib/ndarray/numel' );
2729
* var vector = require( '@stdlib/ndarray/vector/ctor' );
2830
*
2931
* var v = vector();
3032
* // returns <ndarray>
3133
*
32-
* var len = v.length;
34+
* var len = numel( v );
3335
* // returns 0
3436
*
35-
* var dt = v.dtype;
37+
* var dt = getDType( v );
3638
* // returns 'float64'
3739
*
3840
* @example
41+
* var getDType = require( '@stdlib/ndarray/dtype' );
42+
* var numel = require( '@stdlib/ndarray/numel' );
3943
* var vector = require( '@stdlib/ndarray/vector/ctor' );
4044
*
4145
* var v = vector( 2 );
4246
* // returns <ndarray>
4347
*
44-
* var len = v.length;
48+
* var len = numel( v );
4549
* // returns 2
4650
*
47-
* var dt = v.dtype;
51+
* var dt = getDType( v );
4852
* // returns 'float64'
4953
*
5054
* @example
55+
* var getDType = require( '@stdlib/ndarray/dtype' );
56+
* var numel = require( '@stdlib/ndarray/numel' );
5157
* var vector = require( '@stdlib/ndarray/vector/ctor' );
5258
*
5359
* var v = vector( [ 1.0, 2.0 ] );
5460
* // returns <ndarray>
5561
*
56-
* var len = v.length;
62+
* var len = numel( v );
5763
* // returns 2
5864
*
59-
* var dt = v.dtype;
65+
* var dt = getDType( v );
6066
* // returns 'float64'
6167
*
6268
* @example
69+
* var getDType = require( '@stdlib/ndarray/dtype' );
70+
* var numel = require( '@stdlib/ndarray/numel' );
6371
* var vector = require( '@stdlib/ndarray/vector/ctor' );
6472
*
6573
* var v = vector( [ 1.0, 2.0 ], 'float32' );
6674
* // returns <ndarray>
6775
*
68-
* var len = v.length;
76+
* var len = numel( v );
6977
* // returns 2
7078
*
71-
* var dt = v.dtype;
79+
* var dt = getDType( v );
7280
* // returns 'float32'
7381
*
7482
* @example
7583
* var ArrayBuffer = require( '@stdlib/array/buffer' );
84+
* var getDType = require( '@stdlib/ndarray/dtype' );
85+
* var numel = require( '@stdlib/ndarray/numel' );
7686
* var vector = require( '@stdlib/ndarray/vector/ctor' );
7787
*
7888
* var buf = new ArrayBuffer( 32 );
7989
* var v = vector( buf );
8090
* // returns <ndarray>
8191
*
82-
* var len = v.length;
92+
* var len = numel( v );
8393
* // returns 4
8494
*
85-
* var dt = v.dtype;
95+
* var dt = getDType( v );
8696
* // returns 'float64'
8797
*
8898
* @example
8999
* var ArrayBuffer = require( '@stdlib/array/buffer' );
100+
* var getDType = require( '@stdlib/ndarray/dtype' );
101+
* var numel = require( '@stdlib/ndarray/numel' );
90102
* var vector = require( '@stdlib/ndarray/vector/ctor' );
91103
*
92104
* var buf = new ArrayBuffer( 32 );
93105
* var v = vector( buf, 16 );
94106
* // returns <ndarray>
95107
*
96-
* var len = v.length;
108+
* var len = numel( v );
97109
* // returns 2
98110
*
99-
* var dt = v.dtype;
111+
* var dt = getDType( v );
100112
* // returns 'float64'
101113
*
102114
* @example
103115
* var ArrayBuffer = require( '@stdlib/array/buffer' );
116+
* var getDType = require( '@stdlib/ndarray/dtype' );
117+
* var numel = require( '@stdlib/ndarray/numel' );
104118
* var vector = require( '@stdlib/ndarray/vector/ctor' );
105119
*
106120
* var buf = new ArrayBuffer( 64 );
107121
* var v = vector( buf, 16, 2 );
108122
* // returns <ndarray>
109123
*
110-
* var len = v.length;
124+
* var len = numel( v );
111125
* // returns 2
112126
*
113-
* var dt = v.dtype;
127+
* var dt = getDType( v );
114128
* // returns 'float64'
115129
*/
116130

0 commit comments

Comments
 (0)