Skip to content

Commit 381515a

Browse files
committed
docs: update examples and fix variable name
--- 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 0af8261 commit 381515a

File tree

1 file changed

+62
-14
lines changed
  • lib/node_modules/@stdlib/lapack/base/zlacpy/lib

1 file changed

+62
-14
lines changed

lib/node_modules/@stdlib/lapack/base/zlacpy/lib/ndarray.js

Lines changed: 62 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,36 +43,84 @@ var base = require( './base.js' );
4343
*
4444
* @example
4545
* var Complex128Array = require( '@stdlib/array/complex128' );
46+
* var real = require( '@stdlib/complex/float64/real' );
47+
* var imag = require( '@stdlib/complex/float64/imag' );
4648
*
47-
* var A = new Complex128Array( [ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
48-
* var B = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 11.0, 312.0, 53.0, 412.0, 24.0, 58.0, 85.0, 74.0 ] );
49+
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
50+
* var B = new Complex128Array( 12 );
4951
*
50-
* clacpy( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
51-
* // B => <Complex128Array>
52+
* zlacpy( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
53+
*
54+
* var z = B.get( 2 );
55+
* // returns <Complex128>
56+
*
57+
* var v = real( z );
58+
* // returns 3.0
59+
*
60+
* v = imag( z );
61+
* // returns 4.0
5262
*
5363
* @example
5464
* var Complex128Array = require( '@stdlib/array/complex128' );
65+
* var real = require( '@stdlib/complex/float64/real' );
66+
* var imag = require( '@stdlib/complex/float64/imag' );
67+
*
68+
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
69+
* var B = new Complex128Array( 12 );
70+
*
71+
* zlacpy( 'upper', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
72+
*
73+
* var z = B.get( 2 );
74+
* // returns <Complex128>
75+
*
76+
* var v = real( z );
77+
* // returns 3.0
78+
*
79+
* v = imag( z );
80+
* // returns 4.0
5581
*
56-
* var A = new Complex128Array( [ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
57-
* var B = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 11.0, 312.0, 53.0, 412.0, 24.0, 58.0, 85.0, 74.0 ] );
82+
* z = B.get( 4 );
83+
* // returns <Complex128>
5884
*
59-
* clacpy( 'upper', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
60-
* // B => <Complex128Array>
85+
* v = real( z );
86+
* // returns 0.0
87+
*
88+
* v = imag( z );
89+
* // returns 0.0
6190
*
6291
* @example
6392
* var Complex128Array = require( '@stdlib/array/complex128' );
93+
* var real = require( '@stdlib/complex/float64/real' );
94+
* var imag = require( '@stdlib/complex/float64/imag' );
95+
*
96+
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
97+
* var B = new Complex128Array( 12 );
98+
*
99+
* zlacpy( 'lower', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
100+
*
101+
* var z = B.get( 2 );
102+
* // returns <Complex128>
103+
*
104+
* var v = real( z );
105+
* // returns 3.0
106+
*
107+
* v = imag( z );
108+
* // returns 4.0
109+
*
110+
* z = B.get( 1 );
111+
* // returns <Complex128>
64112
*
65-
* var A = new Complex128Array( [ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
66-
* var B = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 11.0, 312.0, 53.0, 412.0, 24.0, 58.0, 85.0, 74.0 ] );
113+
* v = real( z );
114+
* // returns 0.0
67115
*
68-
* clacpy( 'lower', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
69-
* // B => <Complex128Array>
116+
* v = imag( z );
117+
* // returns 0.0
70118
*/
71-
function clacpy( uplo, M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, offsetB ) { // eslint-disable-line max-len, max-params
119+
function zlacpy( uplo, M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, offsetB ) { // eslint-disable-line max-len, max-params
72120
return base( uplo, M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, offsetB ); // eslint-disable-line max-len
73121
}
74122

75123

76124
// EXPORTS //
77125

78-
module.exports = clacpy;
126+
module.exports = zlacpy;

0 commit comments

Comments
 (0)