Skip to content

Commit 9c8ce0b

Browse files
committed
docs: fix variable name and 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 4a39b5e commit 9c8ce0b

File tree

1 file changed

+56
-8
lines changed
  • lib/node_modules/@stdlib/lapack/base/zlacpy/lib

1 file changed

+56
-8
lines changed

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

Lines changed: 56 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,32 +45,80 @@ var base = require( './base.js' );
4545
*
4646
* @example
4747
* var Complex128Array = require( '@stdlib/array/complex128' );
48+
* var real = require( '@stdlib/complex/float64/real' );
49+
* var imag = require( '@stdlib/complex/float64/imag' );
4850
*
4951
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
5052
* var B = new Complex128Array( 4 );
5153
*
52-
* dlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
53-
* // B => <Complex128Array>
54+
* zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
55+
*
56+
* var z = B.get( 0 );
57+
* // returns <Complex128>
58+
*
59+
* var v = real( z );
60+
* // returns 1.0
61+
*
62+
* v = imag( z );
63+
* // returns 2.0
5464
*
5565
* @example
5666
* var Complex128Array = require( '@stdlib/array/complex128' );
67+
* var real = require( '@stdlib/complex/float64/real' );
68+
* var imag = require( '@stdlib/complex/float64/imag' );
5769
*
5870
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
5971
* var B = new Complex128Array( 4 );
6072
*
61-
* dlacpy( 'row-major', 'upper', 2, 2, A, 2, B, 2 );
62-
* // B => <Complex128Array>
73+
* zlacpy( 'row-major', 'upper', 2, 2, A, 2, B, 2 );
74+
*
75+
* var z = B.get( 0 );
76+
* // returns <Complex128>
77+
*
78+
* var v = real( z );
79+
* // returns 1.0
80+
*
81+
* v = imag( z );
82+
* // returns 2.0
83+
*
84+
* z = B.get( 2 );
85+
* // returns <Complex128>
86+
*
87+
* v = real( z );
88+
* // returns 0.0
89+
*
90+
* v = imag( z );
91+
* // returns 0.0
6392
*
6493
* @example
6594
* var Complex128Array = require( '@stdlib/array/complex128' );
95+
* var real = require( '@stdlib/complex/float64/real' );
96+
* var imag = require( '@stdlib/complex/float64/imag' );
6697
*
6798
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
6899
* var B = new Complex128Array( 4 );
69100
*
70-
* dlacpy( 'row-major', 'lower', 2, 2, A, 2, B, 2 );
71-
* // B => <Complex128Array>
101+
* zlacpy( 'row-major', 'lower', 2, 2, A, 2, B, 2 );
102+
*
103+
* var z = B.get( 0 );
104+
* // returns <Complex128>
105+
*
106+
* var v = real( z );
107+
* // returns 1.0
108+
*
109+
* v = imag( z );
110+
* // returns 2.0
111+
*
112+
* z = B.get( 1 );
113+
* // returns <Complex128>
114+
*
115+
* v = real( z );
116+
* // returns 0.0
117+
*
118+
* v = imag( z );
119+
* // returns 0.0
72120
*/
73-
function dlacpy( order, uplo, M, N, A, LDA, B, LDB ) {
121+
function zlacpy( order, uplo, M, N, A, LDA, B, LDB ) {
74122
var sa1;
75123
var sa2;
76124
var sb1;
@@ -101,4 +149,4 @@ function dlacpy( order, uplo, M, N, A, LDA, B, LDB ) {
101149

102150
// EXPORTS //
103151

104-
module.exports = dlacpy;
152+
module.exports = zlacpy;

0 commit comments

Comments
 (0)