Skip to content

Commit 620bae6

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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent 381515a commit 620bae6

File tree

1 file changed

+24
-4
lines changed
  • lib/node_modules/@stdlib/lapack/base/zlacpy/lib

1 file changed

+24
-4
lines changed

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

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,43 @@
2525
*
2626
* @example
2727
* var Complex128Array = require( '@stdlib/array/complex128' );
28+
* var real = require( '@stdlib/complex/float64/real' );
29+
* var imag = require( '@stdlib/complex/float64/imag' );
2830
* var zlacpy = require( '@stdlib/lapack/base/zlacpy' );
2931
*
3032
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
3133
* var B = new Complex128Array( 4 );
3234
*
3335
* zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
34-
* // B => <Complex128Array>
36+
*
37+
* var z = B.get( 0 );
38+
* // returns <Complex128>
39+
*
40+
* var v = real( z );
41+
* // returns 1.0
42+
*
43+
* v = imag( z );
44+
* // returns 2.0
3545
*
3646
* @example
3747
* var Complex128Array = require( '@stdlib/array/complex128' );
48+
* var real = require( '@stdlib/complex/float64/real' );
49+
* var imag = require( '@stdlib/complex/float64/imag' );
3850
* var zlacpy = require( '@stdlib/lapack/base/zlacpy' );
3951
*
40-
* var A = new Complex128Array( [ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
41-
* 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 ] );
52+
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
53+
* var B = new Complex128Array( 12 );
4254
*
4355
* zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
44-
* // B => <Complex128Array>
56+
*
57+
* var z = B.get( 2 );
58+
* // returns <Complex128>
59+
*
60+
* var v = real( z );
61+
* // returns 3.0
62+
*
63+
* v = imag( z );
64+
* // returns 4.0
4565
*/
4666

4767
// MODULES //

0 commit comments

Comments
 (0)