Skip to content

Commit f26929a

Browse files
committed
docs: show matrix A in 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: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - 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 f61525e commit f26929a

File tree

2 files changed

+29
-5
lines changed

2 files changed

+29
-5
lines changed

lib/node_modules/@stdlib/lapack/base/dgttrf/README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -179,11 +179,7 @@ dgttrf.ndarray( 3, DL, 1, 1, D, 1, 1, DU, 1, 1, DU2, 1, 1, IPIV, 1, 1 );
179179
<!-- eslint no-undef: "error" -->
180180

181181
```javascript
182-
var Int32Array = require( '@stdlib/array/int32' );
183-
var Float64Array = require( '@stdlib/array/float64' );
184-
var dgttrf = require( '@stdlib/lapack/base/dgttrf' );
185-
186-
var N = 9;
182+
=var N = 9;
187183

188184
var DL = new Float64Array( [ 3.0, 3.0, 3.0, 3.0, 3.0, 3.0, 3.0, 3.0 ] );
189185

@@ -195,6 +191,20 @@ var DU2 = new Float64Array( N-2 );
195191

196192
var IPIV = new Int32Array( N );
197193

194+
/*
195+
A = [
196+
[ 1.0, 4.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
197+
[ 3.0, 1.0, 4.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
198+
[ 0.0, 3.0, 1.0, 4.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
199+
[ 0.0, 0.0, 3.0, 1.0, 4.0, 0.0, 0.0, 0.0, 0.0 ],
200+
[ 0.0, 0.0, 0.0, 3.0, 1.0, 4.0, 0.0, 0.0, 0.0 ],
201+
[ 0.0, 0.0, 0.0, 0.0, 3.0, 1.0, 4.0, 0.0, 0.0 ],
202+
[ 0.0, 0.0, 0.0, 0.0, 0.0, 3.0, 1.0, 4.0, 0.0 ],
203+
[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 3.0, 1.0, 4.0 ],
204+
[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 3.0, 1.0 ],
205+
]
206+
*/
207+
198208
// Perform the `A = LU` factorization:
199209
var info = dgttrf( N, DL, D, DU, DU2, IPIV );
200210

lib/node_modules/@stdlib/lapack/base/dgttrf/examples/index.js

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,20 @@ var DU2 = new Float64Array( N-2 );
3434

3535
var IPIV = new Int32Array( N );
3636

37+
/*
38+
A = [
39+
[ 1.0, 4.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
40+
[ 3.0, 1.0, 4.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
41+
[ 0.0, 3.0, 1.0, 4.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
42+
[ 0.0, 0.0, 3.0, 1.0, 4.0, 0.0, 0.0, 0.0, 0.0 ],
43+
[ 0.0, 0.0, 0.0, 3.0, 1.0, 4.0, 0.0, 0.0, 0.0 ],
44+
[ 0.0, 0.0, 0.0, 0.0, 3.0, 1.0, 4.0, 0.0, 0.0 ],
45+
[ 0.0, 0.0, 0.0, 0.0, 0.0, 3.0, 1.0, 4.0, 0.0 ],
46+
[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 3.0, 1.0, 4.0 ],
47+
[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 3.0, 1.0 ],
48+
]
49+
*/
50+
3751
// Perform the `A = LU` factorization:
3852
var info = dgttrf( N, DL, D, DU, DU2, IPIV );
3953

0 commit comments

Comments
 (0)