Skip to content

Commit b2357cf

Browse files
committed
feat: add C implementation for lapack/base/dlaswp
--- 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: na - 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: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 49457c5 commit b2357cf

19 files changed

Lines changed: 2263 additions & 11 deletions

File tree

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

Lines changed: 83 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Performs a series of row interchanges on an input matrix `A` using pivot indices
3838
var Int32Array = require( '@stdlib/array/int32' );
3939
var Float64Array = require( '@stdlib/array/float64' );
4040

41-
var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
41+
var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4242
var IPIV = new Int32Array( [ 2, 0, 1 ] );
4343

4444
dlaswp( 'row-major', 2, A, 2, 0, 2, IPIV, 1 );
@@ -62,7 +62,7 @@ The sign of the increment parameter `incx` determines the order in which pivots
6262
var Int32Array = require( '@stdlib/array/int32' );
6363
var Float64Array = require( '@stdlib/array/float64' );
6464

65-
var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
65+
var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
6666
var IPIV = new Int32Array( [ 2, 0, 1 ] );
6767

6868
dlaswp( 'row-major', 2, A, 2, 0, 2, IPIV, -1 );
@@ -75,7 +75,7 @@ To perform strided access over `IPIV`, provide an `abs(incx)` value greater than
7575
var Int32Array = require( '@stdlib/array/int32' );
7676
var Float64Array = require( '@stdlib/array/float64' );
7777

78-
var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
78+
var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
7979
var IPIV = new Int32Array( [ 2, 999, 0, 999, 1 ] );
8080

8181
dlaswp( 'row-major', 2, A, 2, 0, 2, IPIV, 2 );
@@ -110,7 +110,7 @@ Performs a series of row interchanges on the matrix `A` using pivot indices stor
110110
var Int32Array = require( '@stdlib/array/int32' );
111111
var Float64Array = require( '@stdlib/array/float64' );
112112

113-
var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
113+
var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
114114
var IPIV = new Int32Array( [ 2, 0, 1 ] );
115115

116116
dlaswp.ndarray( 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
@@ -219,21 +219,66 @@ console.log( ndarray2array( A, shape, strides, offset, order ) );
219219
### Usage
220220

221221
```c
222-
TODO
222+
#include "stdlib/lapack/base/dlaswp.h"
223223
```
224224

225-
#### TODO
225+
#### c\_dlaswp( layout, N, \*A, LDA, k1, k2, \*IPIV, incx )
226226

227-
TODO.
227+
Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV`.
228228

229229
```c
230-
TODO
230+
#include "stdlib/lapack/base/shared.h"
231+
232+
double A[ 3*2 ] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 };
233+
const LAPACK_INT IPIV[ 3 ] = { 2, 0, 1 };
234+
235+
c_dlaswp( LAPACK_ROW_MAJOR, 2, A, 2, 0, 2, IPIV, 1 );
236+
```
237+
238+
The function accepts the following arguments:
239+
240+
- **layout**: `[in] LAPACK_LAYOUT` storage layout.
241+
- **N**: `[in] LAPACK_INT` number of columns in `A`.
242+
- **A**: `[inout] double*` input matrix.
243+
- **LDA**: `[in] LAPACK_INT` stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
244+
- **k1**: `[in] LAPACK_INT` index of first row to interchange.
245+
- **k2**: `[in] LAPACK_INT` index of last row to interchange.
246+
- **IPIV**: `[in] LAPACK_INT*` vector of pivot indices.
247+
- **incx**: `[in] LAPACK_INT` increment between successive values of `IPIV`.
248+
249+
```c
250+
void c_dlaswp( const LAPACK_LAYOUT layout, const LAPACK_INT N, double *A, const LAPACK_INT LDA, const LAPACK_INT k1, const LAPACK_INT k2, const LAPACK_INT *IPIV, const LAPACK_INT incx );
231251
```
232252

233-
TODO
253+
#### c\_dlaswp\_ndarray( N, \*A, sa1, sa2, oa, k1, k2, inck, \*IPIV, si, oi )
254+
255+
Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV` and alternative indexing semantics.
256+
257+
```c
258+
#include "stdlib/lapack/base/shared.h"
259+
260+
double A[ 3*2 ] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 };
261+
const LAPACK_INT IPIV[ 3 ] = { 2, 0, 1 };
262+
263+
c_dlaswp_ndarray( 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
264+
```
265+
266+
The function accepts the following arguments:
267+
268+
- **N**: `[in] LAPACK_INT` number of columns in `A`.
269+
- **A**: `[inout] double*` input matrix.
270+
- **sa1**: `[in] LAPACK_INT` stride of the first dimension of `A`.
271+
- **sa2**: `[in] LAPACK_INT` stride of the second dimension of `A`.
272+
- **oa**: `[in] LAPACK_INT` starting index for `A`.
273+
- **k1**: `[in] LAPACK_INT` index of first row to interchange.
274+
- **k2**: `[in] LAPACK_INT` index of last row to interchange.
275+
- **inck**: `[in] LAPACK_INT` direction in which to apply pivots (-1 to apply pivots in reverse order; otherwise, apply in provided order).
276+
- **IPIV**: `[in] LAPACK_INT*` vector of pivot indices.
277+
- **si**: `[in] LAPACK_INT` index increment for `IPIV`.
278+
- **oi**: `[in] LAPACK_INT` starting index for `IPIV`.
234279
235280
```c
236-
TODO
281+
void c_dlaswp_ndarray( const LAPACK_INT N, double *A, const LAPACK_INT strideA1, const LAPACK_INT strideA2, const LAPACK_INT offsetA, const LAPACK_INT k1, const LAPACK_INT k2, const LAPACK_INT inck, const LAPACK_INT *IPIV, const LAPACK_INT strideIPIV, const LAPACK_INT offsetIPIV );
237282
```
238283

239284
</section>
@@ -255,7 +300,34 @@ TODO
255300
### Examples
256301

257302
```c
258-
TODO
303+
#include "stdlib/lapack/base/dlaswp.h"
304+
#include "stdlib/lapack/base/shared.h"
305+
#include <stdio.h>
306+
307+
int main( void ) {
308+
// Define a 3x3 matrix stored in row-major order:
309+
double A[ 3*3 ] = {
310+
1.0, 2.0, 3.0,
311+
4.0, 5.0, 6.0,
312+
7.0, 8.0, 9.0
313+
};
314+
315+
// Define a vector of pivot indices:
316+
const LAPACK_INT IPIV[ 3 ] = { 2, 0, 1 };
317+
318+
// Specify the number of columns:
319+
const int N = 3;
320+
321+
// Perform row interchanges:
322+
c_dlaswp( LAPACK_ROW_MAJOR, N, A, N, 0, 2, IPIV, 1 );
323+
324+
// Print the result:
325+
for ( int i = 0; i < 3; i++ ) {
326+
for ( int j = 0; j < N; j++ ) {
327+
printf( "A[ %i, %i ] = %lf\n", i, j, A[ (i*N)+j ] );
328+
}
329+
}
330+
}
259331
```
260332
261333
</section>
Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2026 The Stdlib Authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#/
18+
19+
# VARIABLES #
20+
21+
ifndef VERBOSE
22+
QUIET := @
23+
else
24+
QUIET :=
25+
endif
26+
27+
# Determine the OS ([1][1], [2][2]).
28+
#
29+
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
30+
# [2]: http://stackoverflow.com/a/27776822/2225624
31+
OS ?= $(shell uname)
32+
ifneq (, $(findstring MINGW,$(OS)))
33+
OS := WINNT
34+
else
35+
ifneq (, $(findstring MSYS,$(OS)))
36+
OS := WINNT
37+
else
38+
ifneq (, $(findstring CYGWIN,$(OS)))
39+
OS := WINNT
40+
else
41+
ifneq (, $(findstring Windows_NT,$(OS)))
42+
OS := WINNT
43+
endif
44+
endif
45+
endif
46+
endif
47+
48+
# Define the program used for compiling C source files:
49+
ifdef C_COMPILER
50+
CC := $(C_COMPILER)
51+
else
52+
CC := gcc
53+
endif
54+
55+
# Define the command-line options when compiling C files:
56+
CFLAGS ?= \
57+
-std=c99 \
58+
-O3 \
59+
-Wall \
60+
-pedantic
61+
62+
# Determine whether to generate position independent code ([1][1], [2][2]).
63+
#
64+
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
65+
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
66+
ifeq ($(OS), WINNT)
67+
fPIC ?=
68+
else
69+
fPIC ?= -fPIC
70+
endif
71+
72+
# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
73+
INCLUDE ?=
74+
75+
# List of source files:
76+
SOURCE_FILES ?=
77+
78+
# List of libraries (e.g., `-lopenblas -lpthread`):
79+
LIBRARIES ?=
80+
81+
# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
82+
LIBPATH ?=
83+
84+
# List of C targets:
85+
c_targets := benchmark.size.out
86+
87+
88+
# RULES #
89+
90+
#/
91+
# Compiles source files.
92+
#
93+
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
94+
# @param {string} [CFLAGS] - C compiler options
95+
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
96+
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
97+
# @param {string} [SOURCE_FILES] - list of source files
98+
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
99+
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
100+
#
101+
# @example
102+
# make
103+
#
104+
# @example
105+
# make all
106+
#/
107+
all: $(c_targets)
108+
109+
.PHONY: all
110+
111+
#/
112+
# Compiles C source files.
113+
#
114+
# @private
115+
# @param {string} CC - C compiler (e.g., `gcc`)
116+
# @param {string} CFLAGS - C compiler options
117+
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
118+
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
119+
# @param {string} SOURCE_FILES - list of source files
120+
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
121+
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
122+
#/
123+
$(c_targets): %.out: %.c
124+
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)
125+
126+
#/
127+
# Runs compiled benchmarks.
128+
#
129+
# @example
130+
# make run
131+
#/
132+
run: $(c_targets)
133+
$(QUIET) ./$<
134+
135+
.PHONY: run
136+
137+
#/
138+
# Removes generated files.
139+
#
140+
# @example
141+
# make clean
142+
#/
143+
clean:
144+
$(QUIET) -rm -f *.o *.out
145+
146+
.PHONY: clean

0 commit comments

Comments
 (0)