Skip to content

Commit b798293

Browse files
kgrytekgryte
committed
feat: add initial lapack/base/xerbla
--- 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: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - 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: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 9f5cf9c commit b798293

File tree

21 files changed

+1681
-0
lines changed

21 files changed

+1681
-0
lines changed

‎lib/node_modules/@stdlib/lapack/base/xerbla/README.md

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# xerbla
22+
23+
> Error handler for LAPACK routines.
24+
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26+
27+
<section class="intro">
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<!-- Package usage documentation. -->
34+
35+
<section class="usage">
36+
37+
## Usage
38+
39+
```javascript
40+
var headerDir = require( '@stdlib/lapack/base/xerbla' );
41+
```
42+
43+
#### headerDir
44+
45+
Absolute file path for the directory containing header files for C APIs.
46+
47+
```javascript
48+
var dir = headerDir;
49+
// returns <string>
50+
```
51+
52+
</section>
53+
54+
<!-- /.usage -->
55+
56+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
57+
58+
<section class="notes">
59+
60+
</section>
61+
62+
<!-- /.notes -->
63+
64+
<!-- Package usage examples. -->
65+
66+
<section class="examples">
67+
68+
## Examples
69+
70+
```javascript
71+
var headerDir = require( '@stdlib/lapack/base/xerbla' );
72+
73+
console.log( headerDir );
74+
// => <string>
75+
```
76+
77+
</section>
78+
79+
<!-- /.examples -->
80+
81+
<!-- C interface documentation. -->
82+
83+
* * *
84+
85+
<section class="c">
86+
87+
## C APIs
88+
89+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
90+
91+
<section class="intro">
92+
93+
</section>
94+
95+
<!-- /.intro -->
96+
97+
<!-- C usage documentation. -->
98+
99+
<section class="usage">
100+
101+
### Usage
102+
103+
```c
104+
#include "stdlib/lapack/base/xerbla.h"
105+
```
106+
107+
#### lapack_xerbla( \*name, info )
108+
109+
Prints an error message.
110+
111+
<!-- run-disable -->
112+
113+
```c
114+
lapack_xerbla( "dlacpy", 1 )
115+
```
116+
117+
The function accepts the following arguments:
118+
119+
- **name**: `[in] char*` name of routine.
120+
- **info**: `[in] LAPACK_INT` argument index.
121+
122+
```c
123+
void lapack_xerbla( const char *name, const LAPACK_INT info );
124+
```
125+
126+
</section>
127+
128+
<!-- /.usage -->
129+
130+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
131+
132+
<section class="notes">
133+
134+
</section>
135+
136+
<!-- /.notes -->
137+
138+
<!-- C API usage examples. -->
139+
140+
<section class="examples">
141+
142+
</section>
143+
144+
<!-- /.examples -->
145+
146+
</section>
147+
148+
<!-- /.c -->
149+
150+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
151+
152+
<section class="references">
153+
154+
</section>
155+
156+
<!-- /.references -->
157+
158+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
159+
160+
<section class="related">
161+
162+
</section>
163+
164+
<!-- /.related -->
165+
166+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
167+
168+
<section class="links">
169+
170+
</section>
171+
172+
<!-- /.links -->

0 commit comments

Comments
 (0)